Package org.jclouds.cloudstack.features

Interface GlobalUserApi

All Superinterfaces:

DomainUserApi

public interface GlobalUserApi
extends DomainUserApi

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

See Also:

Method Summary

Modifier and Type

Method

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.DomainUserApi

disableUser, enableUser, listUsers

Method Details

createUser

@Named("createUser")
@GET
@Consumes("application/json")
User createUser(@QueryParam("username")
 String userName,
 @QueryParam("account")
 String accountName,
 @QueryParam("email")
 String email,
 @QueryParam("password")
 String hashedPassword,
 @QueryParam("firstname")
 String firstName,
 @QueryParam("lastname")
 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

@Named("registerUserKeys")
@GET
@Consumes("application/json")
ApiKeyPair registerUserKeys(@QueryParam("id")
 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

@Named("updateUser")
@GET
@Consumes("application/json")
User updateUser(@QueryParam("id")
 String id,
 UpdateUserOptions... options)

Update an user

Parameters:

id - the user ID

options - optional arguments

Returns:

deleteUser

@Named("deleteUser")
@GET
@Consumes("application/json")
void deleteUser(@QueryParam("id")
 String id)

Delete an user with the specified ID

Parameters:

id - user ID