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-189/organizations?organization_guid=e6e1a81d-35b9-4384-8736-a90aa0ba3258

Parameters

Name Description Valid Values Example Values
guid The guid of the User
organization_guid The guid of the organization
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
organization_guid: e6e1a81d-35b9-4384-8736-a90aa0ba3258

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE3OTd9.LLA8yHc5TFYTTKwjE62mTBmvcmpAK6qDtaW38QT1JsM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/users/uaa-id-189/organizations?organization_guid=e6e1a81d-35b9-4384-8736-a90aa0ba3258" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE3OTd9.LLA8yHc5TFYTTKwjE62mTBmvcmpAK6qDtaW38QT1JsM" \
	-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": "339497f1-6efb-4096-9101-9ac6b589a74c",
        "url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c",
        "created_at": "2015-07-27T22:43:17Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-526",
        "billing_enabled": false,
        "quota_definition_guid": "d20f9099-b7c1-4916-a20f-7b6864a11007",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/d20f9099-b7c1-4916-a20f-7b6864a11007",
        "spaces_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/spaces",
        "domains_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/domains",
        "private_domains_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/private_domains",
        "users_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/users",
        "managers_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/managers",
        "billing_managers_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/billing_managers",
        "auditors_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/auditors",
        "app_events_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/app_events",
        "space_quota_definitions_url": "/v2/organizations/339497f1-6efb-4096-9101-9ac6b589a74c/space_quota_definitions"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: adca7c87-0676-4945-abef-0833563d2737
Content-Length: 1502
X-Content-Type-Options: nosniff