Roles

List available roles and permissions for the tenant

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/roles

Returns role definitions and associated permission.

Authorization

Requires tenant.access:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Roles returned.

text/plainapplication/jsontext/json

namestring · nullableRequired

permissionsstring[] · nullableRequired

get

/api/{tenantId}/admin/roles

HTTPcURLJavaScriptPython

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

200

Roles returned.

[
  {
    "name": null,
    "permissions": [
      "text"
    ]
  }
]

Get a specific role and permissions for the tenant

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/roles/{roleName}

Returns role definition and associated permissions for a single role.

Authorization

Requires tenant.access:read scope, or the caller must have the same role as roleName.

Path parameters

tenantIdstringRequired

roleNamestringRequired

Responses

200

Role returned.

text/plainapplication/jsontext/json

namestring · nullableRequired

permissionsstring[] · nullableRequired

401

Caller not authorized.

text/plainapplication/jsontext/json

404

Role not found.

text/plainapplication/jsontext/json

get

/api/{tenantId}/admin/roles/{roleName}

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/roles/{roleName} HTTP/1.1
Host: app.neostore.cloud
Accept: */*

{
  "name": null,
  "permissions": [
    "text"
  ]
}