Delete multiple users

DELETE 
/api/web/v3/users/multiple

Delete multiple users. Caller requires the USERS:REMOVE permission.

Request

application/json

Body

required

stopOnError boolean

If set to true, the operation stops on the first operation that fails. Otherwise the operation continues for each specified user. If not specified, this defaults to false.

users

object[]

required

The list of users to be deleted.

Array [

id stringrequired

The id of the user to be deleted. The type of the id is specified by idType.

idType string

Possible values: [UUID, USERID, EXTERNALID]

The type of the id identifying the user. The value can be one of UUID (the user's internal UUID), USERID (the user's userId) or EXTERNALID (the externalId of the user). If not specified, this defaults to UUID.

]

Responses

200

Successful

application/json

Schema

Schema

• Array [

error

object

Object containing information about errors reported by services.

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

success booleanrequired

Indicates if the user was successfully deleted (true) or not (false).

• ]

Example (from schema)

[
  {
    "error": {
      "errorCode": "invalid_user_response",
      "errorMessage": "Application id cannot be null",
      "parameters": [
        {}
      ]
    },
    "success": true
  }
]

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...