Skip to main content

identity_mapping_stores_identity_mappings

Creates, updates, deletes, gets or lists an identity_mapping_stores_identity_mappings resource.

Overview

Nameidentity_mapping_stores_identity_mappings
TypeResource
Idgoogle.discoveryengine.identity_mapping_stores_identity_mappings

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
externalIdentitystringRequired. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.
groupIdstringGroup 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.
userIdstringUser 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.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_identity_mapping_stores_list_identity_mappingsselectprojectsId, locationsId, identityMappingStoresIdpageSize, pageTokenLists Identity Mappings in an Identity Mapping Store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
identityMappingStoresIdstring
locationsIdstring
projectsIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Lists Identity Mappings in an Identity Mapping Store.

SELECT
externalIdentity,
groupId,
userId
FROM google.discoveryengine.identity_mapping_stores_identity_mappings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND identityMappingStoresId = '{{ identityMappingStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';