UpdateApiKeyRequest
Request to update an API key. This is a full replacement of the key's name and scope:
omit the scope fields to make (or keep) the key unscoped, or supply a tenant + role to
scope it. The key value itself never changes.
Properties
| Name | Type | Description |
|---|---|---|
| name* | string | The friendly name for this API key |
The friendly name for this API key | ||
| tenantCode | string | The tenant to scope this key to (required when scoping to a role) |
The tenant to scope this key to (required when scoping to a role) | ||
| systemRoleType | enum | Admin StandardUser Viewer |
Admin StandardUser Viewer | ||
| roleCode | string | The code of the custom role to scope to. Supply either this or SystemRoleType, not both. |
The code of the custom role to scope to. Supply either this or SystemRoleType, not both. | ||
JSON Example
{
"name": "string",
"tenantCode": "string",
"systemRoleType": "Admin",
"roleCode": "string"
}