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/c5710c69-1191-424b-9a50-98ebf4b595cc/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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5IiwiZW1haWwiOiJlbWFpbC0yMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxMzc0NjIzfQ.eRdRyhgtCixEPaDgRXgLx7122SnAX2SEV9DSGdITCE4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/c5710c69-1191-424b-9a50-98ebf4b595cc/user_roles?results-per-page=1&page=1" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5IiwiZW1haWwiOiJlbWFpbC0yMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxMzc0NjIzfQ.eRdRyhgtCixEPaDgRXgLx7122SnAX2SEV9DSGdITCE4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 2,
  "prev_url": null,
  "next_url": "/v2/organizations/c5710c69-1191-424b-9a50-98ebf4b595cc/user_roles?order-direction=asc&page=2&results-per-page=1",
  "resources": [
    {
      "metadata": {
        "guid": "uaa-id-27",
        "url": "/v2/users/uaa-id-27",
        "created_at": "2016-04-16T01:23:43Z",
        "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-27/spaces",
        "organizations_url": "/v2/users/uaa-id-27/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-27/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-27/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-27/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-27/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-27/audited_spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a6b6007c-9198-4a85-a622-768251371676
Content-Length: 1211
X-Content-Type-Options: nosniff