getUserScreenScopes

GET

/api/v1/users/{id}/screen-scopes

const url = 'https://example.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/screen-scopes';
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/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/screen-scopes

Read an account’s screen access: the explicit mode and, for restricted access, the granted locations and Display Groups. Requires users.manage and the admin scope. A restricted policy with no grants reaches no screen. configured is false when the account has no stored policy, which also reaches no screen.

Parameters

Path Parameters

required

string format: uuid

Responses

200

Screen scope grants

application/json

object

data

required

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

scopes

required

Array<object>

object

type

required

string

Allowed values: location group

required

string format: uuid

name

string

configured

required

False when the account has no stored policy, which reaches no screen until one is saved.

boolean

wholeFleet

required

Read mode instead. True exactly when a stored policy is in mode all; never derived from the number of grants.

boolean

Example

{
  "data": {
    "mode": "all",
    "scopes": [
      {
        "type": "location"
      }
    ]
  }
}

401

Dashboard authentication required

403

Insufficient role

404

User not found