users

Get the list of all users in the Vault. Note: AdminUserRead permission is required.

Resource Information

Method and URI	GET /AutodeskDM/Services/api/vault/v2/users
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

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 users.
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)

Expand all

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: `IndexingComplete` - All properties and content have been indexed. `IndexingProperties` - File properties are currently being indexed. `IndexingContent` - File content is currently being indexed. `NA` - Not applicable as data not retrieved from index. 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: `IndexingComplete`, `IndexingProperties`, `IndexingContent`, `NA`
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 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 object	The type of account to retrieve. Allowed values are ActiveDirectory, Vault, and Autodesk. Possible values: `ActiveDirectory`, `Vault`, `Autodesk`
systemName string
createDate datetime: ISO 8601	The date that the user was created.
isActive string	Is the user active
url string	The relative URL to access this object.

Example

This example illustrates how to get all users 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/users?limit=2' \
  -X 'GET' \
  -H 'Accept: application/json'\
  -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'

Response

{
  "pagination": {
    "limit": 2,
    "totalResults": 159,
    "nextUrl": "/AutodeskDM/Services/api/vault/v2/users?limit=2&cursorState=SQBkAEMAdQByAHMAbwByAC0AdgAxADoAMwA_",
    "indexingStatus": "NA"
  },
  "results": [
    {
      "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"
    },
    {
      "id": "3",
      "name": "Guest",
      "systemName": "Guest",
      "email": "",
      "authTypes": "Vault",
      "createDate": "2013-10-17T20:18:13.313Z",
      "isActive": true,
      "url": "/AutodeskDM/Services/api/vault/v2/users/3"
    }
  ]
}
Show More

Request

Response

Jump To

users

Resource Information

Request

Headers

Request

Query String Parameters

Response

HTTP Status Code Summary

Response

Body Structure (200)

Example

Request

Response