Skip to main content
POST
/
workspaces
/
{workspace}
/
api-keys
Create an API key
curl --request POST \
  --url https://api.staging-2tid4c.ezyshield.com.au/management/v1/workspaces/{workspace}/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "abilities": [
    "verification:read"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "type": "api-keys",
    "attributes": {
      "name": "<string>",
      "abilities": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "last_used_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "token": "<string>"
    },
    "relationships": {
      "creator": {
        "data": {
          "type": "users",
          "id": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "users",
      "attributes": {
        "name": "<string>",
        "email": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace
string<uuid>
required

The workspace ID

Body

application/json
name
string
required

The name of the API key.

Maximum string length: 255
abilities
enum<string>[]
required

The abilities/permissions for the API key.

Available options:
verification:read,
verification:write,
check:read,
check:write,
webhook_subscription:read,
webhook_subscription:write,
webhook_event:read

Response

ApiKeyResource

data
ApiKeyResource · object
required
included
UserResource · object[]