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 messagegoogle.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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class IdentityMappingEntry (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.IdentityMappingEntry)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.IdentityMappingEntry)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.IdentityMappingEntry)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.IdentityMappingEntry)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.IdentityMappingEntry)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.IdentityMappingEntry)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.IdentityMappingEntry)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.IdentityMappingEntry)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.IdentityMappingEntry)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.IdentityMappingEntry)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.IdentityMappingEntry)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.IdentityMappingEntry)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.IdentityMappingEntry)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.IdentityMappingEntry)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.IdentityMappingEntry)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.IdentityMappingEntry)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.IdentityMappingEntry) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class IdentityMappingEntry.\n\nIdentity Mapping Entry that maps an external identity to an internal\nidentity.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.IdentityMappingEntry`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getUserId\n\nUser identifier.\n\nFor Google Workspace user account, user_id should be the google workspace\nuser email.\nFor non-google identity provider, user_id is the mapped user identifier\nconfigured during the workforcepool config.\n\n### hasUserId\n\n### setUserId\n\nUser identifier.\n\nFor Google Workspace user account, user_id should be the google workspace\nuser email.\nFor non-google identity provider, user_id is the mapped user identifier\nconfigured during the workforcepool config.\n\n### getGroupId\n\nGroup identifier.\n\nFor Google Workspace user account, group_id should be the google\nworkspace group email.\nFor non-google identity provider, group_id is the mapped group identifier\nconfigured during the workforcepool config.\n\n### hasGroupId\n\n### setGroupId\n\nGroup identifier.\n\nFor Google Workspace user account, group_id should be the google\nworkspace group email.\nFor non-google identity provider, group_id is the mapped group identifier\nconfigured during the workforcepool config.\n\n### getExternalIdentity\n\nRequired. Identity outside the customer identity provider.\n\nThe length limit of external identity will be of 100 characters.\n\n### setExternalIdentity\n\nRequired. Identity outside the customer identity provider.\n\nThe length limit of external identity will be of 100 characters.\n\n### getIdentityProviderId"]]
