Read the caller's capabilities

What the caller may do and which modules are on, at the configuration revision both were read at. Poll this rather than inferring entitlements from a refusal.

GET/api/v1/capabilities

認証

AuthorizationOAuth2 アクセストークン · header必須

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

スコープ:api.access

レスポンス

200

The caller's actions and the tenant's modules

actionsstring[]必須

featuresobject必須

revisioninteger必須

最小 1 · 最大 2147483647

400

The request body, query or parameters were refused

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

401

The access token is missing, invalid or revoked

errorstring必須

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

404

No such record, or none the caller may read

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

413

The request exceeds the route's body limit

errorstring必須

500

An unexpected failure

errorstring必須

リクエスト

curl -X GET '/api/v1/api/v1/capabilities' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("/api/v1/api/v1/capabilities", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "/api/v1/api/v1/capabilities",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json"
    },
)

レスポンス

{
  "actions": [
    "objects.bootstrap"
  ],
  "features": {
    "property1": true,
    "property2": true
  },
  "revision": 1
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}