Method: projects.locations.identityMappingStores.listIdentityMappings

Lists Identity Mappings in an Identity Mapping Store.

HTTP request

GET https://discoveryengine.googleapis.com/v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:listIdentityMappings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
identityMappingStore

string

Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Query parameters

Parameters
pageSize

integer

Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.
pageToken

string

A page token, received from a previous identityMappingStores.listIdentityMappings call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to identityMappingStores.listIdentityMappings must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for IdentityMappingStoreService.ListIdentityMappings

If successful, the response body contains data with the following structure:

JSON representation 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ],
  "nextPageToken": string
}
Fields
identityMappingEntries[]

object (IdentityMappingEntry)

The Identity Mapping Entries.
nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the identityMappingStore resource:

  • discoveryengine.identityMappingStores.listIdentityMappings

For more information, see the IAM documentation.