users/{id}
Retrieves the full user object associated with the specified id.
Resource Information
| Method and URI | GET /AutodeskDM/Services/api/vault/v2/users/{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 a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.
The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context. |
Request
URI Parameters
| id string | The unique identifier of a user. |
Response
HTTP Status Code Summary
| 200 OK | The user was successfully retrieved. |
| 400 Bad Request | The user identifier in the request is missing or not valid. Verify the id URI parameter and try again. |
| 401 Unauthorized | The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. |
| 403 Forbidden | The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again. |
Response
Body Structure (200)
| id string | A unique number that the Vault uses to reference the user. |
| name string | The login name of the user. |
| email string | The email address of the user. |
| authTypes enum:string | Specifies which account directory backs the sign-in record. Possible values:
|
| systemName string | The internal system name of the user. |
| createDate datetime: ISO 8601 | The date that the user was created. |
| isActive boolean | Indicates whether this user is active.
|
| url string | The relative URL to access this object. |
| firstName string | The first name of the user. |
| lastName string | The last name of the user. |
| analyticsId string | The analytics identifier associated with this user. |
| roles array: object | An array of roles associated with this user. |
| 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 | A human-readable description of the role’s purpose. |
| url string | The relative URL to access this object. |
| vaults array: object | An array of Knowledge Vaults associated with this user. |
| name string | The name of the Knowledge Vault. This is also the name of the database. |
| id string | A unique identifier for the Knowledge Vault. |
| url string | The relative URL to access this object. |
| groups array: object | An array of groups in which the user is a direct member. |
| id string | The identifier for the object. |
| name string | The unique name of the Group. |
| systemName string | The internal system name of the group. |
| authTypes enum:string | Specifies which account directory backs the sign-in record. Possible values:
|
| createDate datetime: ISO 8601 | The date the Group was created. |
| emailDL string | The email address (distribution list) for the Group. |
| isActive boolean | Indicates whether this group is active.
|
| url string | The relative URL to access this object. |
| accounts array: object | An array of accounts associated with this user. |
| id string | The unique identifier of the account. |
| accountName string | The name of the account for signin purposes. |
| accountEmail string | The email associated with the account. |
| isActive boolean | true: The account is active (enabled).
|
| url string | The relative URL to access this object. |
| attributes array: object | An array of profile attribute values for this user. |
| definition object | Contains metadata defining a Vault profile attribute, including mappings and applicability. |
| id string | The unique identifier of the profile attribute definition. |
| attributeName string | Name of the profile attribute (must be unique). |
| systemName string | The internal system name of the profile attribute. |
| activeDirectoryMapping string | Active Directory field the attribute is mapped from (null if not mapped). |
| association enum:string | Specifies which directory objects may use this profile attribute definition. Possible values:
|
| url string | The relative URL to access this object. |
| value string | |
| isAdministrator boolean | Indicates whether the user has Vault administrator privileges for this server.
|
| createUser object | Contains core Vault account metadata returned for directory operations. |
| id string | A unique number that the Vault uses to reference the user. |
| name string | The login name of the user. |
| email string | The email address of the user. |
| authTypes enum:string | Specifies which account directory backs the sign-in record. Possible values:
|
| systemName string | The internal system name of the user. |
| createDate datetime: ISO 8601 | The date that the user was created. |
| isActive boolean | Indicates whether this user is active.
|
| url string | The relative URL to access this object. |
Example
This example illustrates how to get an user 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/users/13' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"id": "13",
"firstName": "Polly",
"lastName": "Purchase",
"analyticsId": "872368cbf245516d5d4debe13df638c4402b21708fc7a1e67e2b31810e518c3c",
"roles": [
{
"id": "4",
"roleName": "Document Editor (Level 1)",
"systemName": "Vault Basic Editor",
"description": "Adding and editing privileges within the vault and can add/remove file and folder user-defined properties",
"url": "/AutodeskDM/Services/api/vault/v2/roles/4"
},
{
"id": "7",
"roleName": "Document Manager (Level 1)",
"systemName": "Document Editor",
"description": "Full control over category, lifecycle, revision assignments, and user-defined properties",
"url": "/AutodeskDM/Services/api/vault/v2/roles/7"
},
{
"id": "9",
"roleName": "Item Editor (Level 2)",
"systemName": "Productstream Creator",
"description": "Full control over files, folders, and items",
"url": "/AutodeskDM/Services/api/vault/v2/roles/9"
},
{
"id": "14",
"roleName": "Change Order Editor (Level 2)",
"systemName": "Change Order Editor",
"description": "Full control over all Change Orders including those in approved status",
"url": "/AutodeskDM/Services/api/vault/v2/roles/14"
},
{
"id": "17",
"roleName": "Custom Object Editor (Level 2)",
"systemName": "Custom Entity Editor (Level 2)",
"description": "Full control over all Custom Objects",
"url": "/AutodeskDM/Services/api/vault/v2/roles/17"
},
{
"id": "19",
"roleName": "Custom Object Manager (Level 2)",
"systemName": "Custom Entity Manager (Level 2)",
"description": "Full control over category, lifecycle, revision assignments, user-defined properties, and file behavior",
"url": "/AutodeskDM/Services/api/vault/v2/roles/19"
},
{
"id": "23",
"roleName": "User Group Reader",
"description": "Ability to view user data from all users, e.g., read group member ship(s). Intended for customization and extensions.",
"url": "/AutodeskDM/Services/api/vault/v2/roles/23"
}
],
"vaults": [
{
"id": "101",
"name": "PDMC-Sample",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101"
}
],
"groups": [
{
"id": "1",
"name": "Everyone",
"systemName": "Everyone",
"authTypes": 0,
"createDate": "2013-10-17T20:18:13.157Z",
"emailDL": "",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/groups/1"
},
{
"id": "22",
"name": "Operations",
"authTypes": 0,
"createDate": "2013-10-25T12:54:02.233Z",
"emailDL": "",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/groups/22"
},
{
"id": "21",
"name": "Production Vault",
"authTypes": 0,
"createDate": "2013-10-25T12:51:28.667Z",
"emailDL": "",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/groups/21"
}
],
"accounts": [
{
"id": "Vault",
"accountName": "Polly Purchase",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/users/13/accounts/Vault"
}
],
"attributes": [
{
"definition": {
"id": "1",
"attributeName": "First Name",
"systemName": "FirstName",
"activeDirectoryMapping": "givenName",
"association": "User",
"url": "/AutodeskDM/Services/api/vault/v2/profile-attribute-definitions/1"
},
"value": "Polly"
},
{
"definition": {
"id": "2",
"attributeName": "Last Name",
"systemName": "LastName",
"activeDirectoryMapping": "sn",
"association": "User",
"url": "/AutodeskDM/Services/api/vault/v2/profile-attribute-definitions/2"
},
"value": "Purchase"
}
],
"isAdministrator": false,
"createUser": {
"id": "2",
"name": "Administrator",
"systemName": "Administrator",
"email": "",
"authTypes": "Vault",
"createDate": "2013-10-17T20:18:13.19Z",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/users/2"
},
"name": "Polly Purchase",
"email": "",
"authTypes": "Vault",
"createDate": "2013-10-25T12:35:35.863Z",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/users/13"
}