getMyAccess

GET

/api/v1/me/access

const url = 'https://example.com/api/v1/me/access';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/me/access

The signed-in account’s role, effective capabilities, and Media content access. Available to every enrolled account with the read scope.

Responses

200

Effective access

application/json

object

data

required

object

role

required

object

key

required

Role key. The built-in roles are owner, administrator, editor, contributor, and viewer. Custom role keys start with “custom.”. Decide authorization from the capabilities the server reports, not from the role key.

string

/^[a-z][a-z0-9.-]{1,63}$/

name

required

string

builtin

required

boolean

capabilities

required

Array<string>

content

required

object

libraryMode

required

string

Allowed values: all restricted

tagMode

required

string

Allowed values: all restricted

writableFolderIds

Folders the account may upload into. Absent when the account reaches the whole library, which may also use the root.

Array<string>

screens

required

The signed-in account’s screen access. An account without a stored policy reads as restricted with no grants.

object

mode

required

All reaches every screen. restricted reaches the union of the granted locations and Display Groups, and nothing without grants.

string

Allowed values: all restricted

locationIds

required

Locations granted directly. Empty for all screens.

Array<string>

groupIds

required

Display Groups granted directly. Empty for all screens.

Array<string>

Example

{
  "data": {
    "role": {
      "key": "owner"
    },
    "content": {
      "libraryMode": "all",
      "tagMode": "all"
    },
    "screens": {
      "mode": "all"
    }
  }
}

401

Dashboard authentication required