Child pages
  • Admin API Method createUser

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
This function will create a user/contact with the given user details and returns the newly created User.
Style
Document
Input (Literal)
The input of this method is the argument createUser of type createUser having the structure defined by the following table.

Element

Type

Occurs

Description

userDetails

userDetails

0..1

Details of the user to be created

password

string

0..1

Plain text password to use

passwordHash

string

0..1

A hashed password value; supported hash formats are: MD5, SHA, SHA256, htpasswd -m, htpasswd -s and mysql hashes

customerUUID

string

0..1

The uuid of the customer to which this user belongs

isAdmin

boolean

1..1

A flag indicating whether the user becomes the owner of the customer

Output (Literal)
The output of this method is the argument createUserResponse of type createUserResponse having the structure defined by the following table.

Element

Type

Occurs

Description

user

userDetails

0..1

UserDetail object, with the UUID of the user populated

Remarks
A password can be specified either as a hash or in plaintext. If both are supplied, the plain text password will be given precedence. On successful execution, a UserDetail object will be returned. On an exception, the user is not created.
THIS IS THE TEXT LOADED FROM THE COMMENT FILE GIHAN

  • No labels