elements_oidc

Oidc

The Oidc 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.

• elements_callback
• elements_create_oidc_session_1
• elements_poll_oidc_session

---

Back To Top

elements_callback

Not called by game clients. The provider redirects the system browser here after the user completes (or denies) authorization.

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_callback(_provider, _code=undefined, _state=undefined, _error=undefined, _callback=undefined)

Argument	Type	Description
_provider	String
_code	String
_state	String
_error	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_create_oidc_session_1

Supplying only 'provider' starts a pending browser-redirect login attempt and returns an id plus the authorize URL to open in the system browser. Additionally supplying 'idToken' instead validates it directly and returns a completed session synchronously, sharing validation code with the callback path.

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_session_1(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOidcLoginAttemptRequest	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	Any
_request	ElementsRequest

---

Back To Top

elements_poll_oidc_session

Returns COMPLETE with the session exactly once, on the poll that first observes completion; a subsequent poll for the same id, or a poll for an unknown/expired id, returns 404.

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_poll_oidc_session(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOidcLoginAttemptStatusResponse or Undefined
_request	ElementsRequest

---