Retrieve a List of All Users
You can retrieve a list with all users in an organization and information about them by using the user management API.
Prerequisites
- You have the Provider Administrator, Provider Operations Administrator, Provider Account Administrator, or Customer Administrator role in your VMware Cloud Partner Navigator organization.
- Obtain an access token from the organization you
want to manage and set it as the
csp-auth-token
request header. See Using VMware Cloud Partner Navigator APIs. - Set the
Content-Type
header of this request toapplication/json
.
Procedure
- ♦
Enter the ID of the organization
from which you want to retrieve the list of users and run a GET request.
GET https://console.navigator.vmware.com/cphub/api/auth/v1/orgs/org_ID/users
Results
The response lists all users in the selected organization and information about them.
Example: Retrieve a List of All Users
This example obtains a list of all users in an organization.
Retrieve the list of users in an organization.
GET https://console.navigator.vmware.com/cphub/api/auth/v1/orgs/d7f32037-b9b5-41ec-9394-ba3edbbc9cac/users
The response lists information about every user in the organization.
[ { "user": { "firstName": "John", "lastName": "Doe", "username": "[email protected]", "email": "[email protected]", "idpId": "lorem", "domain": "lorem.com", "accessible": true }, "orgRoles": { "orgRoles": [ { "id": "msp:provider_operations_admin", "name": "Provider Operations Administrator", "memberType": "DIRECT" } ] }, "serviceRolesList": [ { "serviceId": "I8_vUYLiPxopN_YFGqhgbH6rrAI_", "roles": [ { "roleId": "log-intelligence:admin", "name": "log-intelligence:admin", "hidden": false, "enabled": true, "memberType": "DIRECT" } ] } ] ...