Get Permissions

Retrieve permissions for the ‘subjectType’ ‘subjectId’

GET /v2/{subjectType}/{subjectId}/permissions

Get Permissions

cURL

curl --request GET \
  --url https://api.studio.prisme.ai/v2/{subjectType}/{subjectId}/permissions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.studio.prisme.ai/v2/{subjectType}/{subjectId}/permissions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.studio.prisme.ai/v2/{subjectType}/{subjectId}/permissions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "result": [
    {
      "target": {
        "id": "userId1"
      },
      "permissions": {
        "role": "admin"
      }
    },
    {
      "target": {
        "id": "userId2"
      },
      "permissions": {
        "policies": {
          "read": true
        }
      }
    },
    {
      "target": {
        "public": true
      },
      "permissions": {
        "policies": {
          "read": true
        }
      }
    }
  ]
}

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthOrgApiKeyAuthBearerAuth & OrgApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subjectType · enum<string> · required

The target subject type

Available options: pages, workspaces

subjectId · string · required

The target subject id (i.e workspaceId if subjectType is 'workspace')

Response

200

application/json

Success Response

result · object[] · required

Hide child attributes

result. target · object · required

Option 1

Option 2

Option 3

Hide child attributes

result.target. id · string · required

result.target. public · boolean

result.target. role · string

result.target. displayName · string

result. permissions · object · required

Hide child attributes

result.permissions. role · string

result.permissions. policies · object

Hide child attributes

result.permissions.policies. read · boolean

result.permissions.policies. write · boolean

result.permissions.policies. update · boolean

result.permissions.policies. create · boolean

result.permissions.policies. manage_permissions · boolean

Example:

[
  {
    "target": { "id": "userId1" },
    "permissions": { "role": "admin" }
  },
  {
    "target": { "id": "userId2" },
    "permissions": { "policies": { "read": true } }
  },
  {
    "target": { "public": true },
    "permissions": { "policies": { "read": true } }
  }
]