org.jclouds.iam.features

Interface UserApi

public interface UserApi

Author:

Adrian Cole

See Also:

UserAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
User	get(String name) Retrieves information about the specified user, including the user's path, GUID, and ARN.
User	getCurrent() Retrieves information about the current user, including the user's path, GUID, and ARN.
PagedIterable<User>	list() returns all users in order.
IterableWithMarker<User>	listAt(String marker) retrieves up to 100 users in order, starting at marker
IterableWithMarker<User>	listFirstPage() retrieves up to 100 users in order.
PagedIterable<User>	listPathPrefix(String pathPrefix) returns all users in order at the specified pathPrefix.
IterableWithMarker<User>	listPathPrefixAt(String pathPrefix, String marker) retrieves up to 100 users in order at the specified pathPrefix, starting at marker.
IterableWithMarker<User>	listPathPrefixFirstPage(String pathPrefix) retrieves up to 100 users in order at the specified pathPrefix.

Method Detail

getCurrent

User getCurrent()

Retrieves information about the current user, including the user's path, GUID, and ARN.

list

PagedIterable<User> list()

returns all users in order.

listFirstPage

IterableWithMarker<User> listFirstPage()

retrieves up to 100 users in order.

listAt

IterableWithMarker<User> listAt(String marker)

retrieves up to 100 users in order, starting at marker

Parameters:

marker - starting point to resume the list

listPathPrefix

PagedIterable<User> listPathPrefix(String pathPrefix)

returns all users in order at the specified pathPrefix.

Parameters:

pathPrefix - ex. /division_abc/subdivision_xyz/

listPathPrefixFirstPage

IterableWithMarker<User> listPathPrefixFirstPage(String pathPrefix)

retrieves up to 100 users in order at the specified pathPrefix.

Parameters:

pathPrefix - ex. /division_abc/subdivision_xyz/

listPathPrefixAt

IterableWithMarker<User> listPathPrefixAt(String pathPrefix,
                                        String marker)

retrieves up to 100 users in order at the specified pathPrefix, starting at marker.

Parameters:

pathPrefix - ex. /division_abc/subdivision_xyz/

marker - starting point to resume the list

get

@Nullable
User get(String name)

Retrieves information about the specified user, including the user's path, GUID, and ARN.

Parameters:

name - Name of the user to get information about.

Returns:

null if not found