getGlobalRoles

Retrieves all available roles that can be assigned to users in the organization.

Examples

query GetGlobalRoles {
  getGlobalRoles {
    id
    name
    description
    displayName
  }
}

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetGlobalRoles { getGlobalRoles { id name description displayName } }"
}'

const query = 'query GetGlobalRoles { getGlobalRoles { id name description displayName } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

import requests

query = 'query GetGlobalRoles { getGlobalRoles { id name description displayName } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Fields

Return type: [Role]

You can use the following field(s) to specify what information your getGlobalRoles query will return. Please note that some fields may have their own subfields.

Field

Description

Supported fields

id String!

Unique identifier of the role

name String!

Auth0 name of the role

description String

Detailed description of the role's purpose and permissions

displayName String

Human-readable name of the role

Last updated 1 month ago

hashtagExamples

hashtagFields

Examples

Fields