Previous Topic: destroy Method (user Object)Next Topic: unlock Method (user Object)


set Method (user Object)
Description

Set information for a user

Syntax
/api/v1/user/set?user=user&vdc=controller-name 
Arguments
user

Name of the user

vdc

Name of the target virtual data center

Options
group

A comma-separated list of groups the user must become a member of

The first group in the list becomes the user’s primary group.

keyN=valueN

User profile property settings

Option flags
pwd

User’s password

sshkey

A public SSH key to install as the user’s access key to the CLI.

Must be either RSA or DSA base-64 encoded.

Note: See User Management in the Command Line Shell Reference for descriptions of the options available for this command.

Transaction Type

synchronous

Request Type

GET

Examples

Set real name for a user named test@CA.com.

GET http://192.168.123.200/api/v1/user/set?user=test@CA.com&realname=John&vdc=mygrid 
Sample Output
XML:
<opt></opt>
JSON:
{} 

HTTP Error Codes
404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

400.4

Missing required arguments (user). - Argument user=username missing in the request.

404.1

unknown@CA.NOSPAM.com does not exist. - Invalid user specified in the request.