ExDoppler.Auths (ExDoppler v1.0.0)

View Source

Module for interacting with ExDoppler.TokenInfo and ExDoppler.ODICToken

๐Ÿ“– Resources

Summary

Functions

Get information about the token in use.

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.

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

me()

Get information about the token in use.

โคต๏ธ Returns

โœ… On Success

  {:ok, %ExDoppler.TokenInfo{...}}

โŒ On Failure

  {:err, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.TokenInfo
iex> alias ExDoppler.Auths
iex> {:ok, _token_info = %TokenInfo{}} = Auths.me()

๐Ÿ“– Resources

me!()

Same as me/0 but won't wrap a successful response in {:ok, response}

odic(token, identity)

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

  {:err, err}

๐Ÿ“– Resources

odic!(token, identity)

Same as odic/2 but won't wrap a successful response in {:ok, response}

revoke_auth_token(token_to_revoke)

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

  {:err, err}

๐Ÿ“– Resources

revoke_auth_token!(token_to_delete)

Same as revoke_auth_token/1 but won't wrap a successful response in {:ok, response}