Get all groups
GET
groups
Get all groups.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/groups |
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 groups. |
400 Bad Request | The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. |
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:
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 | The identifier for the object. |
name string | The unique name of the Group. |
systemName string | |
authTypes object | The type of account to retrieve. Allowed values are ActiveDirectory, Vault, and Autodesk.
Possible values: ActiveDirectory , Vault , Autodesk |
createDate string | The date the Group was created. |
emailDL string | The email address (distribution list) for the Group. |
isActive boolean | Is the group active |
url string | The relative URL to access this object. |
Example
This example illustrates how to get all groups 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/groups?limit=2' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"pagination": {
"limit": 2,
"totalResults": 31,
"nextUrl": "/AutodeskDM/Services/api/vault/v2/groups?limit=2&cursorState=SQBkAEMAdQByAHMAbwByAC0AdgAxADoAMQA0AA__",
"indexingStatus": "NA"
},
"results": [
{
"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": "14",
"name": "Administrators",
"authTypes": 0,
"createDate": "2013-10-25T12:38:20.007Z",
"emailDL": "",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/groups/14"
}
]
}
Show More