GET /v2/users
Name | Description | Valid Values | Example Values |
---|---|---|---|
q |
Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: space_guid, organization_guid, managed_organization_guid, billing_managed_organization_guid, audited_organization_guid, managed_space_guid, audited_space_guid |
|
|
page | Page of results to fetch |
|
|
results-per-page | Number of results per page |
|
|
order-direction | Order of the results: asc (default) or desc |
|
|
inline-relations-depth | 0 - don't inline any relations and return URLs. Otherwise, inline to depth N. |
|
|
orphan-relations | 0 - de-duplicate object entries in response |
|
|
exclude-relations | comma-delimited list of relations to drop from response |
|
|
include-relations | comma-delimited list of the only relations to include in response |
|
|
Name | Description | Default | Valid Values | Example Values |
---|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg5IiwiZW1haWwiOiJlbWFpbC02M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzQxfQ.055PNsl9izzBfq0fW9YFrqLZrVgtZc45t5H1X2sJC1o Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/users" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg5IiwiZW1haWwiOiJlbWFpbC02M0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzQxfQ.055PNsl9izzBfq0fW9YFrqLZrVgtZc45t5H1X2sJC1o" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 2, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "uaa-id-88", "url": "/v2/users/uaa-id-88", "created_at": "2015-03-05T19:15:40Z", "updated_at": null }, "entity": { "admin": false, "active": false, "default_space_guid": "5940917a-4af8-4ab6-a844-01ff67276318", "username": "user@example.com", "default_space_url": "/v2/spaces/5940917a-4af8-4ab6-a844-01ff67276318", "spaces_url": "/v2/users/uaa-id-88/spaces", "organizations_url": "/v2/users/uaa-id-88/organizations", "managed_organizations_url": "/v2/users/uaa-id-88/managed_organizations", "billing_managed_organizations_url": "/v2/users/uaa-id-88/billing_managed_organizations", "audited_organizations_url": "/v2/users/uaa-id-88/audited_organizations", "managed_spaces_url": "/v2/users/uaa-id-88/managed_spaces", "audited_spaces_url": "/v2/users/uaa-id-88/audited_spaces" } }, { "metadata": { "guid": "uaa-id-89", "url": "/v2/users/uaa-id-89", "created_at": "2015-03-05T19:15:40Z", "updated_at": null }, "entity": { "admin": true, "active": false, "default_space_guid": null, "spaces_url": "/v2/users/uaa-id-89/spaces", "organizations_url": "/v2/users/uaa-id-89/organizations", "managed_organizations_url": "/v2/users/uaa-id-89/managed_organizations", "billing_managed_organizations_url": "/v2/users/uaa-id-89/billing_managed_organizations", "audited_organizations_url": "/v2/users/uaa-id-89/audited_organizations", "managed_spaces_url": "/v2/users/uaa-id-89/managed_spaces", "audited_spaces_url": "/v2/users/uaa-id-89/audited_spaces" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 250dcb91-39c1-42cc-aacd-700f0d58d62d Content-Length: 1874 X-Content-Type-Options: nosniff