Create User (Deprecated)

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

This operation creates a user.

More Details

application/json

Request Body

users object[]
description string
A general description of the user account
email string
The email address of the user.
fullName string
The full name of the user
password string
The password of the user to access the user account. The password must be in Base64 encoded in JSON request
agePasswordDays integer
The number of days to keep the password active.
enableUser boolean
The option to enable/disable the user
userEntity object
userName string
The name of the user.
securityAssociations object
associations object[]
entities object
entity object[]
name of the entity to be associated
properties object
role object
_type_ integer
Specify the type of permissions that are included in the role
roleId integer
Id of the role
roleName string
Name of the role
associationsOperationType string
Type of operation. eg: ADD
associatedUserGroups object[]
userGroupName string
The name of the user group associated with the user

Responses

application/json

Schema
Example (from schema)
Create user response

Schema

processinginstructioninfo object
attributes object[]
name string
value string
response object[]
errorString string
errorCode integer
entity object
userId integer
userName string

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorString": "string",
      "errorCode": 0,
      "entity": {
        "userId": 0,
        "userName": "string"
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorString": "Successful",
      "errorCode": 0,
      "warningMessage": "",
      "entity": {
        "userId": 3144,
        "userGUID": "643DF0A1-900E-4509-BCB4-9BE8543C11A9",
        "userName": "j_doe"
      }
    }
  ]
}

POST /user

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

Body

Default
Create user request

{
  "users": [
    {
      "description": "string",
      "email": "string",
      "fullName": "string",
      "password": "string",
      "agePasswordDays": 0,
      "enableUser": true,
      "userEntity": {
        "userName": "string"
      },
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {}
              ]
            },
            "properties": {
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ],
        "associationsOperationType": "string"
      },
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ]
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "description": "string",
      "email": "string",
      "fullName": "string",
      "password": "string",
      "agePasswordDays": 0,
      "enableUser": true,
      "userEntity": {
        "userName": "string"
      },
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {}
              ]
            },
            "properties": {
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ],
        "associationsOperationType": "string"
      },
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "description": "string",
      "email": "string",
      "fullName": "string",
      "password": "string",
      "agePasswordDays": 0,
      "enableUser": true,
      "userEntity": {
        "userName": "string"
      },
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {}
              ]
            },
            "properties": {
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ],
        "associationsOperationType": "string"
      },
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "description": "string",
      "email": "string",
      "fullName": "string",
      "password": "string",
      "agePasswordDays": 0,
      "enableUser": true,
      "userEntity": {
        "userName": "string"
      },
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {}
              ]
            },
            "properties": {
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ],
        "associationsOperationType": "string"
      },
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "description": "string",
      "email": "string",
      "fullName": "string",
      "password": "string",
      "agePasswordDays": 0,
      "enableUser": true,
      "userEntity": {
        "userName": "string"
      },
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {}
              ]
            },
            "properties": {
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ],
        "associationsOperationType": "string"
      },
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "description": "string",
      "email": "string",
      "fullName": "string",
      "password": "string",
      "agePasswordDays": 0,
      "enableUser": true,
      "userEntity": {
        "userName": "string"
      },
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {}
              ]
            },
            "properties": {
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ],
        "associationsOperationType": "string"
      },
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "description": "string",
      "email": "string",
      "fullName": "string",
      "password": "string",
      "agePasswordDays": 0,
      "enableUser": true,
      "userEntity": {
        "userName": "string"
      },
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {}
              ]
            },
            "properties": {
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ],
        "associationsOperationType": "string"
      },
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "description": "string",
      "email": "string",
      "fullName": "string",
      "password": "string",
      "agePasswordDays": 0,
      "enableUser": true,
      "userEntity": {
        "userName": "string"
      },
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {}
              ]
            },
            "properties": {
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ],
        "associationsOperationType": "string"
      },
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ]
    }
  ]
}'

Create User (Deprecated)​

Authorization

Request

Create User (Deprecated)