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-178/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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3OSIsImVtYWlsIjoiZW1haWwtMTI3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MDR9.eSaxLY00y75XQZNXeiirq5IuaOo_VzyiQ5Jyb-Afs7k
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/users/uaa-id-178/organizations" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3OSIsImVtYWlsIjoiZW1haWwtMTI3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MDR9.eSaxLY00y75XQZNXeiirq5IuaOo_VzyiQ5Jyb-Afs7k" \
	-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": "d136a0b1-ff03-4836-90f0-2e0e821d94fe",
        "url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe",
        "created_at": "2015-03-10T23:11:43Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-505",
        "billing_enabled": false,
        "quota_definition_guid": "d4002b51-a17c-449b-8d44-e862f99f1729",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/d4002b51-a17c-449b-8d44-e862f99f1729",
        "spaces_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/spaces",
        "domains_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/domains",
        "private_domains_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/private_domains",
        "users_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/users",
        "managers_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/managers",
        "billing_managers_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/billing_managers",
        "auditors_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/auditors",
        "app_events_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/app_events",
        "space_quota_definitions_url": "/v2/organizations/d136a0b1-ff03-4836-90f0-2e0e821d94fe/space_quota_definitions"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8b5be335-aff5-48ca-a6a9-4b10b33a02f5
Content-Length: 1502
X-Content-Type-Options: nosniff