Secret management schema

service.secret.manager.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

deleteSecretConfiguration

Description

Deletes a secret configuration by its ID. Returns true if the deletion was successful.

Response

Returns a Boolean!

Arguments
Name Description
configurationId - ID!

Example

Query
query deleteSecretConfiguration($configurationId: ID!) {
  deleteSecretConfiguration(configurationId: $configurationId)
}
Variables
{"configurationId": "<id>"}
Response
{
  "data": {
    "deleteSecretConfiguration": "<boolean>"
  }
}
Queries

getSecretManagerConfigurationParameters

Description

Returns a list of secret configuration properties for a specific provider that can be used to create a new secret configuration.

Response

Returns [ObjectPropertyInfo!]!

Arguments
Name Description
providerId - ID!

Example

Query
query getSecretManagerConfigurationParameters($providerId: ID!) {
  getSecretManagerConfigurationParameters(providerId: $providerId) {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Variables
{"providerId": "<id>"}
Response
{
  "data": {
    "getSecretManagerConfigurationParameters": [
      {
        "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

saveSecretConfiguration

Description

Saves a new secret configuration or updates an existing one. Returns the saved secret configuration.

Response

Returns a SecretConfiguration!

Arguments
Name Description
secretConfigurationParameters - SecretConfigurationInput!

Example

Query
query saveSecretConfiguration($secretConfigurationParameters: SecretConfigurationInput!) {
  saveSecretConfiguration(secretConfigurationParameters: $secretConfigurationParameters) {
    configurationId
    configurationName
    providerId
    description
    parameters {
      ...ObjectPropertyInfoFragment
    }
  }
}
Variables
{
  "secretConfigurationParameters": SecretConfigurationInput
}
Response
{
  "data": {
    "saveSecretConfiguration": {
      "configurationId": "<string>",
      "configurationName": "<string>",
      "providerId": "<string>",
      "description": "<string>",
      "parameters": [ObjectPropertyInfo]
    }
  }
}
Queries

secretManagementList

Description

Returns a list of secret management configurations.

Response

Returns [SecretManagementInfo!]!

Example

Query
query secretManagementList {
  secretManagementList {
    id
    label
    description
    configurationId
    configurationName
  }
}
Response
{
  "data": {
    "secretManagementList": [
      {
        "id": "<string>",
        "label": "<string>",
        "description": "<string>",
        "configurationId": "<string>",
        "configurationName": "<string>"
      }
    ]
  }
}
Queries

secretProviderConfiguration

Description

Returns a list of secret configurations for a specific provider by its ID.

Response

Returns [SecretConfiguration!]!

Arguments
Name Description
configurationId - ID

Example

Query
query secretProviderConfiguration($configurationId: ID) {
  secretProviderConfiguration(configurationId: $configurationId) {
    configurationId
    configurationName
    providerId
    description
    parameters {
      ...ObjectPropertyInfoFragment
    }
  }
}
Variables
{"configurationId": "<id>"}
Response
{
  "data": {
    "secretProviderConfiguration": [
      {
        "configurationId": "<string>",
        "configurationName": "<string>",
        "providerId": "<string>",
        "description": "<string>",
        "parameters": [ObjectPropertyInfo]
      }
    ]
  }
}

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

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

Object

Description

Any object (JSON)

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

SecretConfiguration

Fields
Field Name Description
configurationId - String!
configurationName - String!
providerId - String!
description - String
parameters - [ObjectPropertyInfo!]!
Example
{
  "configurationId": "<string>",
  "configurationName": "<string>",
  "providerId": "<string>",
  "description": "<string>",
  "parameters": [ObjectPropertyInfo]
}
Types

SecretConfigurationInput

Fields
Input Field Description
configurationId - String!
configurationName - String!
providerId - String!
description - String
parameters - Object!
Example
{
  "configurationId": "<string>",
  "configurationName": "<string>",
  "providerId": "<string>",
  "description": "<string>",
  "parameters": "<object>"
}
Types

SecretManagementInfo

Fields
Field Name Description
id - String!
label - String!
description - String!
configurationId - String
configurationName - String
Example
{
  "id": "<string>",
  "label": "<string>",
  "description": "<string>",
  "configurationId": "<string>",
  "configurationName": "<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>"
Documentation by Anvil SpectaQL