Identity Provider API, gRPC: UserService.ResolveExternalIds
Resolves external IDs to internal user IDs.
gRPC request
rpc ResolveExternalIds (ResolveExternalIdsRequest) returns (ResolveExternalIdsResponse)
ResolveExternalIdsRequest
{
"userpool_id": "string",
"external_ids": [
"string"
]
}
Request to resolve external IDs to internal user IDs.
|
Field |
Description |
|
userpool_id |
string Required field. ID of the userpool to resolve external IDs in. The maximum string length in characters is 50. |
|
external_ids[] |
string List of external IDs to resolve. The maximum string length in characters for each value is 256. The number of elements must be in the range 1-1000. |
ResolveExternalIdsResponse
{
"resolved_users": [
{
"user_id": "string",
"external_id": "string",
"userpool_id": "string"
}
]
}
Response for the UserService.ResolveExternalIds operation.
|
Field |
Description |
|
resolved_users[] |
List of resolved users. |
ResolvedUser
Information about a resolved user.
|
Field |
Description |
|
user_id |
string Internal user ID. |
|
external_id |
string External identifier. |
|
userpool_id |
string ID of the userpool the user belongs to. |