Permission

check api

Changed on
post/v1/tenants/{tenant_id}/permissions/check

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

tenant_idstring required

Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.

Request body

permissionstring

The action the user wants to perform on the resource

Response

A successful response.

can'CHECK_RESULT_UNSPECIFIED' | 'CHECK_RESULT_ALLOWED' | 'CHECK_RESULT_DENIED'

Enumerates results of a check operation.

  • CHECK_RESULT_UNSPECIFIED: Not specified check result. This is the default value.
  • CHECK_RESULT_ALLOWED: Represents a successful check (the check allowed the operation).
  • CHECK_RESULT_DENIED: Represents a failed check (the check denied the operation).

Changes

  • f37e45046dd2Revision changes
    • breaking

      the //// request property type changed from object to no type

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the request property //

  • f3b10e35081bRevision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status