This is an archive version of the document. To get the most up-to-date information, see the current version.

Scopes

The /Scopes resource collection represents all scopes created in VAO. The collection includes resources which represent individual scopes and have specific system IDs.

Scopes Note

A range of data available to a client in the VAO REST API depends on permissions of the account under which the client is currently logged in.

Collection URL

The resource collection is located at the following URL:

https://<hostname>:<port>/api/v3/Scopes

Scopes Collection Representation

{

"total": 2,

"data": [

{

"id": "2a87b084-1e8c-42c6-b91f-ad370576e473",

"name": "Admin Scope",

"description": "Default Scope containing administrative roles",

"isDefault": true,

"state": "Active",

"serverId": "ab6dfa51-c6c3-49ef-9291-067194635e37",

"siteName": "Ontario"

{

"id": "539633fa-1188-4d71-8d43-6f942e8d7d3e",

"name": "customScope",

"description": "Custom Auto Scope",

"isDefault": false,

"state": "Active",

"serverId": "ab6dfa51-c6c3-49ef-9291-067194635e37",

"siteName": "Ontario"

}

]

}

In This Section