This API will delete the user, if exists already in system.

End Point:
/api/pi-api/v1/syscon/users/$userId

Method:
DELETE

Request Headers:

Header	Value	Description
Authorization	"Signature keyId=<tenantId>,algorithm=<algorithm>,headers=(<space separated list of header names used at request signing>),signature=<signature>"	Signature detail to check authorization to call API

Path Params:

Key

Data Type

Mandatory

Description

userId

String

Yes

External reference ID of user that uniquely identifies the user in partner systems.

This is case sensitive value - so make sure to use it consistently across API interactions

Max length of string supported is 320 characters.

Response Object:

status

200, if successful

body.message

Message indicating the status of operation, in case API is not successful and returns HTTP status code other than 200.

The message is indicative and is not localized / internationalized value to use at display; and applications should not rely on this message.