Skip to content

auth

Jump to bottom
YYBartT edited this page Jan 20, 2026 · 2 revisions

Authentication

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_auth_scheme_get_auth_schemes

Elements Operation: getAuthSchemes

This function 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 Function.


Syntax:

elements_auth_scheme_get_auth_schemes(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)
Argument Type Description
_offset Real The offset of the first result to return in the page.
_count Real The number of results to return in the page.
_tags Array of String An array specifying tags (see tags Property).
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsPaginationAuthScheme
_request ElementsRequest


Back To Top

elements_auth_scheme_create_auth_scheme

Elements Operation: createAuthScheme

This function 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 Function.


Syntax:

elements_auth_scheme_create_auth_scheme(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateAuthSchemeRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsCreateAuthSchemeResponse
_request ElementsRequest


Back To Top

elements_auth_scheme_get_auth_scheme

Elements Operation: getAuthScheme

This function 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 Function.


Syntax:

elements_auth_scheme_get_auth_scheme(_auth_scheme_id, _callback=undefined)
Argument Type Description
_auth_scheme_id String The ID of the authentication scheme.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsAuthScheme
_request ElementsRequest


Back To Top

elements_auth_scheme_update_auth_scheme

Elements Operation: updateAuthScheme

This function 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 Function.


Syntax:

elements_auth_scheme_update_auth_scheme(_auth_scheme_id, _body=undefined, _callback=undefined)
Argument Type Description
_auth_scheme_id String The ID of the authentication scheme.
_body ElementsUpdateAuthSchemeRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsUpdateAuthSchemeResponse
_request ElementsRequest


Back To Top

elements_auth_scheme_delete_auth_scheme

Elements Operation: deleteAuthScheme

This function 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 Function.


Syntax:

elements_auth_scheme_delete_auth_scheme(_auth_scheme_id, _callback=undefined)
Argument Type Description
_auth_scheme_id String The ID of the authentication scheme.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data Undefined
_request ElementsRequest


Back To Top

elements_auth_create_oauth2_session

Elements Operation: createOauth2Session

This function begins a session by accepting a session request with parameters matching the specified OAuth2 Scheme. Upon successful validation against the scheme provided in the path, this will return a session which can be used for authentication. If there is no User associated with the supplied credentials, this will implicitly create a new account and will include that account information in the response. If there is an account, or this method receives an existing session key, this will link to the existing scheme if the account was not previously linked.

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 Function.


Syntax:

elements_auth_create_oauth2_session(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsOAuth2SessionRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsSessionCreation
_request ElementsRequest


Back To Top

elements_auth_scheme_get_auth_schemes_1

Elements Operation: getAuthSchemes1

This function 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 Function.


Syntax:

elements_auth_scheme_get_auth_schemes_1(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)
Argument Type Description
_offset Real The offset of the first result to return in the page.
_count Real The number of results to return in the page.
_tags Array of String An array specifying tags (see tags Property).
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsPaginationOAuth2AuthScheme
_request ElementsRequest


Back To Top

elements_auth_scheme_create_auth_scheme_1

Elements Operation: createAuthScheme_1

This function 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 Function.


Syntax:

elements_auth_scheme_create_auth_scheme_1(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateOrUpdateOAuth2AuthSchemeRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsCreateOrUpdateOAuth2AuthSchemeResponse
_request ElementsRequest


Back To Top

elements_auth_scheme_get_auth_scheme_1

Elements Operation: getAuthScheme_1

This function 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 Function.


Syntax:

elements_auth_scheme_get_auth_scheme_1(_oauth2_auth_scheme_id, _callback=undefined)
Argument Type Description
_oauth2_auth_scheme_id String The ID of the authentication scheme.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsOAuth2AuthScheme
_request ElementsRequest


Back To Top

elements_auth_scheme_update_auth_scheme_1

Elements Operation: updateAuthScheme1

This function 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 Function.


Syntax:

elements_auth_scheme_update_auth_scheme_1(_oauth2_auth_scheme_id, _body=undefined, _callback=undefined)
Argument Type Description
_oauth2_auth_scheme_id String The ID of the authentication scheme.
_body ElementsCreateOrUpdateOAuth2AuthSchemeRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsCreateOrUpdateOAuth2AuthSchemeResponse
_request ElementsRequest


Back To Top

elements_auth_scheme_delete_auth_scheme_1

Elements Operation: deleteAuthScheme_1

This function 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 Function.


Syntax:

elements_auth_scheme_delete_auth_scheme_1(_oauth2_auth_scheme_id, _callback=undefined)
Argument Type Description
_oauth2_auth_scheme_id String The ID of the authentication scheme.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data Undefined
_request ElementsRequest


Back To Top

elements_auth_create_oidc_session

Elements Operation: createOidcSession

This function begins a session by accepting a JWT. Upon successful validation against the scheme provided in the path, this will return a session which can be used for authentication. If there is no User associated with the supplied credentials, this will implicitly create a new account and will include that account information in the response. If there is an account, or this method receives an existing session key, this will link to the existing scheme if the account was not previously linked.

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 Function.


Syntax:

elements_auth_create_oidc_session(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsOidcSessionRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsSessionCreation
_request ElementsRequest


Back To Top

elements_auth_scheme_get_auth_schemes_2

Elements Operation: getAuthSchemes_2

This function 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 Function.


Syntax:

elements_auth_scheme_get_auth_schemes_2(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)
Argument Type Description
_offset Real The offset of the first result to return in the page.
_count Real The number of results to return in the page.
_tags Array of String An array specifying tags (see tags Property).
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsPaginationOidcAuthScheme
_request ElementsRequest


Back To Top

elements_auth_scheme_create_auth_scheme_2

Elements Operation: createAuthScheme_2

This function 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 Function.


Syntax:

elements_auth_scheme_create_auth_scheme_2(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateOrUpdateOidcAuthSchemeRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsCreateOrUpdateOidcAuthSchemeResponse
_request ElementsRequest


Back To Top

elements_auth_scheme_get_auth_scheme_2

Elements Operation: getAuthScheme_2

This function 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 Function.


Syntax:

elements_auth_scheme_get_auth_scheme_2(_oidc_auth_scheme_id, _callback=undefined)
Argument Type Description
_oidc_auth_scheme_id String The ID of the scheme.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsOidcAuthScheme
_request ElementsRequest


Back To Top

elements_auth_scheme_update_auth_scheme_2

Elements Operation: updateAuthScheme_2

This function 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 Function.


Syntax:

elements_auth_scheme_update_auth_scheme_2(_oidc_auth_scheme_id, _body=undefined, _callback=undefined)
Argument Type Description
_oidc_auth_scheme_id String The ID of the scheme.
_body ElementsCreateOrUpdateOidcAuthSchemeRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsCreateOrUpdateOidcAuthSchemeResponse
_request ElementsRequest


Back To Top

elements_auth_scheme_delete_auth_scheme_2

Elements Operation: deleteAuthScheme_2

This function 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 Function.


Syntax:

elements_auth_scheme_delete_auth_scheme_2(_oidc_auth_scheme_id, _callback=undefined)
Argument Type Description
_oidc_auth_scheme_id String The ID of the scheme.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data Undefined
_request ElementsRequest


GameMaker 2026

GMEXT-Elements

Guides

REST API

Schemas

Clone this wiki locally