ACPex.Schema.Types.AuthMethod (ACPex v0.1.1)

Copy Markdown View Source

Authentication method information.

Describes an available authentication method that can be used during the connection authentication phase.

Required Fields

  • id - Unique identifier for the authentication method
  • name - Human-readable name for the authentication method

Optional Fields

  • description - Detailed description of the authentication method
  • meta - Additional metadata (map)

Example

%ACPex.Schema.Types.AuthMethod{
  id: "oauth2",
  name: "OAuth 2.0",
  description: "Authenticate using OAuth 2.0 flow"
}

JSON Representation

{
  "id": "oauth2",
  "name": "OAuth 2.0",
  "description": "Authenticate using OAuth 2.0 flow"
}

Summary

Types

t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Creates a changeset for validation.

Types

t()

@type t() :: %ACPex.Schema.Types.AuthMethod{
  description: String.t() | nil,
  id: String.t(),
  meta: map() | nil,
  name: String.t()
}

Functions

changeset(struct \\ %__MODULE__{}, params)

@spec changeset(t(), map()) :: Ecto.Changeset.t()

Creates a changeset for validation.

Required Fields

  • id - Must be present
  • name - Must be present