Skip to main content

SuccessResponse_UserAbilities

successboolean
Constant value: true
data object

The authenticated user's effective grant abilities plus bypass scope.

isPlatformAdminboolean

True when the user is a platform administrator, short-circuiting all grant checks.

bypassOrgIdsinteger[]

Ids of organizations for which the user holds a role that bypasses grant checks.

hasGrantsboolean

True when the user holds at least one grant ability

abilities object[]

The user's effective grant abilities.

  • Array [
    • path object[]required

    Possible values: >= 1

  • Array [
    • resourcestringrequired

    Possible values: [access-token, ai-model, client-contract, cluster, collection, connector, dataset, endpoint, entry, file, workflow, grant, invoice, job, license, mcp-config, node, organization, provider, rate-catalog-entry, role, source, stripe, tag, user]

    resourceId objectrequired

    A positive integer id, or the wildcard "*" covering every resource of this type.

    oneOf
    integer

    Possible values: >= 1

  • ]
    • accessTypestringrequired

    Possible values: [read, write]

  • ]
    • SuccessResponse_UserAbilities
    {
      "success": true,
      "data": {
        "isPlatformAdmin": true,
        "bypassOrgIds": [
          0
        ],
        "hasGrants": true,
        "abilities": [
          {
            "path": [
              {
                "resource": "access-token",
                "resourceId": 0
              }
            ],
            "accessType": "read"
          }
        ]
      }
    }