Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Management APIs/ Application Role Management/ Deleting an Application Role Member
Updated on 2024-12-30 GMT+08:00
View PDF
Share

Deleting an Application Role Member

Function

This API is used to delete an application role member.

URI

DELETE /api/v2/tenant/applications/{application_id}/role-member

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Set this field to "application/json;charset=utf8".

Authorization

Yes

String

Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

role_id

Yes

String

Role ID.

account_Ids

Yes

Array of strings

Application account ID set. Max. 50 IDs are supported.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

success_list

Array of strings

List of successfully added members.

fail_list

Array of strings

List of members failing to be added.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Delete an application role member based on the application ID. Application role ID: 20220420144449385-C66D-E8C1D1D79; Application account IDs: ["20220415171558023-84A4-ED5C390B8", "20220414163425614-2FD6-CA9B208BE"].

DELETE https://{domain_name}/api/v2/tenant/applications/{application_id}/role-member

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

{
  "role_id": "20220420144449385-C66D-E8C1D1D79",
  "account_Ids": [
    "20220415171558023-84A4-ED5C390B8",
    "20220414163425614-2FD6-CA9B208BE"
  ]
}

Example Responses

Status code: 200

Application account ID list.

{
  "success_list" : [ "20220415171558023-84A4-ED5C390B8", "20220414163425614-2FD6-CA9B208BE" ],
  "fail_list" : [ ]
}

Status Codes

Status Code

Description

200

Application account ID list.

400

Request failed.

Error Codes

See Error Codes.