client

func (*Client) Create ¶

func (c *Client) Create(
	ctx context.Context,
	request *management.CreateUserRequestContent,
	opts ...option.RequestOption,
) (*management.CreateUserResponseContent, error)

Create a new user for a given <a href="https://auth0.com/docs/connections/database">database</a> or <a href="https://auth0.com/docs/connections/passwordless">passwordless</a> connection.

Note: <code>connection</code> is required but other parameters such as <code>email</code> and <code>password</code> are dependent upon the type of connection.

func (*Client) Delete ¶

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

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

Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see <a href="https://auth0.com/docs/manage-users/user-accounts/delete-users">Delete Users</a>.

func (*Client) Get ¶

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

	id string,
	request *management.GetUserRequestParameters,
	opts ...option.RequestOption,
) (*management.GetUserResponseContent, error)

Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see <a href="https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint">Retrieve Users with the Get Users Endpoint</a>.

func (*Client) List ¶

func (c *Client) List(
	ctx context.Context,
	request *management.ListUsersRequestParameters,
	opts ...option.RequestOption,
) (*core.Page[*int, *management.UserResponseSchema, *management.ListUsersOffsetPaginatedResponseContent], error)

Retrieve details of users. It is possible to:

• Specify a search criteria for users
• Sort the users to be returned
• Select the fields to be returned
• Specify the number of users to retrieve per page and the page index <!-- only v3 is available -->

The <code>q</code> query parameter can be used to get users that match the specified criteria <a href="https://auth0.com/docs/users/search/v3/query-syntax">using query string syntax.</a>

<a href="https://auth0.com/docs/users/search/v3">Learn more about searching for users.</a>

Read about <a href="https://auth0.com/docs/users/search/best-practices">best practices</a> when working with the API endpoints for retrieving users.

Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the <a href="https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports">export job</a>, or the <a href="https://auth0.com/docs/extensions/user-import-export">User Import / Export</a> extension.

func (*Client) ListUsersByEmail ¶

func (c *Client) ListUsersByEmail(
	ctx context.Context,
	request *management.ListUsersByEmailRequestParameters,
	opts ...option.RequestOption,
) ([]*management.UserResponseSchema, error)

Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.

For example, if you register a user as JohnSmith@example.com, Auth0 saves the user's email as johnsmith@example.com.

Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.

func (*Client) RegenerateRecoveryCode ¶

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

	id string,
	opts ...option.RequestOption,
) (*management.RegenerateUsersRecoveryCodeResponseContent, error)

Remove an existing multi-factor authentication (MFA) <a href="https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa">recovery code</a> and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.

func (*Client) RevokeAccess ¶

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

	id string,
	request *management.RevokeUserAccessRequestContent,
	opts ...option.RequestOption,
) error

Revokes selected resources related to a user (sessions, refresh tokens, ...).

func (*Client) Update ¶

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

	id string,
	request *management.UpdateUserRequestContent,
	opts ...option.RequestOption,
) (*management.UpdateUserResponseContent, error)

Update a user.

These are the attributes that can be updated at the root level:

<ul>

<li>app_metadata</li>
<li>blocked</li>
<li>email</li>
<li>email_verified</li>
<li>family_name</li>
<li>given_name</li>
<li>name</li>
<li>nickname</li>
<li>password</li>
<li>phone_number</li>
<li>phone_verified</li>
<li>picture</li>
<li>username</li>
<li>user_metadata</li>
<li>verify_email</li>

</ul>

Some considerations: <ul>

<li>The properties of the new object will replace the old ones.</li>
<li>The metadata fields are an exception to this rule (<code>user_metadata</code> and <code>app_metadata</code>). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.</li>
<li>If you are updating <code>email</code>, <code>email_verified</code>, <code>phone_number</code>, <code>phone_verified</code>, <code>username</code> or <code>password</code> of a secondary identity, you need to specify the <code>connection</code> property too.</li>
<li>If you are updating <code>email</code> or <code>phone_number</code> you can specify, optionally, the <code>client_id</code> property.</li>
<li>Updating <code>email_verified</code> is not supported for enterprise and passwordless sms connections.</li>
<li>Updating the <code>blocked</code> to <code>false</code> does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.</li>
<li>Supported attributes can be unset by supplying <code>null</code> as the value.</li>

</ul>

<h5>Updating a field (non-metadata property)</h5> To mark the email address of a user as verified, the body to send should be: <pre><code>{ "email_verified": true }</code></pre>

<h5>Updating a user metadata root property</h5>Let's assume that our test user has the following <code>user_metadata</code>: <pre><code>{ "user_metadata" : { "profileCode": 1479 } }</code></pre>

To add the field <code>addresses</code> the body to send should be: <pre><code>{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}</code></pre>

The modified object ends up with the following <code>user_metadata</code> property:<pre><code>{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": { "work_address": "100 Industrial Way" }
  }
}</code></pre>

<h5>Updating an inner user metadata property</h5>If there's existing user metadata to which we want to add <code>"home_address": "742 Evergreen Terrace"</code> (using the <code>addresses</code> property) we should send the whole <code>addresses</code> object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:

<pre><code>{
  "user_metadata": {
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}</code></pre>

The modified object ends up with the following <code>user_metadata</code> property:

<pre><code>{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}</code></pre>

func (*RawClient) Create ¶

func (r *RawClient) Create(
	ctx context.Context,
	request *management.CreateUserRequestContent,
	opts ...option.RequestOption,
) (*core.Response[*management.CreateUserResponseContent], error)

func (*RawClient) Delete ¶

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

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

func (*RawClient) Get ¶

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

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

func (*RawClient) ListUsersByEmail ¶

func (r *RawClient) ListUsersByEmail(
	ctx context.Context,
	request *management.ListUsersByEmailRequestParameters,
	opts ...option.RequestOption,
) (*core.Response[[]*management.UserResponseSchema], error)

func (*RawClient) RegenerateRecoveryCode ¶

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

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

func (*RawClient) RevokeAccess ¶

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

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

func (*RawClient) Update ¶

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

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