Request

Response

    Get User Accounts
    GET

    users/{id}/accounts

    Retrieves all accounts associated with the specified user id.

    Resource Information

    Method and URI
    GET
    /AutodeskDM/Services/api/vault/v2/users/{id}/accounts
    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.

    * Required

    Request

    URI Parameters

    id
    string
    The unique identifier of a user.

    Response

    HTTP Status Code Summary

    200
    OK
    The list of accounts 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)

    Expand all
    pagination
    object
    Contains pagination metadata for navigating through large result sets.
    limit
    int
    The maximum number of results that can be returned in this response. The actual number of results may be fewer due to filtering, data availability, or other constraints. This reflects the limit value applied by the server, which may differ from the requested limit.
    totalResults
    int
    The total number of results available across all pages that match the query criteria, regardless of pagination limits.
    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. Possible values:
    • 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.

    nextUrl
    string
    The URL used to retrieve the next page of results. The URL includes an embedded cursor token for the subsequent call. When null or absent, this is the final page. Note that a page may be empty but still include a next page URL. Continue paging until this attribute is null or absent.
    results
    array: object
    An array of accounts.
    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).

    false: The account is inactive (disabled).

    url
    string
    The relative URL to access this object.

    Example

    This example illustrates how to get all accounts associated with a user.

    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/accounts' \
      -X 'GET' \
      -H 'Accept: application/json'\
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
    

    Response

    {
      "pagination": {
        "limit": 1000,
        "totalResults": 1,
        "indexingStatus": "NA"
      },
      "results": [
        {
          "id": "Vault",
          "accountName": "Polly Purchase",
          "isActive": true,
          "url": "/AutodeskDM/Services/api/vault/v2/users/13/accounts/Vault"
        }
      ]
    }
    
    Show More