UsersEntity (auth0 1.22.1 API)

java.lang.Object
- com.auth0.client.mgmt.UsersEntity

```
public class UsersEntity
extends java.lang.Object
```
Class that provides an implementation of the Users methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Users and https://auth0.com/docs/api/management/v2#!/Users_By_Email
This class is not thread-safe.

See Also:

ManagementAPI

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String apiToken

protected okhttp3.HttpUrl baseUrl

protected okhttp3.OkHttpClient client

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`apiToken`
`protected okhttp3.HttpUrl`	`baseUrl`
`protected okhttp3.OkHttpClient`	`client`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Request`	`addPermissions(java.lang.String userId, java.util.List<Permission> permissions)` Assign permissions to a user.
`Request`	`addRoles(java.lang.String userId, java.util.List<java.lang.String> roleIds)` Assign roles to a user.
`Request<User>`	`create(User user)` Create a User.
`Request`	`delete(java.lang.String userId)` Delete an existing User.
`Request`	`deleteMultifactorProvider(java.lang.String userId, java.lang.String provider)` Delete an existing User's Multifactor Provider.
`Request<User>`	`get(java.lang.String userId, UserFilter filter)` Request a User.
`Request<java.util.List<Enrollment>>`	`getEnrollments(java.lang.String userId)` Request all the Guardian Enrollments for a given User.
`Request<LogEventsPage>`	`getLogEvents(java.lang.String userId, LogEventFilter filter)` Request all the Events Log for a given User.
`Request<java.util.List<Identity>>`	`linkIdentity(java.lang.String primaryUserId, java.lang.String secondaryIdToken)` A token with scope update:current_user_identities is needed.
`Request<java.util.List<Identity>>`	`linkIdentity(java.lang.String primaryUserId, java.lang.String secondaryUserId, java.lang.String provider, java.lang.String connectionId)` Links two User's Identities.
`Request<UsersPage>`	`list(UserFilter filter)` Request all the Users.
`Request<java.util.List<User>>`	`listByEmail(java.lang.String email, FieldsFilter filter)` Request all the Users that match a given email.
`Request<PermissionsPage>`	`listPermissions(java.lang.String userId, PageFilter filter)` Get the permissions associated to the user.
`Request<RolesPage>`	`listRoles(java.lang.String userId, PageFilter filter)` Get the roles associated with a user.
`Request`	`removePermissions(java.lang.String userId, java.util.List<Permission> permissions)` Remove permissions from a user.
`Request`	`removeRoles(java.lang.String userId, java.util.List<java.lang.String> roleIds)` Remove roles from a user.
`Request<RecoveryCode>`	`rotateRecoveryCode(java.lang.String userId)` Rotates a User's Guardian recovery code.
`Request<java.util.List<Identity>>`	`unlinkIdentity(java.lang.String primaryUserId, java.lang.String secondaryUserId, java.lang.String provider)` Un-links two User's Identities.
`Request<User>`	`update(java.lang.String userId, User user)` Update an existing User.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - client
```
protected final okhttp3.OkHttpClient client
```
  - baseUrl
```
protected final okhttp3.HttpUrl baseUrl
```
  - apiToken
```
protected final java.lang.String apiToken
```
- Method Detail
  - listByEmail
```
public Request<java.util.List<User>> listByEmail(java.lang.String email,
                                                 FieldsFilter filter)
```
    Request all the Users that match a given email. A token with scope read:users is needed. If you want the identities.access_token property to be included, you will also need the scope read:user_idp_tokens. See https://auth0.com/docs/api/management/v2#!/Users_By_Email/get_users_by_email
    
    Parameters:
    
    email - the email of the users to look up.
    
    filter - the filter to use. Can be null.
    
    Returns:
    
    a Request to execute.
  - list
```
public Request<UsersPage> list(UserFilter filter)
```
    Request all the Users. A token with scope read:users is needed. If you want the identities.access_token property to be included, you will also need the scope read:user_idp_tokens. See https://auth0.com/docs/api/management/v2#!/Users/get_users
    
    Parameters:
    
    filter - the filter to use. Can be null.
    
    Returns:
    
    a Request to execute.
  - get
```
public Request<User> get(java.lang.String userId,
                         UserFilter filter)
```
    Request a User. A token with scope read:users is needed. If you want the identities.access_token property to be included, you will also need the scope read:user_idp_tokens. See https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id
    
    Parameters:
    
    userId - the id of the user to retrieve.
    
    filter - the filter to use. Can be null.
    
    Returns:
    
    a Request to execute.
  - create
```
public Request<User> create(User user)
```
    Create a User. A token with scope create:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/post_users
    
    Parameters:
    
    user - the user data to set
    
    Returns:
    
    a Request to execute.
  - delete
```
public Request delete(java.lang.String userId)
```
    Delete an existing User. A token with scope delete:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/delete_users_by_id
    
    Parameters:
    
    userId - the user id
    
    Returns:
    
    a Request to execute.
  - update
```
public Request<User> update(java.lang.String userId,
                            User user)
```
    Update an existing User. A token with scope update:users is needed. If you're updating app_metadata you'll also need update:users_app_metadata scope. See https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id
    
    Parameters:
    
    userId - the user id
    
    user - the user data to set. It can't include id.
    
    Returns:
    
    a Request to execute.
  - getEnrollments
```
public Request<java.util.List<Enrollment>> getEnrollments(java.lang.String userId)
```
    Request all the Guardian Enrollments for a given User. A token with scope read:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/get_enrollments
    
    Parameters:
    
    userId - the id of the user to retrieve.
    
    Returns:
    
    a Request to execute.
  - getLogEvents
```
public Request<LogEventsPage> getLogEvents(java.lang.String userId,
                                           LogEventFilter filter)
```
    Request all the Events Log for a given User. A token with scope read:logs is needed. See https://auth0.com/docs/api/management/v2#!/Users/get_logs_by_user
    
    Parameters:
    
    userId - the id of the user to retrieve.
    
    filter - the filter to use.
    
    Returns:
    
    a Request to execute.
  - deleteMultifactorProvider
```
public Request deleteMultifactorProvider(java.lang.String userId,
                                         java.lang.String provider)
```
    Delete an existing User's Multifactor Provider. A token with scope update:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/delete_multifactor_by_provider
    
    Parameters:
    
    userId - the user id
    
    provider - the multifactor provider
    
    Returns:
    
    a Request to execute.
  - rotateRecoveryCode
```
public Request<RecoveryCode> rotateRecoveryCode(java.lang.String userId)
```
    Rotates a User's Guardian recovery code. A token with scope update:users is needed.
    
    Parameters:
    
    userId - the user id
    
    Returns:
    
    a Request to execute.
    
    See Also:
    
    Management API2 docs
  - linkIdentity
```
public Request<java.util.List<Identity>> linkIdentity(java.lang.String primaryUserId,
                                                      java.lang.String secondaryUserId,
                                                      java.lang.String provider,
                                                      java.lang.String connectionId)
```
    Links two User's Identities. A token with scope update:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/post_identities
    
    Parameters:
    
    primaryUserId - the primary identity's user id
    
    secondaryUserId - the secondary identity's user id
    
    provider - the provider name of the secondary identity.
    
    connectionId - the connection id of the secondary account being linked, useful if the provider is 'auth0' and you have several connections. Can be null.
    
    Returns:
    
    a Request to execute.
  - linkIdentity
```
public Request<java.util.List<Identity>> linkIdentity(java.lang.String primaryUserId,
                                                      java.lang.String secondaryIdToken)
```
    A token with scope update:current_user_identities is needed. It only works for the user the access token represents. See https://auth0.com/docs/api/management/v2#!/Users/post_identities
    
    Parameters:
    
    primaryUserId - the primary identity's user id associated with the access token this client was configured with.
    
    secondaryIdToken - the user ID token representing the identity to link with the current user
    
    Returns:
    
    a Request to execute.
  - unlinkIdentity
```
public Request<java.util.List<Identity>> unlinkIdentity(java.lang.String primaryUserId,
                                                        java.lang.String secondaryUserId,
                                                        java.lang.String provider)
```
    Un-links two User's Identities. A token with scope update:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/delete_provider_by_user_id
    
    Parameters:
    
    primaryUserId - the primary identity's user id
    
    secondaryUserId - the secondary identity's user id
    
    provider - the provider name of the secondary identity.
    
    Returns:
    
    a Request to execute.
  - listPermissions
```
public Request<PermissionsPage> listPermissions(java.lang.String userId,
                                                PageFilter filter)
```
    Get the permissions associated to the user. A token with read:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/get_permissions
    
    Parameters:
    
    userId - the role id
    
    filter - an optional pagination filter
    
    Returns:
    
    a Request to execute
  - removePermissions
```
public Request removePermissions(java.lang.String userId,
                                 java.util.List<Permission> permissions)
```
    Remove permissions from a user. A token with update:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/delete_permissions
    
    Parameters:
    
    userId - the user id
    
    permissions - a list of permission objects to remove from the user
    
    Returns:
    
    a Request to execute
  - addPermissions
```
public Request addPermissions(java.lang.String userId,
                              java.util.List<Permission> permissions)
```
    Assign permissions to a user. A token with update:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/post_permissions
    
    Parameters:
    
    userId - the user id
    
    permissions - a list of permission objects to assign to the user
    
    Returns:
    
    a Request to execute
  - listRoles
```
public Request<RolesPage> listRoles(java.lang.String userId,
                                    PageFilter filter)
```
    Get the roles associated with a user. A token with read:users and read:roles is needed. See https://auth0.com/docs/api/management/v2#!/Users/get_user_roles
    
    Parameters:
    
    userId - the role id
    
    filter - an optional pagination filter
    
    Returns:
    
    a Request to execute
  - removeRoles
```
public Request removeRoles(java.lang.String userId,
                           java.util.List<java.lang.String> roleIds)
```
    Remove roles from a user. A token with update:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/delete_user_roles
    
    Parameters:
    
    userId - the user id
    
    roleIds - a list of role ids to remove from the user
    
    Returns:
    
    a Request to execute
  - addRoles
```
public Request addRoles(java.lang.String userId,
                        java.util.List<java.lang.String> roleIds)
```
    Assign roles to a user. A token with update:users is needed. See https://auth0.com/docs/api/management/v2#!/Users/post_user_roles
    
    Parameters:
    
    userId - the user id
    
    roleIds - a list of role ids to assign to the user
    
    Returns:
    
    a Request to execute

Class UsersEntity

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

client

baseUrl

apiToken

Method Detail

listByEmail

list

get

create

delete

update

getEnrollments

getLogEvents

deleteMultifactorProvider

rotateRecoveryCode

linkIdentity

linkIdentity

unlinkIdentity

listPermissions

removePermissions

addPermissions

listRoles

removeRoles

addRoles