Get applicable scopes for selected roles.

Request

Returns the applicable scope predicate types and their permitted values for the selected roles within a company.

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier of the company.

Example:1234a66b-7493-4f41-908c-58ba81093947

Bodyapplication/jsonrequired

roleIdsArray of strings, (uuid)

List of selected role identifiers.

Example:

[
  "1aeef911-44cf-49bb-83c7-e06b0d4e7ac2"
]

selectedAudienceobject(ScopeAudience)

The audience that the scope audience applies to.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/1234a66b-7493-4f41-908c-58ba81093947/roles/applicable-scopes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "roleIds": [
      "1aeef911-44cf-49bb-83c7-e06b0d4e7ac2"
    ],
    "selectedAudience": {
      "predicates": [
        {
          "type": "PLATFORM",
          "value": false
        }
      ]
    }
  }'

Responses

Applicable scopes for the selected roles.

Bodyapplication/json

applicableScopesArray of objects(ApplicableScope)required

List of applicable scopes with their predicate types and permitted values.

Response

{
  "applicableScopes": [
    { … }
  ]
}