Home
Version 3
Users API

Users API

List all Organizations for the User

GET /v2/users/:guid/organizations

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the User
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, space_guid, user_guid, manager_guid, billing_manager_guid, auditor_guid, status
  • 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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC00OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE1NzU0MTMyfQ.kaYmh5Yfig1M3-OcINczQ74pLb4IOHKIhIAtESxgK9U
Host: example.org
Cookie:

Route

GET /v2/users/uaa-id-67/organizations

cURL

curl "https://api.[your-domain.com]/v2/users/uaa-id-67/organizations" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY4IiwiZW1haWwiOiJlbWFpbC00OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE1NzU0MTMyfQ.kaYmh5Yfig1M3-OcINczQ74pLb4IOHKIhIAtESxgK9U" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: cc0bdf49-d43c-47f9-b7df-905df9d33add
Content-Length: 1507
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9",
        "url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9",
        "created_at": "2014-11-05T01:02:12+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-237",
        "billing_enabled": false,
        "quota_definition_guid": "41f87875-6de0-4a93-8232-618220b920df",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/41f87875-6de0-4a93-8232-618220b920df",
        "spaces_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/spaces",
        "domains_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/domains",
        "private_domains_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/private_domains",
        "users_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/users",
        "managers_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/managers",
        "billing_managers_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/billing_managers",
        "auditors_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/auditors",
        "app_events_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/app_events",
        "space_quota_definitions_url": "/v2/organizations/1068ff9a-6ee1-4043-b81c-ff1ed5eb47a9/space_quota_definitions"
      }
    }
  ]
}