User Offboard

Select

SaaS

Customer Managed

This operation identifies all the subclients and Virtual Machine clients that are associated with a user and offboards them for the specific user.

More Details

application/json

Request Body required

• userName string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Successfully offboarded user 1251",
  "errorCode": 0
}

POST /user/offboard    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body required

• Default
• Example

---

{
  "userName": "tapicompany/tapicompany"
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "userName": "tapicompany/tapicompany"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "userName": "tapicompany/tapicompany"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "userName": "tapicompany/tapicompany"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "userName": "tapicompany/tapicompany"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "userName": "tapicompany/tapicompany"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "userName": "tapicompany/tapicompany"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/User/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "userName": "tapicompany/tapicompany"
}'