Ueberauth Strategy for WorkOS v0.0.3

View Source Ueberauth.Strategy.WorkOS.OAuth (Ueberauth Strategy for WorkOS v0.0.3)

Implementation of an OAuth 2.0 strategy for WorkOS Single Sign-On

Note

This module is not intended to be called or configured directly. Please see Ueberauth.Strategy.WorkOS for all relevant configuration and documentation.

configuration

 Configuration

This module uses the configuration defined in Ueberauth.Strategy.WorkOS. Unlike other Ueberauth strategies, there is no need to define application environment variables for this module.

Link to this section Summary

Functions

authorize_url!(params \\ [], opts \\ [])

Get the authorization URL used during the request phase of Ueberauth

client(opts \\ [])

Construct a client for requests to the WorkOS API

Link to this section Functions

Link to this function

authorize_url!(params \\ [], opts \\ [])

View Source 
@spec authorize_url!(keyword(), keyword()) :: String.t()

Get the authorization URL used during the request phase of Ueberauth

Link to this function

client(opts \\ [])

View Source 
@spec client(keyword()) :: OAuth2.Client.t()

Construct a client for requests to the WorkOS API

options

 Options

This function accepts the same options as OAuth2.Client.new/1, including a redirect_uri. All options are collected and merged in this way:

  • Options passed directly to this function have the highest precedence, overriding all others.
  • Options configured with Ueberauth.Strategy.WorkOS have next-highest priority.
  • There are default values for authorize_url, headers, site, and token_url.

OAuth2 will use the same JSON serialization library as returned by Ueberauth.json_library/0.