CreateApiKeyRequest

Request to create a new API key. Leave the scope fields empty for a normal key that fully
impersonates you. Supply a tenant + role to create a scoped key: it only works on that
tenant, and its effective permissions are the role's, capped at whatever you yourself hold
there at the time of each request.

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"
}

Used By Operations

POST Create a new API key
/account/keys