updateMember

Will update an existing org member.

Examples

GraphQL

mutation UpdateMember($updateMemberInput: UpdateMemberInput) {
  updateMember(updateMemberInput: $updateMemberInput) {
    userId
    roleIDs
    scopes
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "updateMemberInput": {
    "userId": "example",
    "roleIDs": ["example"],
    "scopes": "example"
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation UpdateMember($updateMemberInput: UpdateMemberInput) { updateMember(updateMemberInput: $updateMemberInput) { userId roleIDs scopes } }",
 "variables": {
    "updateMemberInput": {
      "userId": "example",
      "roleIDs": ["example"],
      "scopes": "example"
    }
  }
}'

Node.js

const query = 'mutation UpdateMember($updateMemberInput: UpdateMemberInput) { updateMember(updateMemberInput: $updateMemberInput) { userId roleIDs 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,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      updateMemberInput: {
        userId: "example",
        roleIDs: ["example"],
        scopes: "example"
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation UpdateMember($updateMemberInput: UpdateMemberInput) { updateMember(updateMemberInput: $updateMemberInput) { userId roleIDs scopes } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "updateMemberInput": {
        "userId": "example",
        "roleIDs": ["example"],
        "scopes": "example"
      }
    }
  }
)

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

Arguments

You can use the following argument(s) to customize your updateMember mutation.

Argument	Description	Supported fields
updateMemberInput UpdateMemberInput		userId String! roleIDs [String] scopes String

Fields

Return type: UpdateMemberResponse

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

Field	Description	Supported fields
userId String!	user ID
roleIDs [String]	list of roles assigned for the user
scopes String	list of scopes assigned for the user as string