Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

DELETE /staged_config/access/users/{id}

Deletes a user from staging. To ensure safe deletion, dependencies are checked. This might take some time. An asynchronous task is started to do this check.

Deletes a user from staging. To ensure safe deletion, dependencies are checked. This might take some time. An asynchronous task is started to do this check.

Table 1: DELETE /staged_config/access/users/{id} Resource Details

MIME Type

application/json

Table 2: DELETE /staged_config/access/users/{id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

Number (Integer)

text/plain

null

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: DELETE /staged_config/access/users/{id} Response Codes

HTTP Response Code

Unique Code

Description

202

 

The User delete command has been accepted and is in progress

403

1009

You do not have the proper capabilities to delete the User

404

1002

The User does not exist

500

1020

An error occurred while attempting to delete the User

Response Description

A Delete Task Status object and the location header set to the task status url "/api/staged_config/access/user_delete_tasks/{task_id}". A Delete Task Status object contains the following fields:

  • id - Long - The ID of the task.

  • message - String - The localized task message.

  • status - String - The current state of the task.

  • name - String - The name of the task.

  • created_by - String - The name of the user who started the task.

  • created - Long - The time in milliseconds since epoch since the task was created.

  • started - Long - The time in milliseconds since epoch since the task was started.

  • modified - Long - The time in milliseconds since epoch since the task was modified.

  • completed - Long - The time in milliseconds since epoch since the task was completed.

Response Sample