roles
The returned list of roles depends on the permissions of the user passed in via BearerToken. If the user has AdminUserRead permission, all roles are returned. If not, only the roles that are assigned to the user are returned.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/roles |
Authentication Context | user context required |
Required OAuth Scopes | No scopes required |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
Request
Query String Parameters
limit int | Specifies the number of results to return per page. Maximum limit is controlled by “Page size conifguration” setting which could be updated using ADMS (“Global Setting” -> “Page size conifguration”). |
cursorState string | Indicates the state of the cursor for pagination. Use this parameter to navigate through paged results |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the list of roles. |
401 Unauthorized | The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. |
403 Forbidden | Unauthorized |
Response
Body Structure (200)
pagination object | Cursor-based pagination object. |
limit int | Limit requested for the current search |
totalResults int | Number of total hits. If this value is larger than the objects returned, then multiple searches will have to be performed to get the complete result set. |
indexingStatus enum:string | Indicates the current status of the indexing engine. This status helps users understand whether the indexing operation is complete or still in progress. This is particularly important for customers with large datasets, as indexing can take a considerable amount of time to complete.
The statuses include:
Note: When the status is either ‘IndexingProperties’ or ‘IndexingContent’, the search results are incomplete because the indexes are still being created. Complete search results will be available once fully indexed.
Possible values: |
nextUrl string | Used to continue a search if the results are too large for a single call. Url has bookmark string embedded for subsequent calls on that search |
results array: object | |
id string | A unique identifier of the role. |
roleName string | The name of the role. |
systemName string | The system name of the Role. |
description string | Friendly description of the role’s purpose |
url string | The relative URL to access this object. |
Example
This example illustrates how to get all roles from the Vault server, with a limit of 2.
Note: {VaultServerAddress}
is used as a placeholder in the example(s) and could represent one of the following:
- Vault Server IP address or hostname. Ex: http://10.41.110.49.
- Vault Gateway URL if gateway is configured. Ex: https://test.vg.autodesk.com.
Request
curl -v '{VaultServerAddress}/AutodeskDM/Services/api/vault/v2/roles?limit=2' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"pagination": {
"limit": 2,
"totalResults": 25,
"nextUrl": "/AutodeskDM/Services/api/vault/v2/roles?limit=2&cursorState=SQBkAEMAdQByAHMAbwByAC0AdgAxADoAMgA_",
"indexingStatus": "NA"
},
"results": [
{
"id": "1",
"roleName": "Administrator",
"systemName": "Administrator",
"description": "Full control over all folders and administrative server privileges",
"url": "/AutodeskDM/Services/api/vault/v2/roles/1"
},
{
"id": "2",
"roleName": "Document Editor (Level 2)",
"systemName": "Vault Editor",
"description": "Full control over files, folders, and their properties",
"url": "/AutodeskDM/Services/api/vault/v2/roles/2"
}
]
}