Skip to main content

Check​

Returns true if a principal has required permissions to access a resource and false otherwise.
Note the principal can be a user, group or a service account.

Request Body required
    subject string required

    the subject to check.
    Example: user:..uuidofuser..

    resource string required

    namespace:uuid or namespace:name of the org or project, and namespace:urn of a resource under a project. In case of an org/project either provide the complete namespace (app/organization) or Frontier can also parse aliases for the same as org or project.
    Example: organization:92f69c3a-334b-4f25-90b8-4d4f3be6b825 or app/project:project-name or compute/instance:92f69c3a-334b-4f25-90b8-4d4f3be6b825

    permission string required

    the permission name to check.
    Example: get, list, compute.instance.create

Responses

A successful response.

Schema
    status boolean
POST /v1beta1/admin/check

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
Body required
{

  "subject": "string",

  "resource": "string",

  "permission": "string"

}
curl / cURL
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/admin/check' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "subject": "string",
  "resource": "string",
  "permission": "string"
}'