Users API

List all Users

GET /v2/users

Fields

Name	Description	Default	Valid Values	Example Values

Parameters

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		q=filter:value q=filter>value q=filter IN a,b,c
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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5OCIsImVtYWlsIjoiZW1haWwtMTM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzR9.0Nua1WRIk_ZBjYS-_Jihg3nO1qp6w4-WRH1EeLxZ20Y
Host: example.org
Cookie: 

Route

GET /v2/users

cURL

curl "https://api.[your-domain.com]/v2/users" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5OCIsImVtYWlsIjoiZW1haWwtMTM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzR9.0Nua1WRIk_ZBjYS-_Jihg3nO1qp6w4-WRH1EeLxZ20Y" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 396a63a4-4754-4651-888e-dbb96dff12a4
Content-Length: 1892
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "uaa-id-197",
        "url": "/v2/users/uaa-id-197",
        "created_at": "2015-01-27T19:14:34Z",
        "updated_at": null
      },
      "entity": {
        "admin": false,
        "active": false,
        "default_space_guid": "de623e22-895e-4a3c-a562-901234f6cab8",
        "username": "user@example.com",
        "default_space_url": "/v2/spaces/de623e22-895e-4a3c-a562-901234f6cab8",
        "spaces_url": "/v2/users/uaa-id-197/spaces",
        "organizations_url": "/v2/users/uaa-id-197/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-197/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-197/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-197/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-197/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-197/audited_spaces"
      }
    },
    {
      "metadata": {
        "guid": "uaa-id-198",
        "url": "/v2/users/uaa-id-198",
        "created_at": "2015-01-27T19:14:34Z",
        "updated_at": null
      },
      "entity": {
        "admin": true,
        "active": false,
        "default_space_guid": null,
        "spaces_url": "/v2/users/uaa-id-198/spaces",
        "organizations_url": "/v2/users/uaa-id-198/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-198/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-198/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-198/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-198/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-198/audited_spaces"
      }
    }
  ]
}