Skip to content

List user identities

GET
/v1/users/{id}/identities
curl --request GET \
--url https://example.com/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/identities \
--header 'X-API-Key: <X-API-Key>' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
id
required
string format: uuid
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

OK

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
user_id
string format: uuid
nullable
identity_provider_id
required
string format: uuid
provider_name
required
string
provider_type
required
string
external_id
required
string
external_username
string
nullable
external_email
string
nullable
external_display_name
string
nullable
linked_by
required
string
Allowed values: auto manual scim
last_synced_at
string format: date-time
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
"data": [
{
"linked_by": "auto"
}
]
}

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}

Forbidden

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}