Get an user role
GET
roles/{id}
Get the role object with given role id
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/roles/{id} |
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. |
* Required
Request
URI Parameters
id string | The unique identifier of a role. |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the role. |
400 Bad Request | Role does not exist |
403 Forbidden | PermissionDenied |
Response
Body Structure (200)
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 a role by its ID.
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/10' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"id": "10",
"roleName": "Item Reviewer",
"systemName": "Productstream Reviewer",
"description": "Read-only access over files, folders, and items",
"url": "/AutodeskDM/Services/api/vault/v2/roles/10"
}