Magic.Token (magic_admin v0.9.0) View Source

Provides methods to interact with the DID Token.

Link to this section Summary

Types

claim()

A map of claims made by the DID Token

did_token()

A DID Token generated by a Magic user on the client-side.

issuer()

Decentralized identifier which encapsulates a unique user ID

public_address()

Cryptographic public address of the Magic User.

Functions

construct_issuer_with_public_address(public_address)

Parses public_address and extracts issuer

decode(did_token)

Decodes a DID Token from a Base64 string into a tuple of its individual components: proof and claim. This method allows you decode the DID Token and inspect the token

decode!(did_token)

Decodes a DID Token from a Base64 string into a tuple of its individual components: proof and claim. This method allows you decode the DID Token and inspect the token

get_issuer(did_token)

Parses did_token and extracts issuer

get_public_address(did_token)

Parses did_token and extracts cryptographic public_address

validate(did_token)

Validates did_token

validate!(did_token)

Validates did_token

Link to this section Types

claim()

Specs

claim() :: %{
  add: String.t(),
  aud: String.t(),
  ext: integer(),
  iat: integer(),
  iss: String.t(),
  nbf: integer(),
  sub: String.t(),
  tid: String.t()
}

A map of claims made by the DID Token

did_token()

Specs

did_token() :: String.t()

A DID Token generated by a Magic user on the client-side.

issuer()

Specs

issuer() :: String.t()

Decentralized identifier which encapsulates a unique user ID

public_address()

Specs

public_address() :: String.t()

Cryptographic public address of the Magic User.

Link to this section Functions

construct_issuer_with_public_address(public_address)

Specs

construct_issuer_with_public_address(public_address()) :: issuer()

Parses public_address and extracts issuer

Returns issuer info

decode(did_token)

Specs

decode(did_token()) ::
  {:ok, %{proof: String.t(), claim: claim(), message: String.t()}}
  | {:error, {:did_token_error, String.t()}}

Decodes a DID Token from a Base64 string into a tuple of its individual components: proof and claim. This method allows you decode the DID Token and inspect the token

Returns an :ok tuple with a map containing proof, claim and message or an error tuple

decode!(did_token)

Specs

decode!(did_token()) :: %{
  proof: String.t(),
  claim: claim(),
  message: String.t()
}

Decodes a DID Token from a Base64 string into a tuple of its individual components: proof and claim. This method allows you decode the DID Token and inspect the token

Returns A map containing proof, claim and message or raise an error

get_issuer(did_token)

Specs

get_issuer(did_token()) :: issuer()

Parses did_token and extracts issuer

Returns issuer info

get_public_address(did_token)

Specs

get_public_address(did_token()) :: public_address()

Parses did_token and extracts cryptographic public_address

Returns cryptographic public address of the Magic User who generated the supplied DID Token.

validate(did_token)

Specs

validate(did_token()) :: :ok | {:error, {:did_token_error, String.t()}}

Validates did_token

Returns :ok or an error tuple

validate!(did_token)

Specs

validate!(did_token()) :: true

Validates did_token

Returns true or raises an error