Home
Version 3
Organizations API

Organizations API

Retrieving the roles of all Users in the Organization

GET /v2/organizations/:guid/user_roles

Request

Route

GET /v2/organizations/c1974b4a-5598-41b9-a6b5-e4aaff87b94a/user_roles?results-per-page=1&page=1

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
results-per-page: 1
page: 1

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NiIsImVtYWlsIjoiZW1haWwtMTMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4Mzh9.ZEC4ZkXBwTNbItP7CHfiv74gUvIahqeDK5XpjMLGAQE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/c1974b4a-5598-41b9-a6b5-e4aaff87b94a/user_roles?results-per-page=1&page=1" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NiIsImVtYWlsIjoiZW1haWwtMTMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4Mzh9.ZEC4ZkXBwTNbItP7CHfiv74gUvIahqeDK5XpjMLGAQE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 2,
  "prev_url": null,
  "next_url": "/v2/organizations/c1974b4a-5598-41b9-a6b5-e4aaff87b94a/user_roles?order-direction=asc&page=2&results-per-page=1",
  "resources": [
    {
      "metadata": {
        "guid": "uaa-id-154",
        "url": "/v2/users/uaa-id-154",
        "created_at": "2015-11-03T00:53:58Z",
        "updated_at": null
      },
      "entity": {
        "admin": false,
        "active": false,
        "default_space_guid": null,
        "username": "everything@example.com",
        "organization_roles": [
          "org_user",
          "org_manager",
          "org_auditor",
          "billing_manager"
        ],
        "spaces_url": "/v2/users/uaa-id-154/spaces",
        "organizations_url": "/v2/users/uaa-id-154/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-154/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-154/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-154/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-154/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-154/audited_spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 4913fed5-ec64-43dc-b26a-4c1592ef1328
Content-Length: 1220
X-Content-Type-Options: nosniff