The Identity Key Object stores one or more identity keys linked to a user, including information about key types, validity, and associated data, to securely handle identity verification and access within the application. Supports the storage of access keys, auth tokens, JWTs and custom key types.
| 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 linked Object. | Yes |
| Linked User Identifier | linked_user_uuid | UUID | Identifier linking the key to a specific User Object in identity.user. | Yes |
| Realm | realm | Text (max length 50) | The realm or domain to which the key belongs. By default this is set to 'engine'. | No |
| Subject | subject | Text (max length 50) | Subject associated with the key. | No |
| Key Name | key_name | Text (max length 50) | Name of the key. | Yes |
| Key Type | key_type | Enumerated List | Type of key. Allowable values are:api, oauth, sso, custom_authOptional | No |
| Version | version | Number | Version number of the key. This field can store numbers from 0 to 65535. Default value is 1. | No |
| Access Key | access_key | Text (max length 512) | The actual access key used for authentication. | No |
| Access Secret | access_secret | Text (max length 512) | The secret associated with the access key. | No |
| User Key 1 | user_key_1 | Text (max length 512) | Custom user key 1 for additional information. | No |
| User Key 2 | user_key_2 | Text (max length 512) | Custom user key 2 for additional information. | No |
| User Key 3 | user_key_3 | Text (max length 512) | Custom user key 3 for additional information. | No |
| Key Data | key_data | JSON | Additional data associated with the key in JSON format. This must be a valid JSON object. | No |
| Is Active | is_active | Boolean | Indicates if the key is active. | No |
| Expires At | expires_at | DateTime | Expiry date and time for the key. | Yes |
| Key Taxonomy | key_taxonomy | Text (max length 50) | Categorisation for the key. | Yes |
| Created At | created_at | DateTime | Timestamp when the Object was created. | No |
| Updated At | updated_at | DateTime | Timestamp when the Object was last updated. | No |
| Created By | created_by | Text (max length 50) | Identifier for who or what created the Object. | No |
| Updated By | updated_by | Text (max length 50) | Identifier for who or what last updated the Object. | No |