Method: projects.locations.identityMappingStores.listIdentityMappings
Stay organized with collections
Save and categorize content based on your preferences.
Lists Identity Mappings in an Identity Mapping Store.
HTTP request
GET https://discoveryengine.googleapis.com/v1alpha/{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 the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["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-03-03 UTC."],[[["This page details how to list Identity Mappings within an Identity Mapping Store using a GET request to a specific URL, which is structured using gRPC Transcoding syntax."],["The URL requires a path parameter, `identityMappingStore`, specifying the target Identity Mapping Store within a project and location."],["Optional query parameters `pageSize` and `pageToken` are available to manage the number of Identity Mappings returned and to paginate through results."],["The request body for listing Identity Mappings must be empty, and a successful response includes a JSON structure containing a list of `identityMappingEntries` and a `nextPageToken` for further pagination."],["Access to this function requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."]]],[]]