org.jclouds.openstack.keystone.v2_0.features
Interface UserApi

public interface UserApi

Provides access to the Keystone User API.

Method Summary

User	get(String userId) Retrieve information about a user, by user ID
User	getByName(String userName) Retrieve information about a user, by user name NOTE: currently not working in openstack ( https://bugs.launchpad.net/keystone/+bug/956687 )
org.jclouds.collect.PagedIterable<User>	list() Retrieve the list of users NOTE: this method is not in API documentation for keystone, but does work
PaginatedCollection<User>	list(PaginationOptions options)
Set<Role>	listRolesOfUser(String userId) Retrieves the list of global roles associated with a specific user (excludes tenant roles).
Set<Role>	listRolesOfUserOnTenant(String userId, String tenantId) List the roles a user has been granted on a specific tenant

Method Detail

list

@Named(value="user:list")
org.jclouds.collect.PagedIterable<User> list()

Retrieve the list of users

NOTE: this method is not in API documentation for keystone, but does work

Returns:

the list of users

list

@Named(value="user:list")
PaginatedCollection<User> list(PaginationOptions options)

get

@Named(value="user:get")
@Nullable
User get(String userId)

Retrieve information about a user, by user ID

Returns:

the information about the user

getByName

@Named(value="user:getByName")
@Nullable
User getByName(String userName)

Retrieve information about a user, by user name

NOTE: currently not working in openstack ( https://bugs.launchpad.net/keystone/+bug/956687 )

Returns:

the information about the user

listRolesOfUser

@Named(value="user:listRolesOfUser")
Set<Role> listRolesOfUser(String userId)

Retrieves the list of global roles associated with a specific user (excludes tenant roles).

NOTE: Broken in openstack ( https://bugs.launchpad.net/keystone/+bug/933565 )

Returns:

the set of Roles granted to the user

listRolesOfUserOnTenant

@Named(value="user:listRolesOfUserOnTenant")
Set<Role> listRolesOfUserOnTenant(String userId,
                                        String tenantId)

List the roles a user has been granted on a specific tenant

Returns:

the set of roles