Skip to content
API Reference
/
/
clearOrganizationSSOConfi...

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

Mutations

Overview

deletePolicy

(id)
Boolean!,non-null

Delete a policy

Arguments

id
ID!,non-nullrequired

Return type

Boolean!

The Boolean scalar type represents true or false.

Mutation sample
mutation deletePolicy($id: ID!) {
  deletePolicy(id: $id) 
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": true
}

updateUser

(...args)
User!,non-null

Arguments

id
ID!,non-nullrequired
firstName
String!,non-nullrequired
lastName
String!,non-nullrequired
role
UserRole!,non-nullrequired

Return type

User!
id
ID!,non-null
firstName
String
lastName
String
email
String!,non-null
role
UserRole!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
status
UserStatus!,non-null
Mutation sample
mutation updateUser(
  $id: ID!
  $firstName: String!
  $lastName: String!
  $role: UserRole!
) {
  updateUser(
    id: $id
    firstName: $firstName
    lastName: $lastName
    role: $role
  ) {
    id 
    firstName 
    lastName 
    email 
    role 
    createdAt 
    updatedAt 
    status 
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "firstName": "Example String",
  "lastName": "Example String",
  "role": "ADMIN"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "firstName": "Example String",
    "lastName": "Example String",
    "email": "Example String",
    "role": "ADMIN",
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "status": "ENABLED"
  }
}

removeUserFromTenant

(id)
ID!,non-null

Arguments

id
ID!,non-nullrequired

Return type

ID!

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Mutation sample
mutation removeUserFromTenant($id: ID!) {
  removeUserFromTenant(id: $id) 
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

createUser

(...args)
User!,non-null

Arguments

email
String!,non-nullrequired
firstName
String!,non-nullrequired
lastName
String!,non-nullrequired
role
UserRole!,non-nullrequired

Return type

User!
id
ID!,non-null
firstName
String
lastName
String
email
String!,non-null
role
UserRole!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
status
UserStatus!,non-null
Mutation sample
mutation createUser(
  $email: String!
  $firstName: String!
  $lastName: String!
  $role: UserRole!
) {
  createUser(
    email: $email
    firstName: $firstName
    lastName: $lastName
    role: $role
  ) {
    id 
    firstName 
    lastName 
    email 
    role 
    createdAt 
    updatedAt 
    status 
  }
}
Variables
{
  "email": "Example String",
  "firstName": "Example String",
  "lastName": "Example String",
  "role": "ADMIN"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "firstName": "Example String",
    "lastName": "Example String",
    "email": "Example String",
    "role": "ADMIN",
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "status": "ENABLED"
  }
}

setOrganizationSSOConfiguration

(config)
OrganizationSSOConfiguration!,non-null

Configure SSO for an organization

Arguments

config
ConfigureSSOInput!,non-nullrequired

Return type

OrganizationSSOConfiguration!
enabled
Boolean!,non-null
values
OrganizationSSOConfigurationValues
Mutation sample
mutation setOrganizationSSOConfiguration($config: ConfigureSSOInput!) {
  setOrganizationSSOConfiguration(config: $config) {
    enabled 
    values {
      __typename
      # ...OrganizationSSOConfigurationValuesFragment
    }
  }
}
Variables
{
  "config": {
    "signInEndpoint": "Example String",
    "signingCertBase64": "Example String",
    "domains": [
      "Example String"
    ]
  }
}
Response sample
{
  "data": {
    "enabled": true,
    "values": {
      "__typename": "OrganizationSSOConfigurationValues"
    }
  }
}

clearOrganizationSSOConfiguration

OrganizationSSOConfiguration!,non-null

Clear SSO configuration for an organization

Return type

OrganizationSSOConfiguration!
enabled
Boolean!,non-null
values
OrganizationSSOConfigurationValues
Mutation sample
mutation clearOrganizationSSOConfiguration {
  clearOrganizationSSOConfiguration {
    enabled 
    values {
      __typename
      # ...OrganizationSSOConfigurationValuesFragment
    }
  }
}
Response sample
{
  "data": {
    "enabled": true,
    "values": {
      "__typename": "OrganizationSSOConfigurationValues"
    }
  }
}

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview