Update User Properties (Deprecated)

Select

SaaS

Customer Managed

deprecated

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

This operation updates the properties associated with a user.

More Details

Path Parameters

• UserId string required

application/json

Request Body required

• users object[]

  agePasswordDays int32

  associatedUserGroups object[]

  userGroupName string

  associatedUserGroupsOperationType int32

  description string

  email string

  enableUser boolean

  fullName string

  password string

  userEntity object

  userName string

  validationParameters object

  password string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

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"
      }
    }
  ]
}

POST /user/:userid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

UserId — path required

Body required

• Default
• Example

---

{
  "users": [
    {
      "agePasswordDays": 120,
      "associatedUserGroups": [
        {
          "userGroupName": "View All"
        }
      ],
      "associatedUserGroupsOperationType": 2,
      "description": "Modifying description",
      "email": "jdoe@company.com",
      "enableUser": true,
      "fullName": "Jane Doe",
      "password": "########",
      "userEntity": {
        "userName": "jdoe"
      },
      "validationParameters": {
        "password": "########"
      }
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/:UserId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "agePasswordDays": 120,
      "associatedUserGroups": [
        {
          "userGroupName": "View All"
        }
      ],
      "associatedUserGroupsOperationType": 2,
      "description": "Modifying description",
      "email": "jdoe@company.com",
      "enableUser": true,
      "fullName": "Jane Doe",
      "password": "########",
      "userEntity": {
        "userName": "jdoe"
      },
      "validationParameters": {
        "password": "########"
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/:UserId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "agePasswordDays": 120,
      "associatedUserGroups": [
        {
          "userGroupName": "View All"
        }
      ],
      "associatedUserGroupsOperationType": 2,
      "description": "Modifying description",
      "email": "jdoe@company.com",
      "enableUser": true,
      "fullName": "Jane Doe",
      "password": "########",
      "userEntity": {
        "userName": "jdoe"
      },
      "validationParameters": {
        "password": "########"
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/:UserId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "agePasswordDays": 120,
      "associatedUserGroups": [
        {
          "userGroupName": "View All"
        }
      ],
      "associatedUserGroupsOperationType": 2,
      "description": "Modifying description",
      "email": "jdoe@company.com",
      "enableUser": true,
      "fullName": "Jane Doe",
      "password": "########",
      "userEntity": {
        "userName": "jdoe"
      },
      "validationParameters": {
        "password": "########"
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/:UserId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "agePasswordDays": 120,
      "associatedUserGroups": [
        {
          "userGroupName": "View All"
        }
      ],
      "associatedUserGroupsOperationType": 2,
      "description": "Modifying description",
      "email": "jdoe@company.com",
      "enableUser": true,
      "fullName": "Jane Doe",
      "password": "########",
      "userEntity": {
        "userName": "jdoe"
      },
      "validationParameters": {
        "password": "########"
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/:UserId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "agePasswordDays": 120,
      "associatedUserGroups": [
        {
          "userGroupName": "View All"
        }
      ],
      "associatedUserGroupsOperationType": 2,
      "description": "Modifying description",
      "email": "jdoe@company.com",
      "enableUser": true,
      "fullName": "Jane Doe",
      "password": "########",
      "userEntity": {
        "userName": "jdoe"
      },
      "validationParameters": {
        "password": "########"
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/:UserId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "agePasswordDays": 120,
      "associatedUserGroups": [
        {
          "userGroupName": "View All"
        }
      ],
      "associatedUserGroupsOperationType": 2,
      "description": "Modifying description",
      "email": "jdoe@company.com",
      "enableUser": true,
      "fullName": "Jane Doe",
      "password": "########",
      "userEntity": {
        "userName": "jdoe"
      },
      "validationParameters": {
        "password": "########"
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/:UserId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "users": [
    {
      "agePasswordDays": 120,
      "associatedUserGroups": [
        {
          "userGroupName": "View All"
        }
      ],
      "associatedUserGroupsOperationType": 2,
      "description": "Modifying description",
      "email": "jdoe@company.com",
      "enableUser": true,
      "fullName": "Jane Doe",
      "password": "########",
      "userEntity": {
        "userName": "jdoe"
      },
      "validationParameters": {
        "password": "########"
      }
    }
  ]
}'