Marqeta.SelfServiceCredentials (marqeta v1.0.0)

Programmatically create, retrieve, and delete admin access tokens.

Examples

{:ok, cred} = Marqeta.SelfServiceCredentials.create(%{
  email: "admin@example.com",
  role: "ADMINISTRATOR"
})

{:ok, _} = Marqeta.SelfServiceCredentials.delete(cred["token"])

Summary

Functions

create(params \\ %{}, opts \\ [])

Creates a new admin credential.

create!(params \\ %{}, opts \\ [])

Creates a new admin credential. Raises Marqeta.Error on failure.

delete(token, opts \\ [])

Deletes an admin access token by token.

get(token, opts \\ [])

Retrieves a admin credential by token.

get!(token, opts \\ [])

Retrieves a admin credential by token. Raises Marqeta.Error on failure.

list(params \\ %{}, opts \\ [])

Lists admin credential resources.

list!(params \\ %{}, opts \\ [])

Lists admin credential resources. Raises Marqeta.Error on failure.

stream(params \\ %{}, opts \\ [])

Returns a lazy Stream that auto-paginates admin credential resources.

update(token, params, opts \\ [])

Updates an existing admin credential.

update!(token, params, opts \\ [])

Updates an existing admin credential. Raises Marqeta.Error on failure.

Functions

create(params \\ %{}, opts \\ [])

@spec create(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Creates a new admin credential.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

create!(params \\ %{}, opts \\ [])

@spec create!(
  map(),
  keyword()
) :: map()

Creates a new admin credential. Raises Marqeta.Error on failure.

delete(token, opts \\ [])

@spec delete(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Deletes an admin access token by token.

get(token, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Retrieves a admin credential by token.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

get!(token, opts \\ [])

@spec get!(
  String.t(),
  keyword()
) :: map()

Retrieves a admin credential by token. Raises Marqeta.Error on failure.

list(params \\ %{}, opts \\ [])

@spec list(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Lists admin credential resources.

Accepts standard Marqeta pagination params: count, start_index, sort_by, sort_order, fields.

Use stream/2 to lazily iterate all pages automatically.

list!(params \\ %{}, opts \\ [])

@spec list!(
  map(),
  keyword()
) :: map()

Lists admin credential resources. Raises Marqeta.Error on failure.

stream(params \\ %{}, opts \\ [])

@spec stream(
  map(),
  keyword()
) :: Enumerable.t()

Returns a lazy Stream that auto-paginates admin credential resources.

update(token, params, opts \\ [])

@spec update(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Updates an existing admin credential.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

update!(token, params, opts \\ [])

@spec update!(String.t(), map(), keyword()) :: map()

Updates an existing admin credential. Raises Marqeta.Error on failure.