Generate an Instant Key
Generates a new instant key for a specified user identity.
Generates a new instant key for a specified user identity.
Code:
await seam.userIdentities.generateInstantKey({
user_identity_id: "d92e0c7b-72a1-4063-9ee8-2acefc240358",
max_use_count: 10,
});
Output:
{
"client_session_id": "bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6",
"created_at": "2025-06-14T16:54:17.946559Z",
"expires_at": "2025-06-16T16:54:17.946559Z",
"instant_key_id": "1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9",
"instant_key_url": "https://ik.seam.co/ABCXYZ",
"user_identity_id": "d92e0c7b-72a1-4063-9ee8-2acefc240358",
"workspace_id": "4d1c24b2-781e-4d1a-8d77-15249ad57c8a"
}
Request Parameters
user_identity_id
String (Required)
ID of the user identity for which you want to generate an instant key.
max_use_count
Number
Maximum number of times the instant key can be used. Default: 1.
Response
{
"client_session_id": "bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6",
"created_at": "2025-06-14T16:54:17.946559Z",
"expires_at": "2025-06-16T16:54:17.946559Z",
"instant_key_id": "1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9",
"instant_key_url": "https://ik.seam.co/ABCXYZ",
"user_identity_id": "e7a94acb-bd8a-4462-b6fb-8612d35cd7c3",
"workspace_id": "4d1c24b2-781e-4d1a-8d77-15249ad57c8a"
}
Last updated
Was this helpful?