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-359/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
(Note that filtering on user_guid will return an empty list if you specify anything other than the guid included in the path.)
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MCIsImVtYWlsIjoiZW1haWwtMjQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MjV9.ENo7HgNjIxMDVr-5CVNL0tFa20sXalQlDc5WRbGkgzE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/users/uaa-id-359/organizations" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MCIsImVtYWlsIjoiZW1haWwtMjQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MjV9.ENo7HgNjIxMDVr-5CVNL0tFa20sXalQlDc5WRbGkgzE" \
	-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": "3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d",
        "url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d",
        "created_at": "2016-05-12T00:45:25Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2131",
        "billing_enabled": false,
        "quota_definition_guid": "556841a4-4c6c-4cdb-8a9b-1e748e2b6a46",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/556841a4-4c6c-4cdb-8a9b-1e748e2b6a46",
        "spaces_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/spaces",
        "domains_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/domains",
        "private_domains_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/private_domains",
        "users_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/users",
        "managers_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/managers",
        "billing_managers_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/billing_managers",
        "auditors_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/auditors",
        "app_events_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/app_events",
        "space_quota_definitions_url": "/v2/organizations/3605d6f4-e869-49fe-ae42-3a0a5d6b9e0d/space_quota_definitions"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f43c86b6-372f-4fc7-8875-85dc457644e5
Content-Length: 1503
X-Content-Type-Options: nosniff