Permissions

List available permissions and their descriptions

get

/api/{tenantId}/admin/permissions

Returns the areas of the core platform and of the extensions enabled for this tenant; the areas of an extension the tenant has not enabled are left out. Ordered by area code.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Permissions returned.

A group of scopes sharing the same prefix.

codestringRequired

Prefix shared by the scopes of the area, before the colon, e.g. tenant.access. Granting {code}:* grants every scope of the area.

categorystringRequired

Top-level category code used to group permission areas in the UI.

descriptionstring · nullableOptional

What the area covers, in English. Null when the area is undocumented.

401

The caller is not authenticated.

application/problem+json

403

The caller lacks the tenant.access:read scope.

application/problem+json

429

Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.

application/problem+json

get/api/{tenantId}/admin/permissions

GET /api/{tenantId}/admin/permissions HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "code": "text",
    "category": "text",
    "description": null,
    "scopes": [
      {
        "code": "text",
        "description": null
      }
    ]
  }
]