Name | Description | Default | Valid Values | Example Values |
---|
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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNCIsImVtYWlsIjoiZW1haWwtMjQxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Nzh9.lIjEq__53CLgiDGogA7jivWLwynuaSM0nOrQSbT9cqM Host: example.org Cookie:
GET /v2/users
curl "https://api.[your-domain.com]/v2/users" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNCIsImVtYWlsIjoiZW1haWwtMjQxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Nzh9.lIjEq__53CLgiDGogA7jivWLwynuaSM0nOrQSbT9cqM" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: dfeaffeb-3a0b-4f05-9204-f5aef16d1c34 Content-Length: 1862 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 2, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "uaa-id-333", "url": "/v2/users/uaa-id-333", "created_at": "2014-12-24T01:39:38+00:00", "updated_at": null }, "entity": { "admin": false, "active": false, "default_space_guid": "47d1a255-a1ec-4176-90f9-935e56df1202", "default_space_url": "/v2/spaces/47d1a255-a1ec-4176-90f9-935e56df1202", "spaces_url": "/v2/users/uaa-id-333/spaces", "organizations_url": "/v2/users/uaa-id-333/organizations", "managed_organizations_url": "/v2/users/uaa-id-333/managed_organizations", "billing_managed_organizations_url": "/v2/users/uaa-id-333/billing_managed_organizations", "audited_organizations_url": "/v2/users/uaa-id-333/audited_organizations", "managed_spaces_url": "/v2/users/uaa-id-333/managed_spaces", "audited_spaces_url": "/v2/users/uaa-id-333/audited_spaces" } }, { "metadata": { "guid": "uaa-id-334", "url": "/v2/users/uaa-id-334", "created_at": "2014-12-24T01:39:38+00:00", "updated_at": null }, "entity": { "admin": true, "active": false, "default_space_guid": null, "spaces_url": "/v2/users/uaa-id-334/spaces", "organizations_url": "/v2/users/uaa-id-334/organizations", "managed_organizations_url": "/v2/users/uaa-id-334/managed_organizations", "billing_managed_organizations_url": "/v2/users/uaa-id-334/billing_managed_organizations", "audited_organizations_url": "/v2/users/uaa-id-334/audited_organizations", "managed_spaces_url": "/v2/users/uaa-id-334/managed_spaces", "audited_spaces_url": "/v2/users/uaa-id-334/audited_spaces" } } ] }