Use the Token Object to manage various types of tokens used within your application, such as access tokens and API tokens, with details regarding their linkage, validity, and associated permissions. Tokens can be linked to Organisation (contact.org) Collection and User (identity.user) Collection if required.
| Friendly Field Name | Data Field Name | General Data Type | Description | Optimised for Filtering |
|---|---|---|---|---|
| Unique Identifier | uuid | UUID | Universally unique identifier (UUID) for the Object. | Yes |
| Application Identifier | app_uuid | UUID | Identifier for the application associated with the Object. | Yes |
| Application Context Reference | app_context_ref | Text (max length 50) | You can use this field to provide searchable context to your object – for example this may be an external identifier, or a lookup UUID to another object in your application. | Yes |
| Sub Identifier | sub_uuid | UUID | Use this field to store a UUID to a related Object. | Yes |
| Label | label | Text (max length 50) | Label for the token. | Yes |
| Linked Organisation UUID | linked_org_uuid | UUID | Identifier linking the token to a specific organisation Object in the contacts.org Collection. | Yes |
| Linked User UUID | linked_identity_user_uuid | UUID | Identifier linking the token to a specific user Object in the identity.user Collection. | Yes |
| Token | token | Text (max length 512) | The token value used for authentication or access. This value must be unique across your application. If this value isn’t supplied then a UUID value will be automatically generated for you. | Yes |
| Permissions | permissions | Text | Permissions associated with the token. | No |
| Token Data | token_data | Text | Additional data related to the token. | No |
| Expires At | expires_at | DateTime | Expiry date and time for the token. | Yes |
| Is Active | is_active | Boolean | Indicates if the token is active. | No |
| Token Taxonomy | token_taxonomy | Text (max length 50) | Categorisation for the token. | Yes |
| Created At | created_at | DateTime | Timestamp when the token record was created. | No |
| Updated At | updated_at | DateTime | Timestamp when the token record was last updated. | No |
| Created By | created_by | Text (max length 50) | Identifier for who or what created the token record. | No |
| Updated By | updated_by | Text (max length 50) | Identifier for who or what last updated the token record. | No |