OpenXchangeClient.Api.OpenID (open_xchange_client v0.10.1)

API calls for all endpoints tagged OpenID.

Link to this section Summary

Functions

Initiate the communication with the OpenID module The init request is used to initiate communication with the OpenID module from a UI client. It may be used to login or logout a user or to initiate the authorization process from a third party.

Initiate the communication with the OpenID module The init request as a POST is for thirdParty flow only. Will directly inititate the login process.

Initiate the communication with the OpenID module The logout request will terminate everx session for the current user and redirect him to the configured after logout page.

Link to this section Functions

Link to this function

init(connection, flow, redirect, opts \\ [])

@spec init(Tesla.Env.client(), String.t(), boolean(), keyword()) ::
  {:ok, nil}
  | {:ok, OpenXchangeClient.Model.InitResponse.t()}
  | {:error, Tesla.Env.t()}

Initiate the communication with the OpenID module The init request is used to initiate communication with the OpenID module from a UI client. It may be used to login or logout a user or to initiate the authorization process from a third party.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • flow (String.t): One of the three following strings can be used, {login, logout, thirdParty}. Either one will start the corresponding process in the OpenID module.
  • redirect (boolean()): Describes wether the response will be in form of a redirect or an URL placed in a 'redirect' parameter in a JSON body.
  • opts (KeywordList): [optional] Optional parameters
    • :hash (String.t): The hash value from where the request was triggered for later deeplink purposes.
    • :version (String.t): The client version.
    • :client (String.t): The client identifier.

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

init_0(connection, flow, redirect, opts \\ [])

@spec init_0(Tesla.Env.client(), String.t(), boolean(), keyword()) ::
  {:ok, nil}
  | {:ok, OpenXchangeClient.Model.InitResponse.t()}
  | {:error, Tesla.Env.t()}

Initiate the communication with the OpenID module The init request as a POST is for thirdParty flow only. Will directly inititate the login process.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • flow (String.t): Only 'thirdParty' as value possible.
  • redirect (boolean()): Describes wether the response will be in form of a redirect or an URL placed in a 'redirect' parameter in a JSON body.
  • opts (KeywordList): [optional] Optional parameters
    • :hash (String.t): The hash value from where the request was triggered for later deeplink purposes.
    • :version (String.t): The client version.
    • :client (String.t): The client identifier.

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

logout(connection, state, opts \\ [])

@spec logout(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Initiate the communication with the OpenID module The logout request will terminate everx session for the current user and redirect him to the configured after logout page.

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • state (String.t): The state which started the logout process.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure