This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

DeleteBulkUsers

1: 1.2
2: 1.1
3: 1.0

1 - 1.2

delete /v1/users

Description

delete bulk users

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		UserDeleteBulkRequest

Responses

HTTP Code	Description	Schema
200	OK	UserRemoveResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.2"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

2 - 1.1

delete /v1/users

Description

delete bulk users

State ACTIVE (SUPPORTED)

Version	Supported Until
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		UserDeleteBulkRequest

Responses

HTTP Code	Description	Schema
200	OK	UserRemoveResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.1"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

3 - 1.0

delete /v1/users

Description

delete bulk users

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260223

Parameters

Type	Name	Description	Schema	Default
body	body required		UserDeleteBulkRequest

Responses

HTTP Code	Description	Schema
200	OK	UserRemoveResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.0"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}