org.openstack4j.api.identity.v3

Interface UserService

All Superinterfaces:

RestService

All Known Implementing Classes:

UserServiceImpl

public interface UserService
extends RestService

identity/v3 User operations

Method Summary

Modifier and Type	Method and Description
ActionResponse	changePassword(String userId, String originalPassword, String password) change password for user.
User	create(String domainId, String name, String password, String email, boolean enabled) creates a new user
User	create(User user) create a new user
ActionResponse	delete(String userId) delete a user by id
User	get(String userId) gets detailed information about a specified user by id
List<? extends User>	getByName(String userName) get detailed information about users matching specified name across all domains
User	getByName(String userName, String domainId) get detailed information about a user specified by username and domain id
Domain	getUserDomain(String userId)
List<? extends User>	list() lists users.
List<? extends Role>	listDomainUserRoles(String userId, String domainId) list role assignment for specified user in domain context
List<? extends Role>	listProjectUserRoles(String userId, String projectId) list role assignments for specified user in project context
List<? extends Group>	listUserGroups(String userId) lists groups for a specified user
List<? extends Project>	listUserProjects(String userId) lists projects for a specified user
User	update(User user) updates the password for or enables or disables a specified user.

Method Detail

get

User get(String userId)

gets detailed information about a specified user by id

Parameters:

userId - the user id

Returns:

the user

getByName

List<? extends User> getByName(String userName)

get detailed information about users matching specified name across all domains

Parameters:

userName - the user name

Returns:

the of list users matching the name across all domains

getByName

User getByName(String userName,
               String domainId)

get detailed information about a user specified by username and domain id

Parameters:

userName - the user name

domainId - the domain identifier

Returns:

the user or null if not found

delete

ActionResponse delete(String userId)

delete a user by id

Parameters:

userid - the userId

Returns:

the action response

update

User update(User user)

updates the password for or enables or disables a specified user.

Parameters:

user - the user set to update

Returns:

the updated user

create

User create(User user)

create a new user

Parameters:

user - the user

Returns:

the newly created user

create

User create(String domainId,
            String name,
            String password,
            String email,
            boolean enabled)

creates a new user

Parameters:

domainId - the domain id

name - the name of the new user

password - the password of the new user

email - the email of the new user

enabled - the enabled of the new user

Returns:

the newly created user

getUserDomain

Domain getUserDomain(String userId)

Parameters:

userId - the user id

Returns:

the domain of the user

listUserGroups

List<? extends Group> listUserGroups(String userId)

lists groups for a specified user

Parameters:

userId - the user id

Returns:

list of groups for a user

listUserProjects

List<? extends Project> listUserProjects(String userId)

lists projects for a specified user

Parameters:

user - the user

Returns:

list of projects for a user

listProjectUserRoles

List<? extends Role> listProjectUserRoles(String userId,
                                          String projectId)

list role assignments for specified user in project context

Parameters:

userId - the user id

scope - the scope (project,domain)

Returns:

list of role assignments for specified user

listDomainUserRoles

List<? extends Role> listDomainUserRoles(String userId,
                                         String domainId)

list role assignment for specified user in domain context

Parameters:

userId - the user identifier

domainId - the domain identifier

Returns:

list of role assignments for specified user and domain

list

List<? extends User> list()

lists users.

Returns:

list of users

changePassword

ActionResponse changePassword(String userId,
                              String originalPassword,
                              String password)

change password for user.

Parameters:

userId - the user identifier

originalPassword - the original password

password - the new password

Returns:

the action response