Skip to content
AcrivaDocs

CreateApiKey

POST
/api/v1/t/{tenant}/identity/api-keys
curl --request POST \
  --url https://example.com/api/v1/t/example/identity/api-keys \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "scopes": [ "example" ], "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "expiresAt": "2026-04-15T12:00:00Z" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
scopes
required
Array<string>
roleId
null | string format: uuid
expiresAt
null | string format: date-time
Examplegenerated
{
  "name": "example",
  "scopes": [
    "example"
  ],
  "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "expiresAt": "2026-04-15T12:00:00Z"
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Created

Media typeapplication/json
object
key
required
object
id
required
string format: uuid
name
required
string
prefix
required
string
scopes
required
Array<string>
roleId
required
string format: uuid
roleName
required
string
state
required
Allowed values: Active Expired Revoked
expiresAt
required
string format: date-time
lastUsedAt
required
null | string format: date-time
createdBy
required
string format: uuid
createdAt
required
string format: date-time
revokedAt
required
null | string format: date-time
secret
required
string
Example
{
  "key": {
    "state": "Active"
  }
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}