Administration API schema

service.admin.graphqls

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.

← Back to Available schemas

API Endpoints

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

Queries

addConnectionsAccess

Description

Sets access to the connections for the specified subjects (users and teams)

Response

Returns a Boolean

Arguments

Name	Description
projectId - ID!
connectionIds - [ID!]!
subjects - [ID!]!

Example

Query

query addConnectionsAccess(
  $projectId: ID!,
  $connectionIds: [ID!]!,
  $subjects: [ID!]!
) {
  addConnectionsAccess(
    projectId: $projectId,
    connectionIds: $connectionIds,
    subjects: $subjects
  )
}

Variables

{"projectId": "<id>", "connectionIds": "<id>", "subjects": "<id>"}

Response

{
  "data": {
    "addConnectionsAccess": "<boolean>"
  }
}

Queries

adminUserInfo

Description

Returns information about user by userId

Response

Returns an AdminUserInfo!

Arguments

Name	Description
userId - ID!

Example

Query

query adminUserInfo($userId: ID!) {
  adminUserInfo(userId: $userId) {
    userId
    metaParameters
    configurationParameters
    grantedTeams
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    origins {
      ...ObjectOriginFragment
    }
    linkedAuthProviders
    enabled
    authRole
    disableDate
    disabledBy
    disableReason
    lastLoginTime
  }
}

Variables

{"userId": "<id>"}

Response

{
  "data": {
    "adminUserInfo": {
      "userId": "<id>",
      "metaParameters": "<object>",
      "configurationParameters": "<object>",
      "grantedTeams": ["<id>"],
      "grantedConnections": [AdminConnectionGrantInfo],
      "origins": [ObjectOrigin],
      "linkedAuthProviders": ["<string>"],
      "enabled": "<boolean>",
      "authRole": "<string>",
      "disableDate": "<datetime>",
      "disabledBy": "<string>",
      "disableReason": "<string>",
      "lastLoginTime": "<datetime>"
    }
  }
}

Queries

configureServer

Description

Saves server configuration

Response

Returns a Boolean!

Arguments

Name	Description
configuration - ServerConfigInput!

Example

Query

query configureServer($configuration: ServerConfigInput!) {
  configureServer(configuration: $configuration)
}

Variables

{"configuration": ServerConfigInput}

Response

{"data": {"configureServer": "<boolean>"}}

Queries

createTeam

Description

Creates a new team with the specified teamId

Response

Returns an AdminTeamInfo!

Arguments

Name	Description
teamId - ID!
teamName - String
description - String

Example

Query

query createTeam(
  $teamId: ID!,
  $teamName: String,
  $description: String
) {
  createTeam(
    teamId: $teamId,
    teamName: $teamName,
    description: $description
  ) {
    teamId
    teamName
    description
    metaParameters
    grantedUsers
    grantedUsersInfo {
      ...AdminUserTeamGrantInfoFragment
    }
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    teamPermissions
  }
}

Variables

{"teamId": "<id>", "teamName": "<string>", "description": "<string>"}

Response

{
  "data": {
    "createTeam": {
      "teamId": "<id>",
      "teamName": "<string>",
      "description": "<string>",
      "metaParameters": "<object>",
      "grantedUsers": ["<id>"],
      "grantedUsersInfo": [AdminUserTeamGrantInfo],
      "grantedConnections": [AdminConnectionGrantInfo],
      "teamPermissions": ["<id>"]
    }
  }
}

Queries

createUser

Description

Creates a new user with the specified userId

Response

Returns an AdminUserInfo!

Arguments

Name	Description
userId - ID!
enabled - Boolean!
authRole - String

Example

Query

query createUser(
  $userId: ID!,
  $enabled: Boolean!,
  $authRole: String
) {
  createUser(
    userId: $userId,
    enabled: $enabled,
    authRole: $authRole
  ) {
    userId
    metaParameters
    configurationParameters
    grantedTeams
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    origins {
      ...ObjectOriginFragment
    }
    linkedAuthProviders
    enabled
    authRole
    disableDate
    disabledBy
    disableReason
    lastLoginTime
  }
}

Variables

{"userId": "<id>", "enabled": "<boolean>", "authRole": "<string>"}

Response

{
  "data": {
    "createUser": {
      "userId": "<id>",
      "metaParameters": "<object>",
      "configurationParameters": "<object>",
      "grantedTeams": ["<id>"],
      "grantedConnections": [AdminConnectionGrantInfo],
      "origins": [ObjectOrigin],
      "linkedAuthProviders": ["<string>"],
      "enabled": "<boolean>",
      "authRole": "<string>",
      "disableDate": "<datetime>",
      "disabledBy": "<string>",
      "disableReason": "<string>",
      "lastLoginTime": "<datetime>"
    }
  }
}

Queries

deleteAuthProviderConfiguration

Description

Deletes auth provider configuration by id

Response

Returns a Boolean!

Arguments

Name	Description
id - ID!

Example

Query

query deleteAuthProviderConfiguration($id: ID!) {
  deleteAuthProviderConfiguration(id: $id)
}

Variables

{"id": "<id>"}

Response

{
  "data": {
    "deleteAuthProviderConfiguration": "<boolean>"
  }
}

Queries

deleteConnectionsAccess

Description

Deletes access to the connections for the specified subjects (users and teams)

Response

Returns a Boolean

Arguments

Name	Description
projectId - ID!
connectionIds - [ID!]!
subjects - [ID!]!

Example

Query

query deleteConnectionsAccess(
  $projectId: ID!,
  $connectionIds: [ID!]!,
  $subjects: [ID!]!
) {
  deleteConnectionsAccess(
    projectId: $projectId,
    connectionIds: $connectionIds,
    subjects: $subjects
  )
}

Variables

{"projectId": "<id>", "connectionIds": "<id>", "subjects": "<id>"}

Response

{
  "data": {
    "deleteConnectionsAccess": "<boolean>"
  }
}

Queries

deleteTeam

Description

Deletes team by teamId

Response

Returns a Boolean

Arguments

Name	Description
teamId - ID!
force - Boolean

Example

Query

query deleteTeam(
  $teamId: ID!,
  $force: Boolean
) {
  deleteTeam(
    teamId: $teamId,
    force: $force
  )
}

Variables

{"teamId": "<id>", "force": "<boolean>"}

Response

{"data": {"deleteTeam": "<boolean>"}}

Queries

deleteUser

Description

Deletes user by userId

Response

Returns a Boolean

Arguments

Name	Description
userId - ID!

Example

Query

query deleteUser($userId: ID!) {
  deleteUser(userId: $userId)
}

Variables

{"userId": "<id>"}

Response

{"data": {"deleteUser": "<boolean>"}}

Queries

deleteUserCredentials

Description

Deletes user credentials for the specified userId and providerId

Response

Returns a Boolean

Arguments

Name	Description
userId - ID!
providerId - ID!

Example

Query

query deleteUserCredentials(
  $userId: ID!,
  $providerId: ID!
) {
  deleteUserCredentials(
    userId: $userId,
    providerId: $providerId
  )
}

Variables

{"userId": "<id>", "providerId": "<id>"}

Response

{
  "data": {
    "deleteUserCredentials": "<boolean>"
  }
}

Queries

deleteUserMetaParameter

Description

Not implemented yet

Response

Returns a Boolean!

Arguments

Name	Description
id - ID!

Example

Query

query deleteUserMetaParameter($id: ID!) {
  deleteUserMetaParameter(id: $id)
}

Variables

{"id": "<id>"}

Response

{
  "data": {
    "deleteUserMetaParameter": "<boolean>"
  }
}

Queries

enableUser

Description

Enables or disables user by userId

Response

Returns a Boolean

Arguments

Name	Description
userId - ID!
enabled - Boolean!

Example

Query

query enableUser(
  $userId: ID!,
  $enabled: Boolean!
) {
  enableUser(
    userId: $userId,
    enabled: $enabled
  )
}

Variables

{"userId": "<id>", "enabled": "<boolean>"}

Response

{"data": {"enableUser": "<boolean>"}}

Queries

getConnectionSubjectAccess

Description

Returns all subjects (users and teams) that have access to the specified connection

Response

Returns [AdminConnectionGrantInfo!]!

Arguments

Name	Description
projectId - ID!
connectionId - ID

Example

Query

query getConnectionSubjectAccess(
  $projectId: ID!,
  $connectionId: ID
) {
  getConnectionSubjectAccess(
    projectId: $projectId,
    connectionId: $connectionId
  ) {
    connectionId
    dataSourceId
    subjectId
    subjectType
  }
}

Variables

{"projectId": "<id>", "connectionId": "<id>"}

Response

{
  "data": {
    "getConnectionSubjectAccess": [
      {
        "connectionId": "<id>",
        "dataSourceId": "<id>",
        "subjectId": "<id>",
        "subjectType": "user"
      }
    ]
  }
}

Queries

getSubjectConnectionAccess

Description

Returns all connections that the subject (user or team) has access to

Response

Returns [AdminConnectionGrantInfo!]!

Arguments

Name	Description
subjectId - ID!

Example

Query

query getSubjectConnectionAccess($subjectId: ID!) {
  getSubjectConnectionAccess(subjectId: $subjectId) {
    connectionId
    dataSourceId
    subjectId
    subjectType
  }
}

Variables

{"subjectId": "<id>"}

Response

{
  "data": {
    "getSubjectConnectionAccess": [
      {
        "connectionId": "<id>",
        "dataSourceId": "<id>",
        "subjectId": "<id>",
        "subjectType": "user"
      }
    ]
  }
}

Queries

grantUserTeam

Description

Grants user to team with the specified userId and teamId

Response

Returns a Boolean

Arguments

Name	Description
userId - ID!
teamId - ID!

Example

Query

query grantUserTeam(
  $userId: ID!,
  $teamId: ID!
) {
  grantUserTeam(
    userId: $userId,
    teamId: $teamId
  )
}

Variables

{"userId": "<id>", "teamId": "<id>"}

Response

{"data": {"grantUserTeam": "<boolean>"}}

Queries

listAuthProviderConfigurationParameters

Description

Returns all properties of the auth provider with the specified providerId

Response

Returns [ObjectPropertyInfo!]!

Arguments

Name	Description
providerId - ID!

Example

Query

query listAuthProviderConfigurationParameters($providerId: ID!) {
  listAuthProviderConfigurationParameters(providerId: $providerId) {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}

Variables

{"providerId": "<id>"}

Response

{
  "data": {
    "listAuthProviderConfigurationParameters": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "hint": "<string>",
        "category": "<string>",
        "dataType": "<string>",
        "value": "<object>",
        "validValues": ["<object>"],
        "defaultValue": "<object>",
        "length": "TINY",
        "features": ["<string>"],
        "order": "<int>",
        "supportedConfigurationTypes": ["<string>"],
        "required": "<boolean>",
        "scopes": ["<string>"],
        "conditions": [Condition]
      }
    ]
  }
}

Queries

listAuthProviderConfigurations

Description

Returns all auth provider configurations for the specified providerId. If providerId is not provided, returns all configurations

Response

Returns [AdminAuthProviderConfiguration!]!

Arguments

Name	Description
providerId - ID

Example

Query

query listAuthProviderConfigurations($providerId: ID) {
  listAuthProviderConfigurations(providerId: $providerId) {
    providerId
    id
    displayName
    disabled
    iconURL
    description
    parameters
    signInLink
    signOutLink
    redirectLink
    metadataLink
    acsLink
    entityIdLink
  }
}

Variables

{"providerId": "<id>"}

Response

{
  "data": {
    "listAuthProviderConfigurations": [
      {
        "providerId": "<id>",
        "id": "<id>",
        "displayName": "<string>",
        "disabled": "<boolean>",
        "iconURL": "<string>",
        "description": "<string>",
        "parameters": "<object>",
        "signInLink": "<string>",
        "signOutLink": "<string>",
        "redirectLink": "<string>",
        "metadataLink": "<string>",
        "acsLink": "<string>",
        "entityIdLink": "<string>"
      }
    ]
  }
}

Queries

listAuthRoles

Description

Returns all auth roles based on the license

Response

Returns [String!]!

Example

Query

query listAuthRoles {
  listAuthRoles
}

Response

{"data": {"listAuthRoles": ["<string>"]}}

Queries

listFeatureSets

Description

Returns all available feature sets that can be enabled or disabled

Response

Returns [WebFeatureSet!]!

Example

Query

query listFeatureSets {
  listFeatureSets {
    id
    label
    description
    icon
    enabled
  }
}

Response

{
  "data": {
    "listFeatureSets": [
      {
        "id": "<string>",
        "label": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "enabled": "<boolean>"
      }
    ]
  }
}

Queries

listPermissions

Description

Returns all permissions

Response

Returns [AdminPermissionInfo!]!

Example

Query

query listPermissions {
  listPermissions {
    id
    label
    description
    provider
    category
  }
}

Response

{
  "data": {
    "listPermissions": [
      {
        "id": "<id>",
        "label": "<string>",
        "description": "<string>",
        "provider": "<string>",
        "category": "<string>"
      }
    ]
  }
}

Queries

listTeamMetaParameters

Description

Returns teams meta parameters for displaying in the UI

Response

Returns [ObjectPropertyInfo!]!

Example

Query

query listTeamMetaParameters {
  listTeamMetaParameters {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}

Response

{
  "data": {
    "listTeamMetaParameters": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "hint": "<string>",
        "category": "<string>",
        "dataType": "<string>",
        "value": "<object>",
        "validValues": ["<object>"],
        "defaultValue": "<object>",
        "length": "TINY",
        "features": ["<string>"],
        "order": "<int>",
        "supportedConfigurationTypes": ["<string>"],
        "required": "<boolean>",
        "scopes": ["<string>"],
        "conditions": [Condition]
      }
    ]
  }
}

Queries

listTeamRoles

Description

Returns all team roles

Response

Returns [String!]!

Example

Query

query listTeamRoles {
  listTeamRoles
}

Response

{"data": {"listTeamRoles": ["<string>"]}}

Queries

listTeams

Description

Returns information about team by teamId. If teamId is not provided, returns information about all teams

Response

Returns [AdminTeamInfo!]!

Arguments

Name	Description
teamId - ID

Example

Query

query listTeams($teamId: ID) {
  listTeams(teamId: $teamId) {
    teamId
    teamName
    description
    metaParameters
    grantedUsers
    grantedUsersInfo {
      ...AdminUserTeamGrantInfoFragment
    }
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    teamPermissions
  }
}

Variables

{"teamId": "<id>"}

Response

{
  "data": {
    "listTeams": [
      {
        "teamId": "<id>",
        "teamName": "<string>",
        "description": "<string>",
        "metaParameters": "<object>",
        "grantedUsers": ["<id>"],
        "grantedUsersInfo": [AdminUserTeamGrantInfo],
        "grantedConnections": [AdminConnectionGrantInfo],
        "teamPermissions": ["<id>"]
      }
    ]
  }
}

Queries

listUsers

Description

Returns all users with pagination and filter

Response

Returns [AdminUserInfo!]!

Arguments

Name	Description
page - PageInput!
filter - AdminUserFilterInput!

Example

Query

query listUsers(
  $page: PageInput!,
  $filter: AdminUserFilterInput!
) {
  listUsers(
    page: $page,
    filter: $filter
  ) {
    userId
    metaParameters
    configurationParameters
    grantedTeams
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    origins {
      ...ObjectOriginFragment
    }
    linkedAuthProviders
    enabled
    authRole
    disableDate
    disabledBy
    disableReason
    lastLoginTime
  }
}

Variables

{
  "page": PageInput,
  "filter": AdminUserFilterInput
}

Response

{
  "data": {
    "listUsers": [
      {
        "userId": "<id>",
        "metaParameters": "<object>",
        "configurationParameters": "<object>",
        "grantedTeams": ["<id>"],
        "grantedConnections": [AdminConnectionGrantInfo],
        "origins": [ObjectOrigin],
        "linkedAuthProviders": ["<string>"],
        "enabled": "<boolean>",
        "authRole": "<string>",
        "disableDate": "<datetime>",
        "disabledBy": "<string>",
        "disableReason": "<string>",
        "lastLoginTime": "<datetime>"
      }
    ]
  }
}

Queries

revokeUserTeam

Description

Revokes user from team with the specified userId and teamId

Response

Returns a Boolean

Arguments

Name	Description
userId - ID!
teamId - ID!

Example

Query

query revokeUserTeam(
  $userId: ID!,
  $teamId: ID!
) {
  revokeUserTeam(
    userId: $userId,
    teamId: $teamId
  )
}

Variables

{"userId": "<id>", "teamId": "<id>"}

Response

{"data": {"revokeUserTeam": "<boolean>"}}

Queries

saveAuthProviderConfiguration

Description

Saves auth provider configuration with the specified parameters

Response

Returns an AdminAuthProviderConfiguration!

Arguments

Name	Description
providerId - ID!
id - ID!
displayName - String
disabled - Boolean
iconURL - String
description - String
parameters - Object

Example

Query

query saveAuthProviderConfiguration(
  $providerId: ID!,
  $id: ID!,
  $displayName: String,
  $disabled: Boolean,
  $iconURL: String,
  $description: String,
  $parameters: Object
) {
  saveAuthProviderConfiguration(
    providerId: $providerId,
    id: $id,
    displayName: $displayName,
    disabled: $disabled,
    iconURL: $iconURL,
    description: $description,
    parameters: $parameters
  ) {
    providerId
    id
    displayName
    disabled
    iconURL
    description
    parameters
    signInLink
    signOutLink
    redirectLink
    metadataLink
    acsLink
    entityIdLink
  }
}

Variables

{
  "providerId": "<id>",
  "id": "<id>",
  "displayName": "<string>",
  "disabled": "<boolean>",
  "iconURL": "<string>",
  "description": "<string>",
  "parameters": "<object>"
}

Response

{
  "data": {
    "saveAuthProviderConfiguration": {
      "providerId": "<id>",
      "id": "<id>",
      "displayName": "<string>",
      "disabled": "<boolean>",
      "iconURL": "<string>",
      "description": "<string>",
      "parameters": "<object>",
      "signInLink": "<string>",
      "signOutLink": "<string>",
      "redirectLink": "<string>",
      "metadataLink": "<string>",
      "acsLink": "<string>",
      "entityIdLink": "<string>"
    }
  }
}

Queries

saveUserMetaParameter

Description

Not implemented yet

Response

Returns an ObjectPropertyInfo!

Arguments

Name	Description
id - ID!
displayName - String!
description - String
required - Boolean!

Example

Query

query saveUserMetaParameter(
  $id: ID!,
  $displayName: String!,
  $description: String,
  $required: Boolean!
) {
  saveUserMetaParameter(
    id: $id,
    displayName: $displayName,
    description: $description,
    required: $required
  ) {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}

Variables

{
  "id": "<id>",
  "displayName": "<string>",
  "description": "<string>",
  "required": "<boolean>"
}

Response

{
  "data": {
    "saveUserMetaParameter": {
      "id": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "hint": "<string>",
      "category": "<string>",
      "dataType": "<string>",
      "value": "<object>",
      "validValues": ["<object>"],
      "defaultValue": "<object>",
      "length": "TINY",
      "features": ["<string>"],
      "order": "<int>",
      "supportedConfigurationTypes": ["<string>"],
      "required": "<boolean>",
      "scopes": ["<string>"],
      "conditions": [Condition]
    }
  }
}

Queries

searchConnections

Description

Finds available connections by host names

Response

Returns [AdminConnectionSearchInfo!]!

Arguments

Name	Description
hostNames - [String!]!

Example

Query

query searchConnections($hostNames: [String!]!) {
  searchConnections(hostNames: $hostNames) {
    displayName
    host
    port
    possibleDrivers
    defaultDriver
  }
}

Variables

{"hostNames": "<string>"}

Response

{
  "data": {
    "searchConnections": [
      {
        "displayName": "<string>",
        "host": "<string>",
        "port": "<int>",
        "possibleDrivers": ["<id>"],
        "defaultDriver": "<id>"
      }
    ]
  }
}

Queries

setConnectionSubjectAccess

use addConnectionsAccess (23.2.2)

Description

Sets access to the connection for the specified subjects (users and teams)

Response

Returns a Boolean

Arguments

Name	Description
projectId - ID!
connectionId - ID!
subjects - [ID!]!

Example

Query

query setConnectionSubjectAccess(
  $projectId: ID!,
  $connectionId: ID!,
  $subjects: [ID!]!
) {
  setConnectionSubjectAccess(
    projectId: $projectId,
    connectionId: $connectionId,
    subjects: $subjects
  )
}

Variables

{"projectId": "<id>", "connectionId": "<id>", "subjects": "<id>"}

Response

{
  "data": {
    "setConnectionSubjectAccess": "<boolean>"
  }
}

Queries

setDefaultNavigatorSettings

Description

Changes default navigator settings

Response

Returns a Boolean!

Arguments

Name	Description
settings - NavigatorSettingsInput!

Example

Query

query setDefaultNavigatorSettings($settings: NavigatorSettingsInput!) {
  setDefaultNavigatorSettings(settings: $settings)
}

Variables

{"settings": NavigatorSettingsInput}

Response

{
  "data": {
    "setDefaultNavigatorSettings": "<boolean>"
  }
}

Queries

setSubjectConnectionAccess

23.2.2

Description

Sets access for a subject (user or team) to the specified connections

Response

Returns a Boolean

Arguments

Name	Description
subjectId - ID!
connections - [ID!]!

Example

Query

query setSubjectConnectionAccess(
  $subjectId: ID!,
  $connections: [ID!]!
) {
  setSubjectConnectionAccess(
    subjectId: $subjectId,
    connections: $connections
  )
}

Variables

{"subjectId": "<id>", "connections": "<id>"}

Response

{
  "data": {
    "setSubjectConnectionAccess": "<boolean>"
  }
}

Queries

setSubjectPermissions

Description

Sets permissions to the subject (user or team) with the specified subjectId

Response

Returns [AdminPermissionInfo!]!

Arguments

Name	Description
subjectId - ID!
permissions - [ID!]!

Example

Query

query setSubjectPermissions(
  $subjectId: ID!,
  $permissions: [ID!]!
) {
  setSubjectPermissions(
    subjectId: $subjectId,
    permissions: $permissions
  ) {
    id
    label
    description
    provider
    category
  }
}

Variables

{"subjectId": "<id>", "permissions": "<id>"}

Response

{
  "data": {
    "setSubjectPermissions": [
      {
        "id": "<id>",
        "label": "<string>",
        "description": "<string>",
        "provider": "<string>",
        "category": "<string>"
      }
    ]
  }
}

Queries

setTeamMetaParameterValues

Description

Sets team meta parameters values for the specified teamId

Response

Returns a Boolean!

Arguments

Name	Description
teamId - ID!
parameters - Object!

Example

Query

query setTeamMetaParameterValues(
  $teamId: ID!,
  $parameters: Object!
) {
  setTeamMetaParameterValues(
    teamId: $teamId,
    parameters: $parameters
  )
}

Variables

{"teamId": "<id>", "parameters": "<object>"}

Response

{
  "data": {
    "setTeamMetaParameterValues": "<boolean>"
  }
}

Queries

setUserAuthRole

Description

Sets user auth role for the specified userId

Response

Returns a Boolean

Arguments

Name	Description
userId - ID!
authRole - String

Example

Query

query setUserAuthRole(
  $userId: ID!,
  $authRole: String
) {
  setUserAuthRole(
    userId: $userId,
    authRole: $authRole
  )
}

Variables

{"userId": "<id>", "authRole": "<string>"}

Response

{"data": {"setUserAuthRole": "<boolean>"}}

Queries

setUserCredentials

Description

Sets user credentials for the specified userId and providerId

Response

Returns a Boolean

Arguments

Name	Description
userId - ID!
providerId - ID!
credentials - Object!

Example

Query

query setUserCredentials(
  $userId: ID!,
  $providerId: ID!,
  $credentials: Object!
) {
  setUserCredentials(
    userId: $userId,
    providerId: $providerId,
    credentials: $credentials
  )
}

Variables

{"userId": "<id>", "providerId": "<id>", "credentials": "<object>"}

Response

{
  "data": {
    "setUserCredentials": "<boolean>"
  }
}

Queries

setUserMetaParameterValues

Description

Sets user meta parameters values for the specified userId

Response

Returns a Boolean!

Arguments

Name	Description
userId - ID!
parameters - Object!

Example

Query

query setUserMetaParameterValues(
  $userId: ID!,
  $parameters: Object!
) {
  setUserMetaParameterValues(
    userId: $userId,
    parameters: $parameters
  )
}

Variables

{"userId": "<id>", "parameters": "<object>"}

Response

{
  "data": {
    "setUserMetaParameterValues": "<boolean>"
  }
}

Queries

setUserTeamRole

Description

Sets user team role for the specified userId and teamId

Response

Returns a Boolean

Arguments

Name	Description
userId - ID!
teamId - ID!
teamRole - String

Example

Query

query setUserTeamRole(
  $userId: ID!,
  $teamId: ID!,
  $teamRole: String
) {
  setUserTeamRole(
    userId: $userId,
    teamId: $teamId,
    teamRole: $teamRole
  )
}

Variables

{"userId": "<id>", "teamId": "<id>", "teamRole": "<string>"}

Response

{"data": {"setUserTeamRole": "<boolean>"}}

Queries

updateTeam

Description

Updates team information by teamId

Response

Returns an AdminTeamInfo!

Arguments

Name	Description
teamId - ID!
teamName - String
description - String

Example

Query

query updateTeam(
  $teamId: ID!,
  $teamName: String,
  $description: String
) {
  updateTeam(
    teamId: $teamId,
    teamName: $teamName,
    description: $description
  ) {
    teamId
    teamName
    description
    metaParameters
    grantedUsers
    grantedUsersInfo {
      ...AdminUserTeamGrantInfoFragment
    }
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    teamPermissions
  }
}

Variables

{"teamId": "<id>", "teamName": "<string>", "description": "<string>"}

Response

{
  "data": {
    "updateTeam": {
      "teamId": "<id>",
      "teamName": "<string>",
      "description": "<string>",
      "metaParameters": "<object>",
      "grantedUsers": ["<id>"],
      "grantedUsersInfo": [AdminUserTeamGrantInfo],
      "grantedConnections": [AdminConnectionGrantInfo],
      "teamPermissions": ["<id>"]
    }
  }
}

Mutations

adminUpdateProductConfiguration

Description

Updates product configuration

Response

Returns a Boolean!

Arguments

Name	Description
configuration - Object!

Example

Query

mutation adminUpdateProductConfiguration($configuration: Object!) {
  adminUpdateProductConfiguration(configuration: $configuration)
}

Variables

{"configuration": "<object>"}

Response

{
  "data": {
    "adminUpdateProductConfiguration": "<boolean>"
  }
}

Types

AdminAuthProviderConfiguration

Description

Authentication provider configuration

Fields

Field Name	Description
providerId - ID!	Authentication provider identifier
id - ID!	Provider configuration identifier
displayName - String!	Configuration display name
disabled - Boolean!	Flag indicating whether the configuration is disabled
iconURL - String	Provider icon URL
description - String	Configuration description
parameters - Object!	Provider configuration parameters
signInLink - String	Sign-in link (Single Sign-On, etc.)
signOutLink - String	Sign-out link
redirectLink - String	Redirect URI
metadataLink - String	Metadata link for the provider
acsLink - String	ACS (Assertion Consumer Service) link for SSO
entityIdLink - String	Entity ID link for the provider

Example

{
  "providerId": "<id>",
  "id": "<id>",
  "displayName": "<string>",
  "disabled": "<boolean>",
  "iconURL": "<string>",
  "description": "<string>",
  "parameters": "<object>",
  "signInLink": "<string>",
  "signOutLink": "<string>",
  "redirectLink": "<string>",
  "metadataLink": "<string>",
  "acsLink": "<string>",
  "entityIdLink": "<string>"
}

Types

AdminConnectionGrantInfo

Description

Information about connection access rights for a subject (user or team)

Fields

Field Name	Description
connectionId - ID!	Connection identifier use dataSourceId instead
dataSourceId - ID!	Data source (connection) identifier
subjectId - ID!	Subject identifier (user or team)
subjectType - AdminSubjectType!	Subject type (user or team)

Example

{
  "connectionId": "<id>",
  "dataSourceId": "<id>",
  "subjectId": "<id>",
  "subjectType": "user"
}

Types

AdminConnectionSearchInfo

Description

Result of searching for available connections by host

Fields

Field Name	Description
displayName - String!	Connection display name
host - String!	Connection host
port - Int!	Connection port
possibleDrivers - [ID!]!	List of possible drivers for the connection
defaultDriver - ID!	Default driver

Example

{
  "displayName": "<string>",
  "host": "<string>",
  "port": "<int>",
  "possibleDrivers": ["<id>"],
  "defaultDriver": "<id>"
}

Types

AdminPermissionInfo

Description

Information about a permission

Fields

Field Name	Description
id - ID!	Permission identifier
label - String	Human readable permission label
description - String	Permission description
provider - String!	Provider that owns the permission
category - String	Permission category

Example

{
  "id": "<id>",
  "label": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "category": "<string>"
}

Types

AdminSubjectType

Description

Describes the type of the administrative subject (user or team)

Values

Enum Value	Description
user	User
team	Team

Example

"user"

Types

AdminTeamInfo

Description

Team information for the admin interface

Fields

Field Name	Description
teamId - ID!	Team identifier
teamName - String	Team display name
description - String	Team description
metaParameters - Object!	Team custom meta parameters
grantedUsers - [ID!]!	List of user identifiers that belong to the team
grantedUsersInfo - [AdminUserTeamGrantInfo!]!	Detailed information about users and their roles in the team
grantedConnections - [AdminConnectionGrantInfo!]!	List of connections assigned to this team
teamPermissions - [ID!]!	List of permissions assigned to the team

Example

{
  "teamId": "<id>",
  "teamName": "<string>",
  "description": "<string>",
  "metaParameters": "<object>",
  "grantedUsers": ["<id>"],
  "grantedUsersInfo": [AdminUserTeamGrantInfo],
  "grantedConnections": [AdminConnectionGrantInfo],
  "teamPermissions": ["<id>"]
}

Types

AdminUserFilterInput

Description

Filter input for searching users in the admin interface

Fields

Input Field	Description
userIdMask - String	User identifier mask
enabledState - Boolean	Filter by enabled/disabled state

Example

{"userIdMask": "<string>", "enabledState": "<boolean>"}

Types

AdminUserInfo

Description

Extended user information for the admin interface

Fields

Field Name	Description
userId - ID!	User identifier
metaParameters - Object!	User custom meta parameters
configurationParameters - Object!	User configuration parameters
grantedTeams - [ID!]!	List of teams the user belongs to
grantedConnections - [AdminConnectionGrantInfo!]!	List of connections the user has access to
origins - [ObjectOrigin!]!	Origins from which the user was created or loaded
linkedAuthProviders - [String!]!	List of linked authentication providers
enabled - Boolean!	Whether the user is enabled
authRole - String	User authentication role
disableDate - DateTime	Date when the user was disabled
disabledBy - String	Who disabled the user
disableReason - String	Reason why the user was disabled
lastLoginTime - DateTime	Date of the user's last successful login

Example

{
  "userId": "<id>",
  "metaParameters": "<object>",
  "configurationParameters": "<object>",
  "grantedTeams": ["<id>"],
  "grantedConnections": [AdminConnectionGrantInfo],
  "origins": [ObjectOrigin],
  "linkedAuthProviders": ["<string>"],
  "enabled": "<boolean>",
  "authRole": "<string>",
  "disableDate": "<datetime>",
  "disabledBy": "<string>",
  "disableReason": "<string>",
  "lastLoginTime": "<datetime>"
}

Types

AdminUserTeamGrantInfo

Description

Information about the user's role in a team

Fields

Field Name	Description
userId - ID!	User identifier
teamRole - String	User role in the team

Example

{"userId": "<id>", "teamRole": "<string>"}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

"<boolean>"

Types

Condition

Description

Represents a dynamic condition for a property, such as visibility or read-only state

Fields

Field Name	Description
expression - String!	The logical expression that defines when the condition applies
conditionType - ConditionType!	The type of condition (e.g., HIDE or READ_ONLY)

Example

{"expression": "<string>", "conditionType": "HIDE"}

Types

ConditionType

Values

Enum Value	Description
HIDE	hiding property condition
READ_ONLY	restriction for setting a property value

Example

"HIDE"

Types

DateTime

Description

Date/Time

Example

"<datetime>"

Types

ID

Description

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.

Example

"<id>"

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

"<int>"

Types

NavigatorSettingsInput

Fields

Input Field	Description
showSystemObjects - Boolean!
showUtilityObjects - Boolean!
showOnlyEntities - Boolean!
mergeEntities - Boolean!
hideFolders - Boolean!
hideSchemas - Boolean!
hideVirtualModel - Boolean!
userSettings - Boolean

Example

{
  "showSystemObjects": "<boolean>",
  "showUtilityObjects": "<boolean>",
  "showOnlyEntities": "<boolean>",
  "mergeEntities": "<boolean>",
  "hideFolders": "<boolean>",
  "hideSchemas": "<boolean>",
  "hideVirtualModel": "<boolean>",
  "userSettings": "<boolean>"
}

Types

Object

Description

Any object (JSON)

Example

"<object>"

Types

ObjectOrigin

Fields

Field Name	Description
type - ID!
subType - ID
displayName - String!
icon - String
configuration - Object
details - [ObjectPropertyInfo!]

Example

{
  "type": "<id>",
  "subType": "<id>",
  "displayName": "<string>",
  "icon": "<string>",
  "configuration": "<object>",
  "details": [ObjectPropertyInfo]
}

Types

ObjectPropertyInfo

Description

Information about the object property used to generate its UI

Fields

Field Name	Description
id - String	Unique property identifier
displayName - String	Human-readable name
description - String	Property description
hint - String	Usage hint for the property
category - String	Property category (may be used if object has a lot of properties)
dataType - String	Property data type (e.g., int, String)
value - Object	Property value (can be resource-intensive for some properties, e.g., RowCount for tables)
validValues - [Object]	List of allowed values (for enumerable properties)
defaultValue - Object	Default property value
length - ObjectPropertyLength!	Property value length
features - [String!]!	List of supported features (e.g., system, hidden, inherited, foreign, expensive)
order - Int!	Order position
supportedConfigurationTypes - [String!]	Supported configuration types (for driver properties)
required - Boolean!	Is the property required
scopes - [String!]	List of preference scopes (e.g., global, user)
conditions - [Condition!]	Dynamic conditions for the property (e.g., visibility or read-only)

Example

{
  "id": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "hint": "<string>",
  "category": "<string>",
  "dataType": "<string>",
  "value": "<object>",
  "validValues": ["<object>"],
  "defaultValue": "<object>",
  "length": "TINY",
  "features": ["<string>"],
  "order": "<int>",
  "supportedConfigurationTypes": ["<string>"],
  "required": "<boolean>",
  "scopes": ["<string>"],
  "conditions": [Condition]
}

Types

ObjectPropertyLength

Values

Enum Value	Description
TINY	1 character
SHORT	20 characters
MEDIUM	<= 64 characters
LONG	Full line length. The default
MULTILINE	Multi-line long text

Example

"TINY"

Types

PageInput

Fields

Input Field	Description
limit - Int
offset - Int

Example

{"limit": "<int>", "offset": "<int>"}

Types

ServerConfigInput

Description

Input parameters for server configuration

Fields

Input Field	Description
serverName - String	Server display name
adminName - String	Default administrator name
adminPassword - String	Default administrator password
anonymousAccessEnabled - Boolean	Whether anonymous access is enabled
customConnectionsEnabled - Boolean	Whether private connections can be created
publicCredentialsSaveEnabled - Boolean	Whether saving public credentials is allowed
adminCredentialsSaveEnabled - Boolean	Whether saving credentials is allowed
resourceManagerEnabled - Boolean	Whether the resource manager is enabled
secretManagerEnabled - Boolean	Whether the secret manager is enabled
enabledFeatures - [ID!]	Enabled feature sets
enabledAuthProviders - [ID!]	Enabled authentication providers
disabledDrivers - [ID!]	Disabled drivers
sessionExpireTime - Int	Session lifetime
forceHttps - Boolean	Force HTTPS usage
supportedHosts - [String!]	Supported hosts for accessing the server
bindSessionToIp - String	Bind session to client IP address

Example

{
  "serverName": "<string>",
  "adminName": "<string>",
  "adminPassword": "<string>",
  "anonymousAccessEnabled": "<boolean>",
  "customConnectionsEnabled": "<boolean>",
  "publicCredentialsSaveEnabled": "<boolean>",
  "adminCredentialsSaveEnabled": "<boolean>",
  "resourceManagerEnabled": "<boolean>",
  "secretManagerEnabled": "<boolean>",
  "enabledFeatures": ["<id>"],
  "enabledAuthProviders": ["<id>"],
  "disabledDrivers": ["<id>"],
  "sessionExpireTime": "<int>",
  "forceHttps": "<boolean>",
  "supportedHosts": ["<string>"],
  "bindSessionToIp": "<string>"
}

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>"

Types

WebFeatureSet

Description

Set of web UI features

Fields

Field Name	Description
id - String!	Feature set identifier
label - String!	Feature set display name
description - String	Feature set description
icon - String	Feature set icon
enabled - Boolean!	Whether the feature set is enabled

Example

{
  "id": "<string>",
  "label": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "enabled": "<boolean>"
}

Documentation by Anvil SpectaQL