Skip to main content

AbilityCheckRequest

A named batch of capability checks to resolve against the current user.

checks objectrequired

Map of caller-chosen keys to individual ability checks.

property name* object
path object[]required

Ordered resource grant path to check, e.g. [{ "resource": "workflow", "resourceId": 123 }].

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

    Access type, e.g. read or write

    organizationIdinteger

    Organization to scope the check to

    requiredOrgRoleForBypassstring

    Minimum org role that bypasses the grant requirement

    AbilityCheckRequest
    {
      "checks": {}
    }