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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ5IiwiZW1haWwiOiJlbWFpbC0yM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5NjY0MTMzfQ.mHEOh0_gyjhVLIWTREhyFWQ2y_P-ZvOufoYEw6RmycQ Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/users" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ5IiwiZW1haWwiOiJlbWFpbC0yM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5NjY0MTMzfQ.mHEOh0_gyjhVLIWTREhyFWQ2y_P-ZvOufoYEw6RmycQ" \ -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-48", "url": "/v2/users/uaa-id-48", "created_at": "2015-04-15T00:55:33Z", "updated_at": null }, "entity": { "admin": false, "active": false, "default_space_guid": "8c96744f-1f30-491f-b7de-2dcb0ca5f207", "username": "user@example.com", "default_space_url": "/v2/spaces/8c96744f-1f30-491f-b7de-2dcb0ca5f207", "spaces_url": "/v2/users/uaa-id-48/spaces", "organizations_url": "/v2/users/uaa-id-48/organizations", "managed_organizations_url": "/v2/users/uaa-id-48/managed_organizations", "billing_managed_organizations_url": "/v2/users/uaa-id-48/billing_managed_organizations", "audited_organizations_url": "/v2/users/uaa-id-48/audited_organizations", "managed_spaces_url": "/v2/users/uaa-id-48/managed_spaces", "audited_spaces_url": "/v2/users/uaa-id-48/audited_spaces" } }, { "metadata": { "guid": "uaa-id-49", "url": "/v2/users/uaa-id-49", "created_at": "2015-04-15T00:55:33Z", "updated_at": null }, "entity": { "admin": true, "active": false, "default_space_guid": null, "spaces_url": "/v2/users/uaa-id-49/spaces", "organizations_url": "/v2/users/uaa-id-49/organizations", "managed_organizations_url": "/v2/users/uaa-id-49/managed_organizations", "billing_managed_organizations_url": "/v2/users/uaa-id-49/billing_managed_organizations", "audited_organizations_url": "/v2/users/uaa-id-49/audited_organizations", "managed_spaces_url": "/v2/users/uaa-id-49/managed_spaces", "audited_spaces_url": "/v2/users/uaa-id-49/audited_spaces" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 2b10d558-0028-4676-8558-18a6da97a7f8 Content-Length: 1874 X-Content-Type-Options: nosniff