Skip to content

elements_auth_scheme

Francisco Dias edited this page Aug 20, 2026 · 1 revision

Auth Scheme

The Auth Scheme endpoints.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.



Back To Top

elements_create_custom_auth_scheme

Creates a new Auth Scheme, from the data in the given auth scheme request

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_create_custom_auth_scheme(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateAuthSchemeRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsCreateAuthSchemeResponse or Undefined
_request ElementsRequest


Back To Top

elements_create_oauth2_auth_scheme

Creates a new Auth Scheme, from the data in the given auth scheme request

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_create_oauth2_auth_scheme(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateOrUpdateOAuth2AuthSchemeRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsCreateOrUpdateOAuth2AuthSchemeResponse or Undefined
_request ElementsRequest


Back To Top

elements_create_oidc_auth_scheme

Creates a new Auth Scheme, from the data in the given auth scheme request

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_create_oidc_auth_scheme(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateOrUpdateOidcAuthSchemeRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsCreateOrUpdateOidcAuthSchemeResponse or Undefined
_request ElementsRequest


Back To Top

elements_create_provider_configuration

Requires SUPERUSER access. Resolves the discovery document at the supplied discoveryUrl and auto-provisions the matching OIDC auth scheme by issuer, so a single request fully activates a new provider (e.g. Twitch) with no code changes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_create_provider_configuration(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateOrUpdateOidcProviderConfigurationRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsCreateOrUpdateOidcProviderConfigurationResponse or Undefined
_request ElementsRequest


Back To Top

elements_delete_custom_auth_scheme

Deletes an Auth Scheme with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_delete_custom_auth_scheme(_auth_scheme_id, _callback=undefined)
Argument Type Description
_auth_scheme_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest


Back To Top

elements_delete_oauth2_auth_scheme

Deletes an Auth Scheme with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_delete_oauth2_auth_scheme(_oauth2_auth_scheme_id, _callback=undefined)
Argument Type Description
_oauth2_auth_scheme_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest


Back To Top

elements_delete_oidc_auth_scheme

Deletes an Auth Scheme with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_delete_oidc_auth_scheme(_oidc_auth_scheme_id, _callback=undefined)
Argument Type Description
_oidc_auth_scheme_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest


Back To Top

elements_delete_provider_configuration

Deletes an OIDC provider configuration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_delete_provider_configuration(_provider_configuration_id, _callback=undefined)
Argument Type Description
_provider_configuration_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest


Back To Top

elements_get_custom_auth_scheme

Gets a specific Auth Scheme by the authSchemeId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_custom_auth_scheme(_auth_scheme_id, _callback=undefined)
Argument Type Description
_auth_scheme_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsAuthScheme or Undefined
_request ElementsRequest


Back To Top

elements_get_custom_auth_schemes

Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_custom_auth_schemes(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_tags Array of String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationAuthScheme or Undefined
_request ElementsRequest


Back To Top

elements_get_oauth2_auth_scheme

Gets a specific Auth Scheme by the oAuth2AuthSchemeId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_oauth2_auth_scheme(_oauth2_auth_scheme_id, _callback=undefined)
Argument Type Description
_oauth2_auth_scheme_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsOAuth2AuthScheme or Undefined
_request ElementsRequest


Back To Top

elements_get_oauth2_auth_schemes

Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_oauth2_auth_schemes(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_tags Array of String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationOAuth2AuthScheme or Undefined
_request ElementsRequest


Back To Top

elements_get_oidc_auth_scheme

Gets a specific Auth Scheme by the oidcAuthSchemeId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_oidc_auth_scheme(_oidc_auth_scheme_id, _callback=undefined)
Argument Type Description
_oidc_auth_scheme_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsOidcAuthScheme or Undefined
_request ElementsRequest


Back To Top

elements_get_oidc_auth_schemes

Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_oidc_auth_schemes(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_tags Array of String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationOidcAuthScheme or Undefined
_request ElementsRequest


Back To Top

elements_get_provider_configuration

Gets a specific OIDC provider configuration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_provider_configuration(_provider_configuration_id, _callback=undefined)
Argument Type Description
_provider_configuration_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsOidcProviderConfiguration or Undefined
_request ElementsRequest


Back To Top

elements_get_provider_configurations

Requires SUPERUSER access. Gets a pagination of OIDC provider configurations.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_provider_configurations(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_tags Array of String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationOidcProviderConfiguration or Undefined
_request ElementsRequest


Back To Top

elements_update_custom_auth_scheme

Updates an Auth Scheme with the specified data in the auth scheme request.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_update_custom_auth_scheme(_auth_scheme_id, _body=undefined, _callback=undefined)
Argument Type Description
_auth_scheme_id String
_body ElementsUpdateAuthSchemeRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsUpdateAuthSchemeResponse or Undefined
_request ElementsRequest


Back To Top

elements_update_oauth2_auth_scheme

Updates an Auth Scheme with the specified data in the auth scheme request.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_update_oauth2_auth_scheme(_oauth2_auth_scheme_id, _body=undefined, _callback=undefined)
Argument Type Description
_oauth2_auth_scheme_id String
_body ElementsCreateOrUpdateOAuth2AuthSchemeRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsCreateOrUpdateOAuth2AuthSchemeResponse or Undefined
_request ElementsRequest


Back To Top

elements_update_oidc_auth_scheme

Updates an Auth Scheme with the specified data in the auth scheme request.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_update_oidc_auth_scheme(_oidc_auth_scheme_id, _body=undefined, _callback=undefined)
Argument Type Description
_oidc_auth_scheme_id String
_body ElementsCreateOrUpdateOidcAuthSchemeRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsCreateOrUpdateOidcAuthSchemeResponse or Undefined
_request ElementsRequest


Back To Top

elements_update_provider_configuration

Updates an OIDC provider configuration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_update_provider_configuration(_provider_configuration_id, _body=undefined, _callback=undefined)
Argument Type Description
_provider_configuration_id String
_body ElementsCreateOrUpdateOidcProviderConfigurationRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsCreateOrUpdateOidcProviderConfigurationResponse or Undefined
_request ElementsRequest


Clone this wiki locally