com.box.sdkgen.managers.users

Class UsersManager

Object

UsersManager

public class UsersManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsersManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	UsersManager()
protected	UsersManager(UsersManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
UserFull	createUser(CreateUserRequestBody requestBody) Creates a new managed user in an enterprise.
UserFull	createUser(CreateUserRequestBody requestBody, CreateUserHeaders headers) Creates a new managed user in an enterprise.
UserFull	createUser(CreateUserRequestBody requestBody, CreateUserQueryParams queryParams) Creates a new managed user in an enterprise.
UserFull	createUser(CreateUserRequestBody requestBody, CreateUserQueryParams queryParams, CreateUserHeaders headers) Creates a new managed user in an enterprise.
void	deleteUserById(String userId) Deletes a user.
void	deleteUserById(String userId, DeleteUserByIdHeaders headers) Deletes a user.
void	deleteUserById(String userId, DeleteUserByIdQueryParams queryParams) Deletes a user.
void	deleteUserById(String userId, DeleteUserByIdQueryParams queryParams, DeleteUserByIdHeaders headers) Deletes a user.
Authentication	getAuth()
NetworkSession	getNetworkSession()
UserFull	getUserById(String userId) Retrieves information about a user in the enterprise.
UserFull	getUserById(String userId, GetUserByIdHeaders headers) Retrieves information about a user in the enterprise.
UserFull	getUserById(String userId, GetUserByIdQueryParams queryParams) Retrieves information about a user in the enterprise.
UserFull	getUserById(String userId, GetUserByIdQueryParams queryParams, GetUserByIdHeaders headers) Retrieves information about a user in the enterprise.
UserFull	getUserMe() Retrieves information about the user who is currently authenticated.
UserFull	getUserMe(GetUserMeHeaders headers) Retrieves information about the user who is currently authenticated.
UserFull	getUserMe(GetUserMeQueryParams queryParams) Retrieves information about the user who is currently authenticated.
UserFull	getUserMe(GetUserMeQueryParams queryParams, GetUserMeHeaders headers) Retrieves information about the user who is currently authenticated.
Users	getUsers() Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.
Users	getUsers(GetUsersHeaders headers) Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.
Users	getUsers(GetUsersQueryParams queryParams) Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.
Users	getUsers(GetUsersQueryParams queryParams, GetUsersHeaders headers) Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.
UserFull	updateUserById(String userId) Updates a managed or app user in an enterprise.
UserFull	updateUserById(String userId, UpdateUserByIdHeaders headers) Updates a managed or app user in an enterprise.
UserFull	updateUserById(String userId, UpdateUserByIdQueryParams queryParams) Updates a managed or app user in an enterprise.
UserFull	updateUserById(String userId, UpdateUserByIdQueryParams queryParams, UpdateUserByIdHeaders headers) Updates a managed or app user in an enterprise.
UserFull	updateUserById(String userId, UpdateUserByIdRequestBody requestBody) Updates a managed or app user in an enterprise.
UserFull	updateUserById(String userId, UpdateUserByIdRequestBody requestBody, UpdateUserByIdHeaders headers) Updates a managed or app user in an enterprise.
UserFull	updateUserById(String userId, UpdateUserByIdRequestBody requestBody, UpdateUserByIdQueryParams queryParams) Updates a managed or app user in an enterprise.
UserFull	updateUserById(String userId, UpdateUserByIdRequestBody requestBody, UpdateUserByIdQueryParams queryParams, UpdateUserByIdHeaders headers) Updates a managed or app user in an enterprise.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

UsersManager

public UsersManager()

UsersManager

protected UsersManager(UsersManager.Builder builder)

Method Detail

getUsers

public Users getUsers()

Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

getUsers

public Users getUsers(GetUsersQueryParams queryParams)

Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

Parameters:

queryParams - Query parameters of getUsers method

getUsers

public Users getUsers(GetUsersHeaders headers)

Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

Parameters:

headers - Headers of getUsers method

getUsers

public Users getUsers(GetUsersQueryParams queryParams,
                      GetUsersHeaders headers)

Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

Parameters:

queryParams - Query parameters of getUsers method

headers - Headers of getUsers method

createUser

public UserFull createUser(CreateUserRequestBody requestBody)

Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

requestBody - Request body of createUser method

createUser

public UserFull createUser(CreateUserRequestBody requestBody,
                           CreateUserQueryParams queryParams)

Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

requestBody - Request body of createUser method

queryParams - Query parameters of createUser method

createUser

public UserFull createUser(CreateUserRequestBody requestBody,
                           CreateUserHeaders headers)

Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

requestBody - Request body of createUser method

headers - Headers of createUser method

createUser

public UserFull createUser(CreateUserRequestBody requestBody,
                           CreateUserQueryParams queryParams,
                           CreateUserHeaders headers)

Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

requestBody - Request body of createUser method

queryParams - Query parameters of createUser method

headers - Headers of createUser method

getUserMe

public UserFull getUserMe()

Retrieves information about the user who is currently authenticated.

In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app.

In the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default.

Use the `As-User` header to change who this API call is made on behalf of.

getUserMe

public UserFull getUserMe(GetUserMeQueryParams queryParams)

Retrieves information about the user who is currently authenticated.

In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app.

In the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default.

Use the `As-User` header to change who this API call is made on behalf of.

Parameters:

queryParams - Query parameters of getUserMe method

getUserMe

public UserFull getUserMe(GetUserMeHeaders headers)

Retrieves information about the user who is currently authenticated.

In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app.

In the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default.

Use the `As-User` header to change who this API call is made on behalf of.

Parameters:

headers - Headers of getUserMe method

getUserMe

public UserFull getUserMe(GetUserMeQueryParams queryParams,
                          GetUserMeHeaders headers)

Retrieves information about the user who is currently authenticated.

In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app.

In the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default.

Use the `As-User` header to change who this API call is made on behalf of.

Parameters:

queryParams - Query parameters of getUserMe method

headers - Headers of getUserMe method

getUserById

public UserFull getUserById(String userId)

Retrieves information about a user in the enterprise.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.

Parameters:

userId - The ID of the user. Example: "12345"

getUserById

public UserFull getUserById(String userId,
                            GetUserByIdQueryParams queryParams)

Retrieves information about a user in the enterprise.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.

Parameters:

userId - The ID of the user. Example: "12345"

queryParams - Query parameters of getUserById method

getUserById

public UserFull getUserById(String userId,
                            GetUserByIdHeaders headers)

Retrieves information about a user in the enterprise.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.

Parameters:

userId - The ID of the user. Example: "12345"

headers - Headers of getUserById method

getUserById

public UserFull getUserById(String userId,
                            GetUserByIdQueryParams queryParams,
                            GetUserByIdHeaders headers)

Retrieves information about a user in the enterprise.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.

This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.

Parameters:

userId - The ID of the user. Example: "12345"

queryParams - Query parameters of getUserById method

headers - Headers of getUserById method

updateUserById

public UserFull updateUserById(String userId)

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

userId - The ID of the user. Example: "12345"

updateUserById

public UserFull updateUserById(String userId,
                               UpdateUserByIdRequestBody requestBody)

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

userId - The ID of the user. Example: "12345"

requestBody - Request body of updateUserById method

updateUserById

public UserFull updateUserById(String userId,
                               UpdateUserByIdQueryParams queryParams)

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

userId - The ID of the user. Example: "12345"

queryParams - Query parameters of updateUserById method

updateUserById

public UserFull updateUserById(String userId,
                               UpdateUserByIdRequestBody requestBody,
                               UpdateUserByIdQueryParams queryParams)

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

userId - The ID of the user. Example: "12345"

requestBody - Request body of updateUserById method

queryParams - Query parameters of updateUserById method

updateUserById

public UserFull updateUserById(String userId,
                               UpdateUserByIdHeaders headers)

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

userId - The ID of the user. Example: "12345"

headers - Headers of updateUserById method

updateUserById

public UserFull updateUserById(String userId,
                               UpdateUserByIdRequestBody requestBody,
                               UpdateUserByIdHeaders headers)

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

userId - The ID of the user. Example: "12345"

requestBody - Request body of updateUserById method

headers - Headers of updateUserById method

updateUserById

public UserFull updateUserById(String userId,
                               UpdateUserByIdQueryParams queryParams,
                               UpdateUserByIdHeaders headers)

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

userId - The ID of the user. Example: "12345"

queryParams - Query parameters of updateUserById method

headers - Headers of updateUserById method

updateUserById

public UserFull updateUserById(String userId,
                               UpdateUserByIdRequestBody requestBody,
                               UpdateUserByIdQueryParams queryParams,
                               UpdateUserByIdHeaders headers)

Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Parameters:

userId - The ID of the user. Example: "12345"

requestBody - Request body of updateUserById method

queryParams - Query parameters of updateUserById method

headers - Headers of updateUserById method

deleteUserById

public void deleteUserById(String userId)

Deletes a user. By default, this operation fails if the user still owns any content. To proceed, move their owned content first, or use the `force` parameter to delete the user and their files.

Parameters:

userId - The ID of the user. Example: "12345"

deleteUserById

public void deleteUserById(String userId,
                           DeleteUserByIdQueryParams queryParams)

Deletes a user. By default, this operation fails if the user still owns any content. To proceed, move their owned content first, or use the `force` parameter to delete the user and their files.

Parameters:

userId - The ID of the user. Example: "12345"

queryParams - Query parameters of deleteUserById method

deleteUserById

public void deleteUserById(String userId,
                           DeleteUserByIdHeaders headers)

Deletes a user. By default, this operation fails if the user still owns any content. To proceed, move their owned content first, or use the `force` parameter to delete the user and their files.

Parameters:

userId - The ID of the user. Example: "12345"

headers - Headers of deleteUserById method

deleteUserById

public void deleteUserById(String userId,
                           DeleteUserByIdQueryParams queryParams,
                           DeleteUserByIdHeaders headers)

Deletes a user. By default, this operation fails if the user still owns any content. To proceed, move their owned content first, or use the `force` parameter to delete the user and their files.

Parameters:

userId - The ID of the user. Example: "12345"

queryParams - Query parameters of deleteUserById method

headers - Headers of deleteUserById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()