Ueberauth OpenAM strategy v0.2.0 Ueberauth.Strategy.OpenAM.API View Source
OpenAM server API implementation.
Link to this section Summary
Functions
Provides the credentials for the user
Provides the extra params for the user
The callback phase implementation for your strategy
The cleanup phase implementation for your strategy
The request phase implementation for your strategy
Provides the info for the user
Returns the URL to the OpenAM server's login page
Redeem an OpenAM SSO Token for the user attributes
Returns the name of the SSO Token cookie
Provides the uid for the user
Link to this section Functions
auth(conn) View Source
credentials(conn) View Source
Provides the credentials for the user.
This is one of the component functions that is used to construct the auth
struct. What you return here will be in the auth struct at the credentials
key.
Callback implementation for Ueberauth.Strategy.credentials/1
.
default_options() View Source
extra(conn) View Source
Provides the extra params for the user.
This is one of the component functions that is used to construct the auth
struct. What you return here will be in the auth struct at the extra
key.
You would include any additional information within extra that does not fit
in either info
or credentials
Callback implementation for Ueberauth.Strategy.extra/1
.
handle_callback!(conn) View Source
The callback phase implementation for your strategy.
In this function you should make any external calls you need, check for
errors etc. The result of this phase is that either a failure
(Ueberauth.Failure
) will be assigned to the connections assigns at
ueberauth_failure
or an Ueberauth.Auth
struct will be constrcted and
added to the assigns at :ueberauth_auth
.
Callback implementation for Ueberauth.Strategy.handle_callback!/1
.
handle_cleanup!(conn) View Source
The cleanup phase implementation for your strategy.
The cleanup phase runs after the callback phase and is present to provide a mechanism to cleanup any temporary data your strategy may have placed in the connection.
Callback implementation for Ueberauth.Strategy.handle_cleanup!/1
.
handle_request!(conn) View Source
The request phase implementation for your strategy.
Setup, redirect or otherwise in here. This is an information gathering phase and should provide the end user with a way to provide the information required for your application to authenticate them.
Callback implementation for Ueberauth.Strategy.handle_request!/1
.
info(conn) View Source
Provides the info for the user.
This is one of the component functions that is used to construct the auth
struct. What you return here will be in the auth struct at the info
key.
Callback implementation for Ueberauth.Strategy.info/1
.
login_url() View Source
Returns the URL to the OpenAM server's login page
redeem_token(token) View Source
Redeem an OpenAM SSO Token for the user attributes
sso_cookie() View Source
Returns the name of the SSO Token cookie
uid(conn) View Source
Provides the uid for the user.
This is one of the component functions that is used to construct the auth
struct. What you return here will be in the auth struct at the uid
key.
Callback implementation for Ueberauth.Strategy.uid/1
.