org.jclouds.cloudstack.features

Interface GlobalUserClient

All Superinterfaces:

DomainUserClient

public interface GlobalUserClient
extends DomainUserClient

Provides synchronous access to CloudStack User features available to Global Admin users.

Author:

Andrei savu

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
User	createUser(String userName, String accountName, String email, String hashedPassword, String firstName, String lastName, CreateUserOptions... options) Create an user for an account that already exists
Void	deleteUser(String id) Delete an user with the specified ID
ApiKeyPair	registerUserKeys(String userId) This command allows a user to register for the developer API, returning a secret key and an API key
User	updateUser(String id, UpdateUserOptions... options) Update an user

Methods inherited from interface org.jclouds.cloudstack.features.DomainUserClient

disableUser, enableUser, listUsers

Method Detail

createUser

User createUser(String userName,
              String accountName,
              String email,
              String hashedPassword,
              String firstName,
              String lastName,
              CreateUserOptions... options)

Create an user for an account that already exists

Parameters:

userName - unique user name

accountName - Creates the user under the specified account. If no account is specified, the username will be used as the account name.

email -

hashedPassword - Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.

firstName -

lastName -

options - optional arguments

Returns:

registerUserKeys

ApiKeyPair registerUserKeys(String userId)

This command allows a user to register for the developer API, returning a secret key and an API key

Parameters:

userId - the ID of the user

Returns:

updateUser

User updateUser(String id,
              UpdateUserOptions... options)

Update an user

Parameters:

id - the user ID

options - optional arguments

Returns:

deleteUser

Void deleteUser(String id)

Delete an user with the specified ID

Parameters:

id - user ID