ExDoppler.Auths (ExDoppler v1.0.1)
View SourceModule for interacting with ExDoppler.TokenInfo
and ExDoppler.ODICToken
๐ Resources
- ๐ Doppler docs
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Summary
Functions
Get information about the token in use.
Authenticate via a Service Account Identity with OIDC. Returns a short-lived API token.
Same as odic/2
but won't wrap a successful response in {:ok, response}
Revoke an auth token
Same as revoke_auth_token/1
but won't wrap a successful response in {:ok, response}
Functions
Get information about the token in use.
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.TokenInfo{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.TokenInfo
iex> alias ExDoppler.Auths
iex> {:ok, _token_info = %TokenInfo{}} = Auths.me()
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as me/0
but won't wrap a successful response in {:ok, response}
Authenticate via a Service Account Identity with OIDC. Returns a short-lived API token.
๐ท๏ธ Params
- token: the OIDC token string from your OIDC provider (likely CI)
- identity: Identity ID from the Doppler Dashboard
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.ODICToken{...}}
โ On Failure
{:error, err}
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as odic/2
but won't wrap a successful response in {:ok, response}
Revoke an auth token
๐ท๏ธ Params
- token_to_revoke: the auth token to revoke (e.g
"auth-2342-asdf"
)
โคต๏ธ Returns
โ On Success
{:ok, {:success, true}}
โ On Failure
{:error, err}
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as revoke_auth_token/1
but won't wrap a successful response in {:ok, response}