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
the subject to check.
Example: user:..uuidofuser..
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
the permission name to check.
Example: get
, list
, compute.instance.create
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
Schema
{
"status": true
}
Bad Request - The request was malformed or contained invalid parameters.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}