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/2f4bc511-6369-4778-85aa-a60c10231f51/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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NSIsImVtYWlsIjoiZW1haWwtMTIzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NTF9.rVQTFGttYeyzVtJLD7jXkZuq7J9exQoogA2zZMDw6sY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/2f4bc511-6369-4778-85aa-a60c10231f51/user_roles?results-per-page=1&page=1" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NSIsImVtYWlsIjoiZW1haWwtMTIzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NTF9.rVQTFGttYeyzVtJLD7jXkZuq7J9exQoogA2zZMDw6sY" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 2,
  "prev_url": null,
  "next_url": "/v2/organizations/2f4bc511-6369-4778-85aa-a60c10231f51/user_roles?order-direction=asc&page=2&results-per-page=1",
  "resources": [
    {
      "metadata": {
        "guid": "uaa-id-143",
        "url": "/v2/users/uaa-id-143",
        "created_at": "2015-06-16T23:40:51Z",
        "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-143/spaces",
        "organizations_url": "/v2/users/uaa-id-143/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-143/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-143/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-143/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-143/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-143/audited_spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c4c8af8b-77a3-4ebd-a44f-2906a6f44ade
Content-Length: 1220
X-Content-Type-Options: nosniff