User provisioning schema

service.provisioning.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

provisioningListUsers

Description

Returns a list of users for provisioning based on the auth provider and configuration ID.

Response

Returns [ExternalUserInfo!]!

Arguments
Name Description
authProviderId - ID!
authConfigurationId - ID!
filter - ExternalUsersFilter!

Example

Query
query provisioningListUsers(
  $authProviderId: ID!,
  $authConfigurationId: ID!,
  $filter: ExternalUsersFilter!
) {
  provisioningListUsers(
    authProviderId: $authProviderId,
    authConfigurationId: $authConfigurationId,
    filter: $filter
  ) {
    userId
    metaParameters
    authRole
  }
}
Variables
{
  "authProviderId": "<id>",
  "authConfigurationId": "<id>",
  "filter": ExternalUsersFilter
}
Response
{
  "data": {
    "provisioningListUsers": [
      {
        "userId": "<string>",
        "metaParameters": "<object>",
        "authRole": "<string>"
      }
    ]
  }
}

Mutations

provisioningImportUsers

Description

Imports users for provisioning based on the provided user import list.

Response

Returns [String!]!

Arguments
Name Description
userImportList - UserImportList!

Example

Query
mutation provisioningImportUsers($userImportList: UserImportList!) {
  provisioningImportUsers(userImportList: $userImportList)
}
Variables
{"userImportList": UserImportList}
Response
{
  "data": {
    "provisioningImportUsers": ["<string>"]
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

ExternalUserInfo

Description

Information about a user for provisioning from an external system.

Fields
Field Name Description
userId - String! Unique identifier for the user in the external system.
metaParameters - Object! Meta parameters for the user, such as email, first name, last name, etc.
authRole - String Auth role assigned to the user (see listAuthRoles).
Example
{"userId": "<string>", "metaParameters": "<object>", "authRole": "<string>"}
Types

ExternalUserInput

Description

Input for importing users for provisioning from an external system.

Fields
Input Field Description
userId - String! Unique identifier for the user in the external system.
metaParameters - Object! Meta parameters for the user, such as email, first name, last name, etc.
authRole - String Auth role to be assigned to the user (see listAuthRoles).
Example
{"userId": "<string>", "metaParameters": "<object>", "authRole": "<string>"}
Types

ExternalUsersFilter

Description

Pagination filter for external users.

Fields
Input Field Description
offset - Int
limit - Int
Example
{"offset": "<int>", "limit": "<int>"}
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

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

UserImportList

Description

Input for importing users for provisioning.

Fields
Input Field Description
users - [ExternalUserInput!]! List of users to be imported for provisioning.
authRole - String Auth role to be assigned to the users (see listAuthRoles).
Example
{"users": [ExternalUserInput], "authRole": "<string>"}
Documentation by Anvil SpectaQL