Create API key

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

name*string

A name used to identify the key in the Verdocs Web App

profile_id*string

The profile ID that calls made using the key will act as

Formatuuid

global_admin?boolean

If true, the key has full access to the organization, overriding the permissions of its assigned profile. Defaults to false.

Response Body

`application/json`

curl -X POST "https://api.verdocs.com/v2/api-keys" \    -H "Authorization: Bearer ACCESS_TOKEN" \    -H "content-type: application/json" \    -d '{"param": "value"}'

{
  "client_id": "string",
  "client_secret": "string",
  "created_at": "string",
  "global_admin": true,
  "last_used_at": "string",
  "name": "string",
  "organization_id": "string",
  "profile_id": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

Create API key

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

406application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`