authenticationmethods

func (*Client) Create ¶

func (c *Client) Create(
	ctx context.Context,

	id string,
	request *management.CreateUserAuthenticationMethodRequestContent,
	opts ...option.RequestOption,
) (*management.CreateUserAuthenticationMethodResponseContent, error)

Create an authentication method. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.

Example:

request := &management.CreateUserAuthenticationMethodRequestContent{
    Type: management.CreatedUserAuthenticationMethodTypeEnumPhone,
}
client.Users.AuthenticationMethods.Create(
    context.TODO(),
    "id",
    request,
)

func (*Client) Delete ¶

func (c *Client) Delete(
	ctx context.Context,

	id string,

	authenticationMethodID string,
	opts ...option.RequestOption,
) error

Remove the authentication method with the given ID from the specified user. For more information, review <a href="https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api">Manage Authentication Methods with Management API</a>.

Example:

client.Users.AuthenticationMethods.Delete(
    context.TODO(),
    "id",
    "authentication_method_id",
)

func (*Client) DeleteAll ¶

func (c *Client) DeleteAll(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) error

Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action cannot be undone.

Example:

client.Users.AuthenticationMethods.DeleteAll(
    context.TODO(),
    "id",
)

func (*Client) Get ¶

func (c *Client) Get(
	ctx context.Context,

	id string,

	authenticationMethodID string,
	opts ...option.RequestOption,
) (*management.GetUserAuthenticationMethodResponseContent, error)

Example:

client.Users.AuthenticationMethods.Get(
    context.TODO(),
    "id",
    "authentication_method_id",
)

func (*Client) List ¶

func (c *Client) List(
	ctx context.Context,

	id string,
	request *management.ListUserAuthenticationMethodsRequestParameters,
	opts ...option.RequestOption,
) (*core.Page[*int, *management.UserAuthenticationMethod, *management.ListUserAuthenticationMethodsOffsetPaginatedResponseContent], error)

Retrieve detailed list of authentication methods associated with a specified user.

Example:

request := &management.ListUserAuthenticationMethodsRequestParameters{
    Page: management.Int(
        1,
    ),
    PerPage: management.Int(
        1,
    ),
    IncludeTotals: management.Bool(
        true,
    ),
}
client.Users.AuthenticationMethods.List(
    context.TODO(),
    "id",
    request,
)

func (*Client) Set ¶

func (c *Client) Set(
	ctx context.Context,

	id string,
	request management.SetUserAuthenticationMethodsRequestContent,
	opts ...option.RequestOption,
) ([]*management.SetUserAuthenticationMethodResponseContent, error)

Replace the specified user <a href="https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors"> authentication methods</a> with supplied values.

<b>Note</b>: Authentication methods supplied through this action do not iterate on existing methods. Instead, any methods passed will overwrite the user&#8217s existing settings.

Example:

request := []*management.SetUserAuthenticationMethods{
    &management.SetUserAuthenticationMethods{
        Type: management.AuthenticationTypeEnumPhone,
    },
}
client.Users.AuthenticationMethods.Set(
    context.TODO(),
    "id",
    request,
)

func (*Client) Update ¶

func (c *Client) Update(
	ctx context.Context,

	id string,

	authenticationMethodID string,
	request *management.UpdateUserAuthenticationMethodRequestContent,
	opts ...option.RequestOption,
) (*management.UpdateUserAuthenticationMethodResponseContent, error)

Modify the authentication method with the given ID from the specified user. For more information, review <a href="https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api">Manage Authentication Methods with Management API</a>.

Example:

request := &management.UpdateUserAuthenticationMethodRequestContent{}
client.Users.AuthenticationMethods.Update(
    context.TODO(),
    "id",
    "authentication_method_id",
    request,
)

func (*RawClient) Create ¶

func (r *RawClient) Create(
	ctx context.Context,

	id string,
	request *management.CreateUserAuthenticationMethodRequestContent,
	opts ...option.RequestOption,
) (*core.Response[*management.CreateUserAuthenticationMethodResponseContent], error)

func (*RawClient) Delete ¶

func (r *RawClient) Delete(
	ctx context.Context,

	id string,

	authenticationMethodID string,
	opts ...option.RequestOption,
) (*core.Response[any], error)

func (*RawClient) DeleteAll ¶

func (r *RawClient) DeleteAll(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) (*core.Response[any], error)

func (*RawClient) Get ¶

func (r *RawClient) Get(
	ctx context.Context,

	id string,

	authenticationMethodID string,
	opts ...option.RequestOption,
) (*core.Response[*management.GetUserAuthenticationMethodResponseContent], error)

func (*RawClient) Set ¶

func (r *RawClient) Set(
	ctx context.Context,

	id string,
	request management.SetUserAuthenticationMethodsRequestContent,
	opts ...option.RequestOption,
) (*core.Response[[]*management.SetUserAuthenticationMethodResponseContent], error)

func (*RawClient) Update ¶

func (r *RawClient) Update(
	ctx context.Context,

	id string,

	authenticationMethodID string,
	request *management.UpdateUserAuthenticationMethodRequestContent,
	opts ...option.RequestOption,
) (*core.Response[*management.UpdateUserAuthenticationMethodResponseContent], error)