Remove Users from an Identity Domain (v2)

This API accepts the list of users directly in the request payload. This topic describes the simplified v2 version of the REST API. This version contains all parameters in the payload and does not require URL encoding while calling the REST APIs, which makes the v2 API easier to use. It is synchronous and returns the outcome of the operation in the response.

Required Roles

Identity Domain Administrator and any application role (Service Administrator, Power User, User, or Viewer)

REST Resource

POST /interop/rest/security/v2/users/remove

Table 2-13 Tasks for Remove Users from an Identity Domain

Task	Request	REST Resource
Remove users	POST	/interop/rest/security/v2/users/remove

Request

Supported Media Types: application/json

Table 2-14 Parameters

Name	Description	Type	Required	Default
users	List of user login IDs of the users to remove	Payload	Yes	None

Example URL and Payload

https://<BASE-URL>/interop/rest/security/v2/users/remove

{
	"users": 
	[
		{
			"userlogin": "jdoe"
		},
		{
			"userlogin": "chris"
        		}
    	]
}

Response

Supported Media Types: application/json

Table 2-15 Parameters

Name	Description
links	Detailed information about the link and HTTP call type
status	Identifies the status of the operation 0: Operation succeeded 1: Operation failed
error	Detailed information about the error
details	Detailed status of the operation performed. Total number of records processed, succeeded, and failed and reason for why it failed.

Examples of Response Body

Example 1: Job Completes without Errors

{
	"links": {
    		"href": "https://<BASE-URL>/interop/rest/security/v2/users/remove",
    		"action": "POST"
	},
	"status": 0,
	"error": null,
	"details": {
		"processed": 2,
		"succeeded": 2,
		"failed": 0,
		"faileditems": null
	}

Example 2: Job Completes with Errors

{
	"links": {
    		"href": "https://<BASE-URL>/interop/rest/security/v2/users/remove",
    		"action": "POST"
	},
	"status": 1,
	"error": {
        		"errorcode": "EPMCSS-21147",
        		"errormessage": "Failed to remove users. Invalid or insufficient parameters specified. Provide all required parameters for the REST API."
    	},
	"details": null
}

Example 3: Job Completes with Partial Errors

{
	"links": {
    		"href": "https://<BASE-URL>/interop/rest/security/v2/users/remove",
    		"action": "POST"
	},
	"status": 0,
	"error": null,
	"details": {
		"processed": 5,
		"succeeded": 3,
		"failed": 2,
		"faileditems": 
		[
		{
               	 	"userlogin": "jdoe",
               	 	"errorcode": "EPMCSS-21174",
                		"errormessage": "Failed to remove user. User jdoe does not exist. Provide a valid userlogin."
            	},
           	 {
               		"userlogin": "chris",
                		"errorcode": "EPMCSS-21174",
                		"errormessage": " Failed to remove user. User chris does not exist. Provide a valid userlogin."
            	}
		]
	}
}
 

Sample cURL Command Basic Auth

curl -X POST -s -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/json' -d '{"users":[{"userlogin":"jdoe"},{"userlogin":"chris"}]}' 'https://<BASE-URL>/interop/rest/security/v2/users/remove'

Sample cURL Command OAuth 2.0

curl -X POST --header "Authorization: Bearer <OAUTH_ACCESS_TOKEN>" -H 'Content-Type: application/json'  -d '{"users":[{"userlogin":"jdoe"},{"userlogin":"chris"}]}' 'https://<BASE-URL>/interop/rest/security/v2/users/remove'