identity_mapping_stores

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

Overview

Name	identity_mapping_stores
Type	Resource
Id	google.discoveryengine.identity_mapping_stores

Fields

The following fields are returned by SELECT queries:

projects_locations_identity_mapping_stores_get

Successful response

Name	Datatype	Description
name	string	Immutable. The full resource name of the identity mapping store. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
cmekConfig	object	Configurations used to enable CMEK data encryption with Cloud KMS keys. (id: GoogleCloudDiscoveryengineV1CmekConfig)
kmsKeyName	string	Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.

projects_locations_identity_mapping_stores_list

Successful response

Name	Datatype	Description
name	string	Immutable. The full resource name of the identity mapping store. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
cmekConfig	object	Configurations used to enable CMEK data encryption with Cloud KMS keys. (id: GoogleCloudDiscoveryengineV1CmekConfig)
kmsKeyName	string	Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_identity_mapping_stores_get	select	projectsId, locationsId, identityMappingStoresId		Gets the Identity Mapping Store.
projects_locations_identity_mapping_stores_list	select	projectsId, locationsId	pageSize, pageToken	Lists all Identity Mapping Stores.
projects_locations_identity_mapping_stores_create	insert	projectsId, locationsId	cmekConfigName, disableCmek, identityMappingStoreId	Creates a new Identity Mapping Store.
projects_locations_identity_mapping_stores_delete	delete	projectsId, locationsId, identityMappingStoresId		Deletes the Identity Mapping Store.
projects_locations_identity_mapping_stores_import_identity_mappings	exec	projectsId, locationsId, identityMappingStoresId		Imports a list of Identity Mapping Entries to an Identity Mapping Store.
projects_locations_identity_mapping_stores_purge_identity_mappings	exec	projectsId, locationsId, identityMappingStoresId		Purges specified or all Identity Mapping Entries from 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.

Name	Datatype	Description
identityMappingStoresId	string
locationsId	string
projectsId	string
cmekConfigName	string
disableCmek	boolean
identityMappingStoreId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_identity_mapping_stores_get

Gets the Identity Mapping Store.

SELECT
name,
cmekConfig,
kmsKeyName
FROM google.discoveryengine.identity_mapping_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND identityMappingStoresId = '{{ identityMappingStoresId }}' -- required;

projects_locations_identity_mapping_stores_list

Lists all Identity Mapping Stores.

SELECT
name,
cmekConfig,
kmsKeyName
FROM google.discoveryengine.identity_mapping_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_identity_mapping_stores_create

Creates a new Identity Mapping Store.

INSERT INTO google.discoveryengine.identity_mapping_stores (
data__name,
data__kmsKeyName,
projectsId,
locationsId,
cmekConfigName,
disableCmek,
identityMappingStoreId
)
SELECT 
'{{ name }}',
'{{ kmsKeyName }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ cmekConfigName }}',
'{{ disableCmek }}',
'{{ identityMappingStoreId }}'
RETURNING
name,
cmekConfig,
kmsKeyName
;

Manifest

# Description fields are for documentation purposes
- name: identity_mapping_stores
  props:
    - name: projectsId
      value: string
      description: Required parameter for the identity_mapping_stores resource.
    - name: locationsId
      value: string
      description: Required parameter for the identity_mapping_stores resource.
    - name: name
      value: string
      description: >
        Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
        
    - name: kmsKeyName
      value: string
      description: >
        Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.
        
    - name: cmekConfigName
      value: string
    - name: disableCmek
      value: boolean
    - name: identityMappingStoreId
      value: string

DELETE examples

projects_locations_identity_mapping_stores_delete

Deletes the Identity Mapping Store.

DELETE FROM google.discoveryengine.identity_mapping_stores
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND identityMappingStoresId = '{{ identityMappingStoresId }}' --required;

Lifecycle Methods

projects_locations_identity_mapping_stores_import_identity_mappings

Imports a list of Identity Mapping Entries to an Identity Mapping Store.

EXEC google.discoveryengine.identity_mapping_stores.projects_locations_identity_mapping_stores_import_identity_mappings 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@identityMappingStoresId='{{ identityMappingStoresId }}' --required 
@@json=
'{
"inlineSource": "{{ inlineSource }}"
}';

projects_locations_identity_mapping_stores_purge_identity_mappings

Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

EXEC google.discoveryengine.identity_mapping_stores.projects_locations_identity_mapping_stores_purge_identity_mappings 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@identityMappingStoresId='{{ identityMappingStoresId }}' --required 
@@json=
'{
"inlineSource": "{{ inlineSource }}", 
"filter": "{{ filter }}", 
"force": {{ force }}
}';