View Source WorkOS (WorkOS SDK for Elixir v1.1.0)

Documentation for WorkOS.

Summary

Types

config()

Functions

api_key()

Retrieves the WorkOS API key from application config.

api_key(client)
base_url()

Retrieves the WorkOS base URL from application config.

client(config \\ config())

Returns a WorkOS client.

client_id()

Retrieves the WorkOS client ID from application config.

client_id(client)
config()

Loads config values from the application environment.

default_base_url()

Defines the WorkOS base API URL

Types

Link to this type

config()

View Source 
@type config() :: [
  api_key: String.t(),
  client_id: String.t(),
  base_url: String.t(),
  client: atom()
]

Functions

Link to this function

api_key()

View Source 
@spec api_key() :: String.t()

Retrieves the WorkOS API key from application config.

Link to this function

api_key(client)

View Source 
@spec api_key(WorkOS.Client.t()) :: String.t()
Link to this function

base_url()

View Source 
@spec base_url() :: String.t()

Retrieves the WorkOS base URL from application config.

Link to this function

client(config \\ config())

View Source 
@spec client(config()) :: WorkOS.Client.t()

Returns a WorkOS client.

Accepts a keyword list of config opts, though if omitted then it will attempt to load them from the application environment.

Link to this function

client_id()

View Source 
@spec client_id() :: String.t()

Retrieves the WorkOS client ID from application config.

Link to this function

client_id(client)

View Source 
@spec client_id(WorkOS.Client.t()) :: String.t()
Link to this function

config()

View Source 
@spec config() :: config()

Loads config values from the application environment.

Config options are as follows:

config :workos, WorkOS.Client
  api_key: "sk_123",
  client_id: "project_123",
  base_url: "https://api.workos.com",
  client: WorkOs.Client.TeslaClient

The only required config option is :api_key and :client_id. If you would like to replace the HTTP client used by WorkOS, configure the :client option. By default, this library uses Tesla, but changing it is as easy as defining your own client module. See the WorkOS.Client module docs for more info.

Link to this function

default_base_url()

View Source

Defines the WorkOS base API URL