External User ID
This set of API calls allows you to perform operations to Create, Modify, Delete and Retrieve External User IDs
Introduction
An external user is your way to set a custom username in Keyless, allowing you to represent Keyless users with an identifier that is more familiar to your business such as username, Unique identifier or UUID.
Create an external user. A user can only have one external user associated
The user id
User id set and managed by the client
External user created
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Resource not found
Not acceptable representation
The requested operation conflicts with the current state of the server
Media type not supported, the request can't be processed
An internal error occurred, please try again later or contact the support.
POST /v2/users/{userId}/external-user HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"externalUserId": "text"
}{
"sdkCustomerId": 1,
"userId": "0123456789ABCDEF",
"externalUserId": "text",
"createdAt": "2025-08-06T15:04:05.242194378",
"updatedAt": "2025-08-06T15:04:05.242194378"
}Modify an external user. Idempotent, can be retried
The user id
User id set and managed by the client
External user patched
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Resource not found
Not acceptable representation
Media type not supported, the request can't be processed
An internal error occurred, please try again later or contact the support.
PATCH /v2/users/{userId}/external-user HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"externalUserId": "text"
}{
"sdkCustomerId": 1,
"userId": "0123456789ABCDEF",
"externalUserId": "text",
"createdAt": "2025-08-06T15:04:05.242194378",
"updatedAt": "2025-08-06T15:04:05.242194378"
}Delete an external user. The external user id is case-sensitive
The customer-meaningful user id. Case-sensitive
External user deleted. If the external user does not exist, the response is still positive
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Resource not found
Not acceptable representation
An internal error occurred, please try again later or contact the support.
DELETE /v2/external-users/{externalUserId} HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
No content
Get all users associated to external user id. Returns an empty list if none is found. External user id is case-insensitive
The customer-meaningful user id. Case-sensitive
All users found bound to external user id. Empty if none is found
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Resource not found
Not acceptable representation
The requested operation conflicts with the current state of the server
An internal error occurred, please try again later or contact the support.
GET /v2/external-users/{externalUserId}/users HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
[
{
"userId": "0123456789ABCDEF",
"biometricPublicSigningKey": "0123456789ABCDEF",
"createdAt": "2025-08-06T15:04:05.242194378",
"updatedAt": "2025-08-06T15:04:05.242194378"
}
]Last updated
Was this helpful?