createInvitation

Will create a new invitation to the current Organization.

Examples

GraphQL

mutation CreateInvitation($invitationInfo: InvitationInput!) {
  createInvitation(invitationInfo: $invitationInfo) {
    id
    inviteeEmail
    invitation_url
    created_at
    expires_at
  }
}

Variables

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

{
  "invitationInfo": {
    "inviteeEmail": "[email protected]",
    "inviteeRoles": ["example"],
    "scopes": "example",
    "invitationTTLSec": 42
  }
}

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 CreateInvitation($invitationInfo: InvitationInput!) { createInvitation(invitationInfo: $invitationInfo) { id inviteeEmail invitation_url created_at expires_at } }",
 "variables": {
    "invitationInfo": {
      "inviteeEmail": "[email protected]",
      "inviteeRoles": ["example"],
      "scopes": "example",
      "invitationTTLSec": 42
    }
  }
}'

Node.js

const query = 'mutation CreateInvitation($invitationInfo: InvitationInput!) { createInvitation(invitationInfo: $invitationInfo) { id inviteeEmail invitation_url created_at expires_at } }';

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: {
      invitationInfo: {
        inviteeEmail: "[email protected]",
        inviteeRoles: ["example"],
        scopes: "example",
        invitationTTLSec: 42
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation CreateInvitation($invitationInfo: InvitationInput!) { createInvitation(invitationInfo: $invitationInfo) { id inviteeEmail invitation_url created_at expires_at } }'

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": {
      "invitationInfo": {
        "inviteeEmail": "[email protected]",
        "inviteeRoles": ["example"],
        "scopes": "example",
        "invitationTTLSec": 42
      }
    }
  }
)

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 createInvitation mutation.

Argument	Description	Supported fields
invitationInfo InvitationInput! required	Information required to create the invitation, including invitee email and roles	inviteeEmail String! inviteeRoles [String]! scopes String invitationTTLSec Int

Fields

Return type: Invitation

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

Field	Description	Supported fields
id String	Unique identifier for the invitation
inviteeEmail String	Email address of the person receiving the invitation
invitation_url String	Complete URL that the invitee can use to accept the invitation
created_at String	Timestamp when this invitation was created, in ISO 8601 format
expires_at String	Timestamp when this invitation will expire, in ISO 8601 format