Skip to content
/Access policies

Access policies

Inspect and administer permitted API access.

Operations

Get organization access

Request

Read child access settings as a partner administrator.

Security
bearerAuth
Path
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/engage/openapi/v1/organizations/{id}/access' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Current resource or page.

Headers
X-Request-Idstring, (uuid)required

Identifier for tracing this response.

ETagstring

Quoted opaque revision when the resource or job result has one.

Bodyapplication/json
enabledbooleanrequired
scopesArray of strings, <= 100 itemsrequired
Items Enum:"meta-organizations:provision""meta-organizations:read""meta-organizations:write""api-access:manage""organizations:read""organizations:write""brands:read""brands:write""members:read""members:write"
delegationAllowedbooleanrequired
Default:false
selfServicebooleanrequired
Default:false
readPerMinuteinteger, [ 1 .. 100000 ]
mutationPerMinuteinteger, [ 1 .. 100000 ]
generationPerMinuteinteger, [ 1 .. 100000 ]
activeGenerationsinteger, [ 1 .. 10000 ]
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
revisionstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
Response
{
  "enabled": true,
  "scopes": [
    "meta-organizations:provision"
  ],
  "delegationAllowed": false,
  "selfService": false,
  "readPerMinute": 1,
  "mutationPerMinute": 1,
  "generationPerMinute": 1,
  "activeGenerations": 1,
  "id": "string",
  "revision": "string"
}