ApiKeyDto
Represents an API key for authentication
Properties
| Name | Type | Description |
|---|---|---|
| key | string | The unique identifier for this API key (use this for authentication via x-api-key header) |
The unique identifier for this API key (use this for authentication via x-api-key header) | ||
| name | string | The friendly name for this API key |
The friendly name for this API key | ||
| isScoped | boolean | Whether this key is scoped to a tenant + role. Unscoped keys fully impersonate their |
Whether this key is scoped to a tenant + role. Unscoped keys fully impersonate their | ||
| tenant | CodeAndNameDto | |
| roleType | enum | System Custom |
System Custom | ||
| role | CodeAndNameDto | |
| createdDate | string | The date this API key was created |
The date this API key was created | ||
JSON Example
{
"key": "00000000-0000-0000-0000-000000000000",
"name": "string",
"isScoped": false,
"tenant": {
"code": "string",
"name": "string"
},
"roleType": "System"
}