Documentation
¶
Index ¶
- type Client
- func (c *Client) Create(ctx context.Context, id string, ...) (*management.CreateUserAuthenticationMethodResponseContent, error)
- func (c *Client) Delete(ctx context.Context, id string, authenticationMethodID string, ...) error
- func (c *Client) DeleteAll(ctx context.Context, id string, opts ...option.RequestOption) error
- func (c *Client) Get(ctx context.Context, id string, authenticationMethodID string, ...) (*management.GetUserAuthenticationMethodResponseContent, error)
- func (c *Client) List(ctx context.Context, id string, ...) (*core.Page[*management.UserAuthenticationMethod], error)
- func (c *Client) Set(ctx context.Context, id string, ...) ([]*management.SetUserAuthenticationMethodResponseContent, error)
- func (c *Client) Update(ctx context.Context, id string, authenticationMethodID string, ...) (*management.UpdateUserAuthenticationMethodResponseContent, error)
- type RawClient
- func (r *RawClient) Create(ctx context.Context, id string, ...) (*core.Response[*management.CreateUserAuthenticationMethodResponseContent], ...)
- func (r *RawClient) Delete(ctx context.Context, id string, authenticationMethodID string, ...) (*core.Response[any], error)
- func (r *RawClient) DeleteAll(ctx context.Context, id string, opts ...option.RequestOption) (*core.Response[any], error)
- func (r *RawClient) Get(ctx context.Context, id string, authenticationMethodID string, ...) (*core.Response[*management.GetUserAuthenticationMethodResponseContent], error)
- func (r *RawClient) Set(ctx context.Context, id string, ...) (*core.Response[[]*management.SetUserAuthenticationMethodResponseContent], ...)
- func (r *RawClient) Update(ctx context.Context, id string, authenticationMethodID string, ...) (*core.Response[*management.UpdateUserAuthenticationMethodResponseContent], ...)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
WithRawResponse *RawClient
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(options *core.RequestOptions) *Client
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.
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>.
func (*Client) DeleteAll ¶
Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action cannot be undone.
func (*Client) Get ¶
func (c *Client) Get( ctx context.Context, id string, authenticationMethodID string, opts ...option.RequestOption, ) (*management.GetUserAuthenticationMethodResponseContent, error)
func (*Client) List ¶
func (c *Client) List( ctx context.Context, id string, request *management.ListUserAuthenticationMethodsRequestParameters, opts ...option.RequestOption, ) (*core.Page[*management.UserAuthenticationMethod], error)
Retrieve detailed list of authentication methods associated with a specified user.
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’s existing settings.
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>.
type RawClient ¶
type RawClient struct {
// contains filtered or unexported fields
}
func NewRawClient ¶
func NewRawClient(options *core.RequestOptions) *RawClient
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) 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)