User create request

Description

Creates a user with specified details. It performs all the steps required to create entries in core user and people forms and onboard the user so that the user is usable through BMC Cloud Lifecycle Management without any manual step. Refer to the Privilege class to specify appropriate privileges for the user.

API stability classification

Unassigned

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/User/create

void

 Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Name

Type

 

Multi-
plicity

Description

callbackURL

String

 0..1

URL to call when the operation finishes

postCallout

String

 0..1

Identifier of a callout to run after the operation executes

preCallout

String

 0..1

Identifier of a callout to run before the operation executes

timeout

Integer

 0..1

Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

operationParams

OperationParameter

 1

Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.


Input parameters to include in operationParams

Name

Type

Multi-
plicity

Description

additionalInfo

NameValuePair

 0..*

Additional information about organization, specify in key value format. Internal business logic will not use these key-value pairs, however callouts can make use of these.

isRemote

Boolean

 0..1

Reserved. This parameter should not be passed or pass 'false' value.

user

User

 1

User object with all the required attributes. The minimum expected is user name and password. If the role is not specified, the default role is assigned from signupRole access attribute value specified in the providers.json file.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.

Example

The following example shows an HTTP request for the API that creates a user with specified details.


  {
  "timeout": 1000000,
  "operationParams": [{
                              "name": "user",
                               "value": {
                                         "cloudClass": "com.bmc.cloud.model.beans.User",
                                         "description": "create call",
                                         "firstName": "<First Name>",
                                         "lastName": "<Last Name>",
                                         "email": "<Email ID>",
                                         "customFieldsObject": [{
                                                                       "cloudClass": "com.bmc.cloud.model.beans.CustomField",
                                                                       "name": "ctm_people.1000001437",
                                                                       "description": "TemplateName",
                                                                       "stringValue": "Cloud Organization Admin", --> Same role name as seen in the CLM Admin Console
                                                                       "type": "String"
                                                                           }
                                                            ],
                                          "name": "<Login Name>",
                                          "password": "plaintext:password",
                                          "primaryOrganization": "<Organization Name>",
                                          "foundationLocationObject": {
                                         		 "cloudClass": "com.bmc.cloud.model.beans.FoundationLocation",
                                         		 "name": "<Site Name>"
                                                            }
                                             },
                                  "type": "com.bmc.cloud.model.beans.User",
                                  "multiplicity": "1"
                              }, {
                                   "name": "isRemote",
                                   "value": true,
                                   "type": "java.lang.Boolean",
                                   "multiplicity": "0..1"
                              }
               ],
  "postCallout": "",
  "callbackURL": "",
  "preCallout": ""
}


Was this page helpful? Yes No Submitting... Thank you

Comments