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


@Beta
public interface UserApi

Provides synchronous access to the KeyStone User API.

Author:
Adam Lowe
See Also:
UserAsyncApi,

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<? extends User> list()
          Retrieve the list of users

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

 PaginatedCollection<? extends User> list(PaginationOptions options)
           
 Set<? extends Role> listRolesOfUser(String userId)
          Retrieves the list of global roles associated with a specific user (excludes tenant roles).
 Set<? extends Role> listRolesOfUserOnTenant(String userId, String tenantId)
          List the roles a user has been granted on a specific tenant
 

Method Detail

list

org.jclouds.collect.PagedIterable<? extends 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

PaginatedCollection<? extends User> list(PaginationOptions options)

get

User get(String userId)
Retrieve information about a user, by user ID

Returns:
the information about the user

getByName

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

Set<? extends 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

Set<? extends Role> listRolesOfUserOnTenant(String userId,
                                            String tenantId)
List the roles a user has been granted on a specific tenant

Returns:
the set of roles


Copyright © 2009-2013 The Apache Software Foundation. All Rights Reserved.