Available permissions

GET 
/api/v1/partner/settings/api-keys/available-permissions

List the routes this client's API keys can be scoped to.

Request

Responses

200

Grantable route permissions

application/json

Schema

Schema

groups object[]required
Array [
group stringrequired
Possible values: non-empty
label stringrequired
Possible values: non-empty
warning (string | null)
Possible values: non-empty
permissions object[]required
Array [
id stringrequired
Possible values: non-empty
method stringrequired
Possible values: non-empty
path stringrequired
Possible values: non-empty
summary (string | null)
Possible values: non-empty
]
subgroups undefined[]
Default value: ``
]
presets object[]
Array [
id stringrequired
Possible values: non-empty
label stringrequired
Possible values: non-empty
description (string | null)
Possible values: non-empty
routes string[]
Possible values: non-empty
Default value: ``
]

Example (from schema)

{
  "groups": [
    {
      "group": "string",
      "label": "string",
      "permissions": [
        {
          "id": "string",
          "method": "string",
          "path": "string"
        }
      ],
      "subgroups": [
        null
      ]
    }
  ],
  "presets": [
    {
      "id": "string",
      "label": "string",
      "routes": [
        "string"
      ]
    }
  ]
}

400

User error

application/json

Schema

Schema

oneOf

MALFORMED_PARAMETERS

status string

Default value: fail

error string

Default value: Malformed parameters

details undefined[]

Default value: [object Object]

Example (from schema)

{}

403

User error

application/json

Schema

Schema

oneOf

AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED

status string

Default value: fail

error string

Default value: Authentication credentials were not provided.

THIS_API_KEY_IS_NOT_PERMITTED_TO_ACCESS_THIS_ROUTE

status string

Default value: fail

error string

Default value: This API key is not permitted to access this route

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

413

Request body too large

application/json

Schema

Schema

oneOf

REQUEST_BODY_TOO_LARGE

status string

Default value: fail

error string

Default value: Request body too large

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

500

Unexpected error

503

Service is temporarily unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORARILY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporarily unavailable. Please try again later

Example (from schema)

{}

504

Gateway timeout. Returned if request takes more than 120 seconds. The request might finish successfully later.

application/json

Schema

Schema

oneOf

GATEWAY_TIMEOUT

status string

Default value: fail

error string

Default value: Gateway timeout

Example (from schema)

{}

default

General error response

application/json

Schema

Schema

status string

Default value: fail

error stringrequired
details object[]

Example (from schema)

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

Loading...