# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::IdentityMappingEntry (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::IdentityMappingEntry.

Identity Mapping Entry that maps an external identity to an internal
identity.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #external_identity

    def external_identity() -> ::String

**Returns**

- (::String) --- Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.

### #external_identity=

    def external_identity=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.
**Returns**

- (::String) --- Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.

### #external_identity_name

    def external_identity_name() -> ::String

**Returns**

- (::String) --- Optional. The name of the external identity.

### #external_identity_name=

    def external_identity_name=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The name of the external identity.
**Returns**

- (::String) --- Optional. The name of the external identity.

### #group_id

    def group_id() -> ::String

**Returns**

- (::String) --- Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.

  Note: The following fields are mutually exclusive: `group_id`, `user_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #group_id=

    def group_id=(value) -> ::String

**Parameter**

- **value** (::String) --- Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.


  Note: The following fields are mutually exclusive: `group_id`, `user_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- (::String) --- Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.

  Note: The following fields are mutually exclusive: `group_id`, `user_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #user_id

    def user_id() -> ::String

**Returns**

- (::String) --- User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.

  Note: The following fields are mutually exclusive: `user_id`, `group_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #user_id=

    def user_id=(value) -> ::String

**Parameter**

- **value** (::String) --- User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.


  Note: The following fields are mutually exclusive: `user_id`, `group_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- (::String) --- User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.

  Note: The following fields are mutually exclusive: `user_id`, `group_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.