Home
Version 3
Users API

Users API

List all Organizations for the User

GET /v2/users/:guid/organizations

Request

Route

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

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNCIsImVtYWlsIjoiZW1haWwtNThAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4MH0.PsUEky9KNEKYNLKW7d_W_nqtkHtOFiR0vqAbBGONt9Y
Host: example.org
Cookie: 

cURL

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

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "602ec8ad-79f1-412a-9f47-806404fb38dc",
        "url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc",
        "created_at": "2015-12-22T18:28:00Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-329",
        "billing_enabled": false,
        "quota_definition_guid": "75b7e6c2-209c-4be3-a5fa-6fa624381d80",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/75b7e6c2-209c-4be3-a5fa-6fa624381d80",
        "spaces_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/spaces",
        "domains_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/domains",
        "private_domains_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/private_domains",
        "users_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/users",
        "managers_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/managers",
        "billing_managers_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/billing_managers",
        "auditors_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/auditors",
        "app_events_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/app_events",
        "space_quota_definitions_url": "/v2/organizations/602ec8ad-79f1-412a-9f47-806404fb38dc/space_quota_definitions"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1502
X-Content-Type-Options: nosniff