Package org.openstack4j.api.identity.v3

Interface GroupService

All Superinterfaces:

RestService

All Known Implementing Classes:

GroupServiceImpl

public interface GroupService
extends RestService

Identity V3 Group Service

Method Summary

Modifier and Type	Method	Description
ActionResponse	addUserToGroup(String groupId, String userId)	adds an existing user to a group
ActionResponse	checkGroupUser(String groupId, String userId)	check whether a user belongs to a group
Group	create(String domainId, String name, String description)	creates a new group
Group	create(Group group)	create a new group
ActionResponse	delete(String groupId)	delete a group by id
Group	get(String groupId)	gets detailed information about a specified group by id
List<? extends Group>	getByName(String groupName)	get detailed information about groups matching specified by name and domain
Group	getByName(String groupName, String domainId)	get detailed information about groups matching specified by name and domain
List<? extends Group>	list()	lists groups.
List<? extends Role>	listDomainGroupRoles(String groupId, String domainId)	list roles for a group on a domain
List<? extends User>	listGroupUsers(String groupId)	lists the users that belong to a group
List<? extends Role>	listProjectGroupRoles(String groupId, String projectId)	list role for group on a project
ActionResponse	removeUserFromGroup(String groupId, String userId)	removes a user from a group
Group	update(Group group)	updates an existing group

Method Detail

get

Group get(String groupId)

gets detailed information about a specified group by id

Parameters:

groupId - the group id

Returns:

the group

getByName

List<? extends Group> getByName(String groupName)

get detailed information about groups matching specified by name and domain

Parameters:

groupName - the group name

Returns:

the of list groups matching the name across all domains

getByName

Group getByName(String groupName,
                String domainId)

get detailed information about groups matching specified by name and domain

Parameters:

groupName - the group name

domainId - the domain id

Returns:

the of list groups matching the name in a specific domain or null if not found

delete

ActionResponse delete(String groupId)

delete a group by id

Parameters:

groupId - the group id

Returns:

the action response

update

Group update(Group group)

updates an existing group

Parameters:

group - the group set to update

Returns:

the updated group

create

Group create(Group group)

create a new group

Parameters:

group - the group

Returns:

the newly created group

create

Group create(String domainId,
             String name,
             String description)

creates a new group

Parameters:

domainId - the domain id

name - the group name

description - the description

Returns:

the newly created group

list

List<? extends Group> list()

lists groups.

Returns:

list of groups

listGroupUsers

List<? extends User> listGroupUsers(String groupId)

lists the users that belong to a group

listProjectGroupRoles

List<? extends Role> listProjectGroupRoles(String groupId,
                                           String projectId)

list role for group on a project

Parameters:

groupId - the group id

projectId - the project id

Returns:

the list of project roles for the group

listDomainGroupRoles

List<? extends Role> listDomainGroupRoles(String groupId,
                                          String domainId)

list roles for a group on a domain

Parameters:

groupId - the group id

domainId - the domain id

Returns:

the list of domain roles for a group

addUserToGroup

ActionResponse addUserToGroup(String groupId,
                              String userId)

adds an existing user to a group

Parameters:

groupId - the group id

userId - the user id

Returns:

the ActionResponse

removeUserFromGroup

ActionResponse removeUserFromGroup(String groupId,
                                   String userId)

removes a user from a group

Parameters:

groupId - the group id

userId - the user id

Returns:

the ActionResponse

checkGroupUser

ActionResponse checkGroupUser(String groupId,
                              String userId)

check whether a user belongs to a group

Parameters:

groupId - the group id

userId - the user id

Returns:

the ActionResponse