com.cloudera.api.v1

Interface UsersResource

All Known Subinterfaces:

UsersResourceV11

public interface UsersResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiUserList	createUsers(ApiUserList users) Creates a list of users.
ApiUser	deleteUser(String userName) Deletes a user from the system.
ApiUser	readUser(String userName) Returns detailed information about a user.
ApiUserList	readUsers(DataView dataView) Returns a list of the user names configured in the system.
ApiUser	updateUser(String userName, ApiUser user) Updates the given user's information.

Method Detail

createUsers

@Path(value="/")
ApiUserList createUsers(ApiUserList users)

Creates a list of users.

When creating new users, the password property of each user should be their plain text password. The returned user information will not contain any password information.

Parameters:

users - List of users to create.

Returns:

Information about created users.

deleteUser

@Path(value="/{userName}")
ApiUser deleteUser(String userName)

Deletes a user from the system.

Parameters:

userName - The name of the user to delete.

Returns:

The details of the deleted user.

readUser

@Path(value="/{userName}")
ApiUser readUser(String userName)

Returns detailed information about a user.

Parameters:

userName - The user to read.

Returns:

The user's information.

readUsers

@Path(value="/")
ApiUserList readUsers(DataView dataView)

Returns a list of the user names configured in the system.

Returns:

A list of users.

updateUser

@Path(value="/{userName}")
ApiUser updateUser(String userName,
                      ApiUser user)

Updates the given user's information. Note that the user's name cannot be changed.

Parameters:

userName - User name being updated.

user - The user information.