org.jclouds.vcloud.director.v1_5.features.admin
Interface UserApi

public interface UserApi

Provides synchronous access to User objects.

Author:

danikov, Adrian Cole

See Also:

UserAsyncApi

Method Summary

User	addUserToOrg(User user, String orgUrn) Creates or imports a user in an organization.
User	addUserToOrg(User user, URI orgAdminHref)
User	edit(String userUrn, User user) Modifies a user.
User	edit(URI userHref, User user)
User	get(String userUrn) Retrieves a user.
User	get(URI userHref)
void	remove(String userUrn) Deletes a user.
void	remove(URI userHref)
void	unlock(String userUrn) Unlocks a user.
void	unlock(URI userHref)

Method Detail

addUserToOrg

User addUserToOrg(User user,
                  String orgUrn)

Creates or imports a user in an organization. The user could be enabled or disabled.

 POST /admin/org/{id}/users
 

Parameters:

orgUrn - the urn for the org

Returns:

the addd user

addUserToOrg

User addUserToOrg(User user,
                  URI orgAdminHref)

get

User get(String userUrn)

Retrieves a user. This entity could be enabled or disabled.

 GET /admin/user/{id}
 

Parameters:

userUrn - the reference for the user

Returns:

a user

get

User get(URI userHref)

edit

User edit(String userUrn,
          User user)

Modifies a user. The user object could be enabled or disabled. Note: the lock status cannot be changed using this call: use unlockUser.

 PUT /admin/user/{id}
 

Parameters:

userUrn - the reference for the user

Returns:

the modified user

edit

User edit(URI userHref,
          User user)

remove

void remove(String userUrn)

Deletes a user. Enabled and disabled users could be removed.

 DELETE /admin/catalog/{id}
 

remove

void remove(URI userHref)

unlock

void unlock(String userUrn)

Unlocks a user.

 POST /admin/user/{id}/action/unlock
 

unlock

void unlock(URI userHref)