Google Cloud Discovery Engine V1 Client - Class IdentityMappingEntry (1.6.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class IdentityMappingEntry.

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

Generated from protobuf message google.cloud.discoveryengine.v1.IdentityMappingEntry

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ user_id 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.

↳ group_id 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.

↳ external_identity string

Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.

getUserId

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.

Returns
Type Description
string

hasUserId

setUserId

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getGroupId

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.

Returns
Type Description
string

hasGroupId

setGroupId

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getExternalIdentity

Required. Identity outside the customer identity provider.

The length limit of external identity will be of 100 characters.

Returns
Type Description
string

setExternalIdentity

Required. Identity outside the customer identity provider.

The length limit of external identity will be of 100 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getIdentityProviderId

Returns
Type Description
string