Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 9.54 KB

v2identitiescreateidentityrequestbody.md

File metadata and controls

19 lines (14 loc) · 9.54 KB

V2IdentitiesCreateIdentityRequestBody

Example Usage

import { V2IdentitiesCreateIdentityRequestBody } from "@unkey/api/models/components";

let value: V2IdentitiesCreateIdentityRequestBody = {
  externalId: "user_123",
};

Fields

Field Type Required Description Example
externalId string ✔️ The id of this identity in your system.

This usually comes from your authentication provider and could be a userId, organisationId or even an email.
It does not matter what you use, as long as it uniquely identifies something in your application.

externalIds are unique across your workspace and therefore a CONFLICT error is returned when you try to create duplicates.
 user_123
meta components.V2IdentitiesCreateIdentityRequestBodyMeta ➖ Attach metadata to this identity that you need to have access to when verifying a key.

This will be returned as part of the verifyKey response.
ratelimits components.V2Ratelimit[] ➖ Attach ratelimits to this identity.

When verifying keys, you can specify which limits you want to use and all keys attached to this identity, will share the limits.