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/35e73dbe-411d-4ca1-8174-3d04bf4f74a2/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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzM0fQ.beeoMpoGYMEG-_pYtlQsr0JdaR7WJgj3829IGB-VAo8
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/private_domains/35e73dbe-411d-4ca1-8174-3d04bf4f74a2/shared_organizations" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzM0fQ.beeoMpoGYMEG-_pYtlQsr0JdaR7WJgj3829IGB-VAo8" \
	-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": "212b4216-f375-4115-aac1-664724cebdbb",
        "url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb",
        "created_at": "2015-03-05T19:15:34Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-71",
        "billing_enabled": false,
        "quota_definition_guid": "f9dc9a8d-6c52-4b5c-9038-4b3b9caf2f21",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/f9dc9a8d-6c52-4b5c-9038-4b3b9caf2f21",
        "spaces_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/spaces",
        "domains_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/domains",
        "private_domains_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/private_domains",
        "users_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/users",
        "managers_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/managers",
        "billing_managers_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/billing_managers",
        "auditors_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/auditors",
        "app_events_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/app_events",
        "space_quota_definitions_url": "/v2/organizations/212b4216-f375-4115-aac1-664724cebdbb/space_quota_definitions"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: bcb91545-f729-44cc-94d5-f0727efa0fef
Content-Length: 1501
X-Content-Type-Options: nosniff