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.
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.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNiIsImVtYWlsIjoiZW1haWwtMjMyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Nzd9.yqcmCjoQUf4op7nRB9cUbnNXKw5nwFrn3WMsViSUB0o
Host: example.org
Cookie: 

Route

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

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 20a03909-8603-4cc2-9173-0c108035bca2
Content-Length: 1508
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "17faf4c7-0a3b-42f2-b1ce-c25b3c95c450",
        "url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450",
        "created_at": "2014-12-24T01:39:37+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-1813",
        "billing_enabled": false,
        "quota_definition_guid": "1d8e9843-2f9c-40d3-b0ba-d0ef0d091c5d",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/1d8e9843-2f9c-40d3-b0ba-d0ef0d091c5d",
        "spaces_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/spaces",
        "domains_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/domains",
        "private_domains_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/private_domains",
        "users_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/users",
        "managers_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/managers",
        "billing_managers_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/billing_managers",
        "auditors_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/auditors",
        "app_events_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/app_events",
        "space_quota_definitions_url": "/v2/organizations/17faf4c7-0a3b-42f2-b1ce-c25b3c95c450/space_quota_definitions"
      }
    }
  ]
}