External authentication schema

service.auth.external.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

_empty

Description

This schema currently exposes only mutations.

Response

Returns a String

Example

Query

query _empty {
  _empty
}

Response

{"data": {"_empty": "<string>"}}

Mutations

authExternalAppRedirectLink

Description

Returns a link to redirect the user to an external application for authentication

Response

Returns a String!

Example

Query

mutation authExternalAppRedirectLink {
  authExternalAppRedirectLink
}

Response

{
  "data": {
    "authExternalAppRedirectLink": "<string>"
  }
}

Mutations

authExternalAppToken

Description

Authenticates the user with an external application using a code and verifier

Response

Returns a String!

Arguments

Name	Description
code - String!
verifier - String!

Example

Query

mutation authExternalAppToken(
  $code: String!,
  $verifier: String!
) {
  authExternalAppToken(
    code: $code,
    verifier: $verifier
  )
}

Variables

{"code": "<string>", "verifier": "<string>"}

Response

{
  "data": {
    "authExternalAppToken": "<string>"
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

"<boolean>"

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