database

package
v2.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 11, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package database provides types for the Auth0 database connection authentication endpoints.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChangePasswordRequest

type ChangePasswordRequest struct {
	// The client_id of your Auth0 Application.
	ClientID string `json:"client_id,omitempty"`
	// The user's email address.
	Email string `json:"email,omitempty"`
	// The name of the database connection configured on your client.
	Connection string `json:"connection,omitempty"`
	// The organization_id of the Organization associated with the user.
	Organization string `json:"organization,omitempty"`
	// Extra parameters to be merged into the request body. Values set here will override any existing values.
	ExtraParameters map[string]string `json:"-"`
}

ChangePasswordRequest defines the request body for calling the change password API.

func (*ChangePasswordRequest) MarshalJSON

func (c *ChangePasswordRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Unmarshaler interface.

It is required to support adding parameters from the `ExtraParameters` field onto the request object.

type SignupRequest

type SignupRequest struct {
	// The client_id of your client.
	ClientID string `json:"client_id,omitempty"`
	// The user's email address.
	Email string `json:"email,omitempty"`
	// The user's desired password.
	Password string `json:"password,omitempty"` //nolint:gosec // This is a request field, not a hardcoded secret.
	// The name of the database configured to your client.
	Connection string `json:"connection,omitempty"`
	// The user's username. Only valid if the connection requires a username.
	Username string `json:"username,omitempty"`
	// The user's phone number.
	PhoneNumber string `json:"phone_number,omitempty"`
	// The user's given name(s).
	GivenName string `json:"given_name,omitempty"`
	// The user's family name(s).
	FamilyName string `json:"family_name,omitempty"`
	// The user's full name.
	Name string `json:"name,omitempty"`
	// The user's nickname.
	Nickname string `json:"nickname,omitempty"`
	// A URI pointing to the user's picture.
	Picture string `json:"picture,omitempty"`
	// The user metadata to be associated with the user. If set, the field must be an object containing no more than ten properties.
	// Property names can have a maximum of 100 characters, and property values must be strings of no more than 500 characters.
	UserMetadata *map[string]interface{} `json:"user_metadata,omitempty"`
	// Extra parameters to be merged into the request body. Values set here will override any existing values.
	ExtraParameters map[string]string `json:"-"`
}

SignupRequest defines the request body for calling the sign up API.

func (*SignupRequest) MarshalJSON

func (s *SignupRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Unmarshaler interface.

It is required to support adding parameters from the `ExtraParameters` field onto the request object.

type SignupResponse

type SignupResponse struct {
	// The user's email address.
	Email string `json:"email,omitempty"`
	// Indicates whether a user has verified their email address.
	EmailVerified bool `json:"email_verified,omitempty"`
	// The user's ID.
	ID string `json:"_id,omitempty"`
	// The user's phone number.
	PhoneNumber string `json:"phone_number,omitempty"`
	// The user's username. Only valid if the connection requires a username.
	Username string `json:"username,omitempty"`
	// The user's given name(s).
	GivenName string `json:"given_name,omitempty"`
	// The user's family name(s).
	FamilyName string `json:"family_name,omitempty"`
	// The user's full name.
	Name string `json:"name,omitempty"`
	// The user's nickname.
	Nickname string `json:"nickname,omitempty"`
	// A URI pointing to the user's picture.
	Picture string `json:"picture,omitempty"`
	// The user metadata to be associated with the user. If set, the field must be an object containing no more than ten properties.
	// Property names can have a maximum of 100 characters, and property values must be strings of no more than 500 characters.
	UserMetadata *map[string]interface{} `json:"user_metadata,omitempty"`
}

SignupResponse defines the response of the sign up response.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL