Get group account information by specific type
GET
groups/{id}/accounts/{authType}
Get group account information by a specific type.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/groups/{id}/accounts/{authType} |
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 group. |
authType enum:string | Possible values: ActiveDirectory , Vault , Autodesk |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the account. |
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)
id string | |
accountName string | The name of the account for signin purposes. |
accountEmail string | The email associated with the account. |
isActive boolean | Is the account active (enabled). |
url string | The relative URL to access this object. |
Example
This example illustrates how to retrieve an account by account type.
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/23/accounts/ActiveDirectory' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"id": "ActiveDirectory",
"accountName": "ADS\\Test Accounts",
"accountEmail": "",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/groups/69/accounts/ActiveDirectory"
}