Check user permission in project

GET

/api/v1/rbac/check/permission/{permission}/project/{projectId}

const url = 'https://localhost:8080/api/v1/rbac/check/permission/example/project/example';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://localhost:8080/api/v1/rbac/check/permission/example/project/example \
  --header 'Authorization: <Authorization>'

Report whether the authenticated user holds the given permission within the specified project

Authorizations

BearerAuth
ApiKeyAuth

Parameters

Path Parameters

permission

required

string

Permission name

projectId

required

string

Project ID, UUID (bare or urn:uuid), or slug:my-project within the caller’s organization

Responses

200

Permission check result; an unknown UUID or slug reports hasPermission false

application/json

Whether the caller holds the requested permission, echoing what was checked

object

context

string

hasPermission

boolean

permission

string

projectId

The project reference as sent, or the project whose role granted the check

string

userId

string

Example

{
  "context": "organization",
  "hasPermission": true,
  "permission": "manage_org_settings",
  "projectId": "1",
  "userId": "550e8400-e29b-41d4-a716-446655440001"
}

400

Project ID is not an integer, a UUID, or a slug

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized - Authentication required

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Project lookup failed

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}