Home
Version 3
Users API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTg0IiwiZW1haWwiOiJlbWFpbC02MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzY0fQ.GvUABNNf4gHMZhYk5ECgsDEF5bX8gtoN3iPlRKkfCHc
Host: example.org
Cookie: 

Route

GET /v2/users

cURL

curl "https://api.[your-domain.com]/v2/users" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg0IiwiZW1haWwiOiJlbWFpbC02MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzY0fQ.GvUABNNf4gHMZhYk5ECgsDEF5bX8gtoN3iPlRKkfCHc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 322dd36f-fad5-48bc-bde5-4e5f469e69c4
Content-Length: 1874
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-83",
        "url": "/v2/users/uaa-id-83",
        "created_at": "2015-02-10T01:42:44Z",
        "updated_at": null
      },
      "entity": {
        "admin": false,
        "active": false,
        "default_space_guid": "5aef6128-c654-4897-8bd2-d5e1f8aafc1a",
        "username": "user@example.com",
        "default_space_url": "/v2/spaces/5aef6128-c654-4897-8bd2-d5e1f8aafc1a",
        "spaces_url": "/v2/users/uaa-id-83/spaces",
        "organizations_url": "/v2/users/uaa-id-83/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-83/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-83/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-83/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-83/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-83/audited_spaces"
      }
    },
    {
      "metadata": {
        "guid": "uaa-id-84",
        "url": "/v2/users/uaa-id-84",
        "created_at": "2015-02-10T01:42:44Z",
        "updated_at": null
      },
      "entity": {
        "admin": true,
        "active": false,
        "default_space_guid": null,
        "spaces_url": "/v2/users/uaa-id-84/spaces",
        "organizations_url": "/v2/users/uaa-id-84/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-84/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-84/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-84/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-84/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-84/audited_spaces"
      }
    }
  ]
}