Use these operations to retrieve a list of all users created to access Virtual Private Cloud OnDemand or to retrieve the details for a specified user.

You have signed up and registered for Virtual Private Cloud OnDemand and received an email with a user name and password for an Account Administrator.

Using the URL in the confirmation email, you have logged in to Virtual Private Cloud OnDemand using the Web UI, set your password, and accepted the Terms of Service.

You have logged in as an administrator using the /api/IAM/login API and received an OATH token. See Log In and Receive Access Token for information.

1

Issue a request to get the list of users for your account:

GET https://vca.vmware.com/api/IAM/Users

In the request, include the OATH token and the Accept header:

Accept: application/json;version=5.7
Authorization: Bearer OAuth_token

Include the OATH token in all subsequent API requests as a request header.

The returned response includes the list of users added for your account.

2

To get the details for a specific user, issue the following request:

GET https://vca.vmware.com/api/IAM/Users/userId

Where userId is the ID you received in step 1.

This example shows how to request a list of all users for your account and then request details for a specific user.

Request Header – List all users

GET https://vca.vmware.com/api/IAM/Users
Accept: application/json;version=5.7
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiJiN2VjNjUyZi1mZmUzLTRh…

Request body not required.

Response Body – List all users

{"users":[
   "meta": {
      "created":1402527010108,
      "modified":1402527010108
   },
   "schemas": [
      "urn:scim:schemas:core:1.0"
    ],
    "state": "Active",
    "id": "790ee208-6c7d-4177-b6c6-212bdbe1a66b",
    "companyId": "e9b1f777-ab16-493d-a0af-ad3474e13cd2",
    "customerNumber": null,
    "email": "test994@sample.com",
    "familyName": "samplefamily1",
    "givenName": "Jane",
    "roles": {
        "roles": [
            {
                "description": "Allows creation and management of VMs.",
                "name": "End User",
                "id": "6"
            }
        ]
    },
    "serviceGroupIds": {
        "serviceGroupIds": []
    },
    "tosAcceptDate": null,
    "tosAccepted": false,
    "userName": "test994@sample.com"
     },
        {
   "meta": {
      "created":1402527205542
      "modified":1402527205542
    },
    "schemas": [
        "urn:scim:schemas:core:1.0"
    ],
    "state": "Active",
    "id": "021cd2ab-c727-45f0-bbaf-1bb2f4af4b72",
    "companyId": "e9b1f777-ab16-493d-a0af-ad3474e13cd2",
    "customerNumber": null,
    "email": "1925test@sample.com",
    "familyName": "FamilyName",
    "givenName": "John",
    "roles": {
        "roles": [
            {
                "description": "Allows user management and account settings.",
                "name": "Account Administrator",
                "id": "1"
            }
        ]
    },
    "serviceGroupIds": {
        "serviceGroupIds": []
    },
    "tosAcceptDate": null,
    "tosAccepted": false,
    "userName": "1925test@sample.com"
        }
    ]
}

Request Header – Get user

GET https://vca.vmware.com/api/iam/Users/790ee208-6c7d-4177-b6c6-212bdbe1a66b

Request body not required.

Response Body – Get user

{"users":[
      "meta": {
      "created":1402527010108,
      "modified":1402527010108
    },
    "schemas": [
        "urn:scim:schemas:core:1.0"
    ],
    "state": "Active",
    "id": "790ee208-6c7d-4177-b6c6-212bdbe1a66b",
    "companyId": "e9b1f777-ab16-493d-a0af-ad3474e13cd2",
    "customerNumber": null,
    "email": "test994@sample.com",
    "familyName": "samplefamily1",
    "givenName": "Jane",
    "roles": {
        "roles": [
            {
              "description": "Allows creation and management of VMs.",
              "name": "End User",
              "id": "6"
            }
        ]
    },
    "serviceGroupIds": {
        "serviceGroupIds": []
    },
    "tosAcceptDate": null,
    "tosAccepted": false,
    "userName": "test994@sample.com"
}