Google Cloud Discovery Engine V1 Client - Class IdentityMappingEntry (1.10.1)
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 internalidentity.
Generated from protobuf messagegoogle.cloud.discoveryengine.v1.IdentityMappingEntry
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ user_id | stringUser 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 | stringGroup 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 | stringRequired. 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 workspaceuser email.For non-google identity provider, user_id is the mapped user identifierconfigured during the workforcepool config.
| Returns | |
|---|---|
| Type | Description |
string | |
hasUserId
setUserId
User identifier.
For Google Workspace user account, user_id should be the google workspaceuser email.For non-google identity provider, user_id is the mapped user identifierconfigured 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 googleworkspace group email.For non-google identity provider, group_id is the mapped group identifierconfigured during the workforcepool config.
| Returns | |
|---|---|
| Type | Description |
string | |
hasGroupId
setGroupId
Group identifier.
For Google Workspace user account, group_id should be the googleworkspace group email.For non-google identity provider, group_id is the mapped group identifierconfigured 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 | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-24 UTC.