Home
Version 3
Private Domains API

Private Domains API

List all Shared Organizations for the Private Domain

GET /v2/private_domains/:guid/shared_organizations

Request

Route

GET /v2/private_domains/46fb94be-e622-41d7-96cc-4f9d13f45c22/shared_organizations

Parameters

Name Description Valid Values Example Values
guid The guid of the domain
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMjAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTN9.qOgo62d9dJMtuObIL7PT5mYV5VP0kS9SCe6MpjoB1eI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/private_domains/46fb94be-e622-41d7-96cc-4f9d13f45c22/shared_organizations" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMjAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMTN9.qOgo62d9dJMtuObIL7PT5mYV5VP0kS9SCe6MpjoB1eI" \
	-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": "e6df9b5e-3869-41e6-aaa1-d1ace8323b2a",
        "url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a",
        "created_at": "2015-10-13T17:31:53Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1068",
        "billing_enabled": false,
        "quota_definition_guid": "9ff09e8a-4af4-4db6-b93d-77dec2944b6c",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/9ff09e8a-4af4-4db6-b93d-77dec2944b6c",
        "spaces_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/spaces",
        "domains_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/domains",
        "private_domains_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/private_domains",
        "users_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/users",
        "managers_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/managers",
        "billing_managers_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/billing_managers",
        "auditors_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/auditors",
        "app_events_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/app_events",
        "space_quota_definitions_url": "/v2/organizations/e6df9b5e-3869-41e6-aaa1-d1ace8323b2a/space_quota_definitions"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5111c216-d657-48de-9475-ca77b148bb7d
Content-Length: 1503
X-Content-Type-Options: nosniff