| 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 PRECONDITION_FAILED error is returned when you try to create duplicates. |
user_123 |
Meta |
map[string]any | ➖ | 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 |
[]operations.Ratelimits | ➖ | 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. |