ExDoppler.Auths (ExDoppler v0.9.0)

View Source

Module for interacting with ExDoppler.TokenInfo and ExDoppler.ODICToken

📖 Resources

Summary

Functions

me()

Get information about the token in use.

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.

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

revoke_auth_token!(token_to_delete)

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}