Delete User By Name

This operation deletes a user.

Path Parameters

• UserName string required

  Name of the user

Query Parameters

• newUserId string

  Id of the user to which the properties be transferred. Also can give name of the user by "newUserId=byName(userName='{NewUserName')"

• newUserGroupId string

  Id of the user group to which the properties be transferred. Also can give name of the user group by "newUserId=byName(userGroupName='{NewUserGroupName')"

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• User deletion

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  errorString string

  errorCode integer

  warningMessage string

  entity object

  userId integer

  userName string

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

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorString": "Success",
      "errorCode": 0,
      "warningMessage": "",
      "entity": {
        "userId": 1047,
        "userName": "postmanUser"
      }
    }
  ]
}

DELETE /User/byName(userName=':UserName')    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

UserName — path required

newUserId — query

newUserGroupId — query

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'