Integration Guides › Web Service API Reference Guide › Valid Web API Objects › user Object › create Method (user Object)

create Method (user Object)

Description

Create a user

Syntax

/api/v1/user/create?user=user&pwd=password&vdc=controller-name 

Arguments

user

Username

pwd

User password

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

Create a user named test@CA.com.

GET http://192.168.123.200/api/v1/user/create?user=test@CA.com&pwd=password&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.

400.4

Missing required arguments (pwd). - Argument pwd=password missing in the request.

404.1

unknown@CA.NOSPAM.com already exists. - User specified in the request already exists.