AshAuthentication.OidcConnection.Info (ash_authentication v5.0.0-rc.9)

Copy Markdown View Source

Introspection functions for the AshAuthentication.OidcConnection Ash extension.

Summary

Functions

The name of an attribute or calculation that returns the OIDC issuer base URL for the connection (e.g. https://acme.okta.com/oauth2/default).

The name of an attribute or calculation that returns the OIDC issuer base URL for the connection (e.g. https://acme.okta.com/oauth2/default).

The name of an attribute or calculation that returns the OAuth2 client_id.

The name of an attribute or calculation that returns the OAuth2 client_id.

The name of an attribute or calculation that returns the OAuth2 client_secret. If you encrypt secrets at rest (recommended — see ash_cloak/cloak_ecto), expose a calculation that decrypts on load and point this option at it.

The name of an attribute or calculation that returns the OAuth2 client_secret. If you encrypt secrets at rest (recommended — see ash_cloak/cloak_ecto), expose a calculation that decrypts on load and point this option at it.

Optional attribute/calculation returning a human-readable name for the connection (used by UI). Set to nil to disable.

Optional attribute/calculation returning a human-readable name for the connection (used by UI). Set to nil to disable.

The Ash domain used to access this resource.

The Ash domain used to access this resource.

Optional attribute/calculation returning an icon URL for the connection (used by UI). Set to nil to disable.

Optional attribute/calculation returning an icon URL for the connection (used by UI). Set to nil to disable.

The name of the primary-key attribute.

The name of the primary-key attribute.

oidc_connection DSL options

The name of the action used to read connections.

The name of the action used to read connections.

Functions

oidc_connection_base_url_field(dsl_or_extended)

@spec oidc_connection_base_url_field(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of an attribute or calculation that returns the OIDC issuer base URL for the connection (e.g. https://acme.okta.com/oauth2/default).

oidc_connection_base_url_field!(dsl_or_extended)

@spec oidc_connection_base_url_field!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of an attribute or calculation that returns the OIDC issuer base URL for the connection (e.g. https://acme.okta.com/oauth2/default).

oidc_connection_client_id_field(dsl_or_extended)

@spec oidc_connection_client_id_field(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of an attribute or calculation that returns the OAuth2 client_id.

oidc_connection_client_id_field!(dsl_or_extended)

@spec oidc_connection_client_id_field!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of an attribute or calculation that returns the OAuth2 client_id.

oidc_connection_client_secret_field(dsl_or_extended)

@spec oidc_connection_client_secret_field(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of an attribute or calculation that returns the OAuth2 client_secret. If you encrypt secrets at rest (recommended — see ash_cloak/cloak_ecto), expose a calculation that decrypts on load and point this option at it.

oidc_connection_client_secret_field!(dsl_or_extended)

@spec oidc_connection_client_secret_field!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of an attribute or calculation that returns the OAuth2 client_secret. If you encrypt secrets at rest (recommended — see ash_cloak/cloak_ecto), expose a calculation that decrypts on load and point this option at it.

oidc_connection_display_name_field(dsl_or_extended)

@spec oidc_connection_display_name_field(dsl_or_extended :: module() | map()) ::
  {:ok, atom() | nil} | :error

Optional attribute/calculation returning a human-readable name for the connection (used by UI). Set to nil to disable.

oidc_connection_display_name_field!(dsl_or_extended)

@spec oidc_connection_display_name_field!(dsl_or_extended :: module() | map()) ::
  (atom() | nil) | no_return()

Optional attribute/calculation returning a human-readable name for the connection (used by UI). Set to nil to disable.

oidc_connection_domain(dsl_or_extended)

@spec oidc_connection_domain(dsl_or_extended :: module() | map()) ::
  {:ok, module()} | :error

The Ash domain used to access this resource.

oidc_connection_domain!(dsl_or_extended)

@spec oidc_connection_domain!(dsl_or_extended :: module() | map()) ::
  module() | no_return()

The Ash domain used to access this resource.

oidc_connection_icon_url_field(dsl_or_extended)

@spec oidc_connection_icon_url_field(dsl_or_extended :: module() | map()) ::
  {:ok, atom() | nil} | :error

Optional attribute/calculation returning an icon URL for the connection (used by UI). Set to nil to disable.

oidc_connection_icon_url_field!(dsl_or_extended)

@spec oidc_connection_icon_url_field!(dsl_or_extended :: module() | map()) ::
  (atom() | nil) | no_return()

Optional attribute/calculation returning an icon URL for the connection (used by UI). Set to nil to disable.

oidc_connection_id_attribute_name(dsl_or_extended)

@spec oidc_connection_id_attribute_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the primary-key attribute.

oidc_connection_id_attribute_name!(dsl_or_extended)

@spec oidc_connection_id_attribute_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the primary-key attribute.

oidc_connection_options(dsl_or_extended)

@spec oidc_connection_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

oidc_connection DSL options

Returns a map containing the and any configured or default values.

oidc_connection_read_action_name(dsl_or_extended)

@spec oidc_connection_read_action_name(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The name of the action used to read connections.

oidc_connection_read_action_name!(dsl_or_extended)

@spec oidc_connection_read_action_name!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The name of the action used to read connections.