getMembers

Will return all members listed for the current org.

Examples

GraphQL

query GetMembers {
  getMembers {
    user_id
    picture
    name
    email
    roles {
      id
      name
      description
    }
    scopes
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetMembers { getMembers { user_id picture name email roles { id name description } scopes } }"
}'

Node.js

const query = 'query GetMembers { getMembers { user_id picture name email roles { id name description } scopes } }';

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));

Python

import requests

query = 'query GetMembers { getMembers { user_id picture name email roles { id name description } scopes } }'

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: [Member]

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

Field	Description	Supported fields
user_id String	Unique identifier of the user
picture String	URL to the user's profile picture
name String	Full display name of the user
email String	Email address of the user
roles [Role]	List of roles assigned to this user within the organization	id String name String description String
scopes String	Permission scopes assigned to this user within the organization