Skip to main content

GetPermissionsResponseModel

statusboolean

Whether the request succeeded.

Example: true
messagestring

Human-readable description of the result.

Example: Getting permissions success
permissions object[]

Permissions granted by the role.

  • Array [
  • idinteger

    Unique numeric identifier for the permission.

    Example: 7613
    resourcestring

    Resource the permission grants access to.

    Example: Environment
    permissionstring

    Name of the permission.

    Example: environment:list
    methodstring

    HTTP method the permission applies to.

    Example: GET
    endpointstring

    API endpoint the permission applies to.

    Example: ^/core/environments/?$
    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the permission was created.

    Example: 2026-05-06T15:18:42Z
  • ]
  • GetPermissionsResponseModel
    {
    "status": true,
    "message": "Getting permissions success",
    "permissions": [
    {
    "id": 7613,
    "resource": "Environment",
    "permission": "environment:list",
    "method": "GET",
    "endpoint": "^/core/environments/?$",
    "created_at": "2026-05-06T15:18:42Z"
    }
    ]
    }