Home
Version 3
Organizations API

Organizations API

List all Auditors for the Organization

GET /v2/organizations/:guid/auditors

Request

Route

GET /v2/organizations/0714fcdc-3b14-4f77-96ef-f3d79a9cdf8b/auditors?auditor_guid=uaa-id-89

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization
auditor_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: space_guid, organization_guid, managed_organization_guid, billing_managed_organization_guid, audited_organization_guid, managed_space_guid, audited_space_guid
  • 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
auditor_guid: uaa-id-89

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTkwIiwiZW1haWwiOiJlbWFpbC03NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTk2fQ.7G6WgnkzwIIx16GwUJmlFf4AoYpOnSeXORQkqtBI9R0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/0714fcdc-3b14-4f77-96ef-f3d79a9cdf8b/auditors?auditor_guid=uaa-id-89" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTkwIiwiZW1haWwiOiJlbWFpbC03NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTk2fQ.7G6WgnkzwIIx16GwUJmlFf4AoYpOnSeXORQkqtBI9R0" \
	-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": "uaa-id-88",
        "url": "/v2/users/uaa-id-88",
        "created_at": "2015-08-06T00:36:36Z",
        "updated_at": null
      },
      "entity": {
        "admin": false,
        "active": false,
        "default_space_guid": null,
        "username": "auditor@example.com",
        "spaces_url": "/v2/users/uaa-id-88/spaces",
        "organizations_url": "/v2/users/uaa-id-88/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-88/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-88/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-88/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-88/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-88/audited_spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 190bffc1-7f5b-484d-8418-00742b4a74cd
Content-Length: 956
X-Content-Type-Options: nosniff