Skip to main content

Batch check​

Returns true if a principal has required permissions to access a resource and false otherwise.
Note the principal can be a user or a service account, and Frontier will the credentials from the current logged in principal from the session cookie (if any), or the client id and secret (in case of service users) or the access token (in case of human user accounts).

Request Body required
    bodies object[]
  • Array [
    • permission string required

    the permission name to check.
    Example: get or list

    resource string

    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

  • ]
Responses

A successful response.

Schema
    pairs object[]
  • Array [
    • body object
    permission string required

    the permission name to check.
    Example: get or list

    resource string

    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

    status boolean
  • ]
POST /v1beta1/batchcheck

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
{

  "bodies": [

    {

      "permission": "string",

      "resource": "string"

    }

  ]

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