Inspect effective API capabilities

Returns credential scopes and workspace-role permissions as separate authorization layers, plus operations that are available, conditional on a target resource, or blocked in the evaluated workspace.

get/capabilities

Request

  • Base URL: https://app.formasty.com/api/v1
  • URL: https://app.formasty.com/api/v1/capabilities
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.formasty.com/oauth/authorize/api/v1, token URL https://app.formasty.com/oauth/token)
    • HTTP bearer

Query parameters

workspaceIdstring

OAuth workspace to evaluate. API keys remain bound to their configured workspace. workspace_id is also accepted.

Headers

X-Formasty-Workspace-Idstring

Alternative workspace selector. It must match any workspaceId query value.

Response

Effective Formasty API capabilities.

contractVersionstring required
defaultWorkProfileobject required
supportedScopesstring[] required
authenticationobject required
safeguardsobject required
unsupportedstring[] required
endpointsobject required
workspaceobject required
workspaceAccessobject required

OAuth workspace grants and the workspace selected for this evaluation. API keys expose selected mode with one bound workspace.

effectiveOperationsstring[] required

Operations immediately available in the evaluated workspace without a target-form check.

Changes

No recorded changes to this operation across all 1 revision of this API.