Help Center/ IAM Identity Center/ API Reference/ API/ SCIM User Management/ Deleting a User
Updated on 2024-04-10 GMT+08:00
View PDF
Share

Deleting a User

Function

This API is used to delete a user.

URI

DELETE /{tenant_id}/scim/v2/Users/{user_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

tenant_id

Yes

String

Globally unique ID of a tenant

user_id

Yes

String

Globally unique ID of a user

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Bearer token

Response Parameters

Status code: 400

Table 3 Parameters in the response body

Parameter

Type

Description

schema

String

Summary

schemas

Array of strings

Summary list

detail

String

Exception details

status

Integer

Status code

timeStamp

String

Timestamp

Status code: 403

Table 4 Parameters in the response body

Parameter

Type

Description

schema

String

Summary

schemas

Array of strings

Summary list

detail

String

Exception details

status

Integer

Status code

timeStamp

String

Timestamp

Status code: 404

Table 5 Parameters in the response body

Parameter

Type

Description

schema

String

Summary

schemas

Array of strings

Summary list

detail

String

Exception details

status

Integer

Status code

timeStamp

String

Timestamp

Status code: 409

Table 6 Parameters in the response body

Parameter

Type

Description

schema

String

Summary

schemas

Array of strings

Summary list

detail

String

Exception details

status

Integer

Status code

timeStamp

String

Timestamp

Status code: 500

Table 7 Parameters in the response body

Parameter

Type

Description

schema

String

Summary

schemas

Array of strings

Summary list

detail

String

Exception details

status

Integer

Status code

timeStamp

String

Timestamp

Example Request

Deleting a user

DELETE https://{hostname}/{tenant_id}/scim/v2/Users/{user_id}

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: SCIM User Management