Access

Show what a principal can do right now

Changed on

Returns the permission ids and actions a member or API key holds right now, and the models it may call, after its restrictions apply. Without parameters, answers for the caller. Naming a member or key of the organization needs policy.read. The answer is the principal's role intersected with its key restrictions, role conditions and the organization's guardrails. Network rules are checked against the address of the request you send, not one the named principal would call from.

Checked against the self.read permission for the resource it acts on. See Permissions for the roles and API key permissions that include it.

get/v1/authz/effective

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/authz/effective
  • Auth
    HTTP bearer

Query parameters

principalType'member' | 'api_key'
principalIdstring

Response

Effective access

actionsstring[] required

Every allowed action.

activeboolean

False for a key whose owner left the organization.

allModelsboolean required
keyKind'personal' | 'org' | 'legacy'
modelsstring[]

Models the principal may call, when not all.

permissionsstring[] required

Permission ids fully held, for display.

principalIdstring required
principalType'member' | 'api_key' required
roleIdstring
roleNamestring

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 551a288b9aa0Revision changes
    • breaking

      removed the enum value service_account from the query request parameter principalType

    • info

      removed the service enum value from the response property for the response status

    • info

      removed the service_account enum value from the response property for the response status