Team management schema

service.team.graphqls

This API is available in Enterprise and AWS editions only.

To authenticate API requests, you’ll need an API token. Learn how to generate an access token.

See usage examples in the cloudbeaver-graphql-examples repository.

You can try queries in the built-in GraphQL console, available on your server at https://your-server-address/api/gql/console. This tool lets you test requests directly from your browser.

For a live example, see the demo GraphQL console.

API Endpoints
https://your-server-address/api/gql

Queries

msGetServiceConfiguration

Response

Returns a String!

Arguments
Name Description
type - MSServiceType!

Example

Query
query msGetServiceConfiguration($type: MSServiceType!) {
  msGetServiceConfiguration(type: $type)
}
Variables
{"type": "DOMAIN_CONTROLLER"}
Response
{
  "data": {
    "msGetServiceConfiguration": "<string>"
  }
}
Queries

msListServices

Response

Returns an MSServiceInfo

Example

Query
query msListServices {
  msListServices {
    id
    type
    endpoint
    nodes {
      ...MSServiceNodeFragment
    }
  }
}
Response
{
  "data": {
    "msListServices": {
      "id": "<string>",
      "type": "DOMAIN_CONTROLLER",
      "endpoint": "<string>",
      "nodes": [MSServiceNode]
    }
  }
}

Mutations

msSetServiceConfiguration

Response

Returns a String!

Arguments
Name Description
type - MSServiceType!
configuration - String!

Example

Query
mutation msSetServiceConfiguration(
  $type: MSServiceType!,
  $configuration: String!
) {
  msSetServiceConfiguration(
    type: $type,
    configuration: $configuration
  )
}
Variables
{"type": "DOMAIN_CONTROLLER", "configuration": "<string>"}
Response
{
  "data": {
    "msSetServiceConfiguration": "<string>"
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

MSServiceInfo

Fields
Field Name Description
id - String!
type - MSServiceType!
endpoint - String!
nodes - [MSServiceNode!]!
Example
{
  "id": "<string>",
  "type": "DOMAIN_CONTROLLER",
  "endpoint": "<string>",
  "nodes": [MSServiceNode]
}
Types

MSServiceNode

Fields
Field Name Description
location - String!
status - String!
Example
{"location": "<string>", "status": "<string>"}
Types

MSServiceType

Values
Enum Value Description

DOMAIN_CONTROLLER

CLOUDBEAVER

RESOURCE_MANAGER

QUERY_MANAGER
Example
"DOMAIN_CONTROLLER"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"<string>"
Documentation by Anvil SpectaQL