Home
Version 3
Organizations API

Organizations API

List all Auditors for the Organization

GET /v2/organizations/:guid/auditors

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
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: 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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5OCIsImVtYWlsIjoiZW1haWwtMTQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDV9.RBGC6bdvvgwMU2hByWT3x-O7tFJMyu-zy3aFrru-7j4
Host: example.org
Cookie: 

Route

GET /v2/organizations/39dd6ece-d8f0-4abb-938d-461b9479010f/auditors

cURL

curl "https://api.[your-domain.com]/v2/organizations/39dd6ece-d8f0-4abb-938d-461b9479010f/auditors" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5OCIsImVtYWlsIjoiZW1haWwtMTQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDV9.RBGC6bdvvgwMU2hByWT3x-O7tFJMyu-zy3aFrru-7j4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d9c5afcc-dfa3-405e-af13-51f72b35d673
Content-Length: 927
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "uaa-id-197",
        "url": "/v2/users/uaa-id-197",
        "created_at": "2014-11-13T23:38:25+00:00",
        "updated_at": null
      },
      "entity": {
        "admin": false,
        "active": false,
        "default_space_guid": null,
        "spaces_url": "/v2/users/uaa-id-197/spaces",
        "organizations_url": "/v2/users/uaa-id-197/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-197/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-197/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-197/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-197/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-197/audited_spaces"
      }
    }
  ]
}