Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ IAM/ Managing Agencies and Trust Agencies/ Deleting a Service-linked Agency
Updated on 2026-07-22 GMT+08:00
View PDF
Share

Deleting a Service-linked Agency

Function

This API is used to delete a service-linked agency.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

iam:agencies:deleteServiceLinkedAgencyV5

Write

agency *

g:ResourceTag/<tag-key>

-

-

-

iam:ServicePrincipal

URI

DELETE /v5/service-linked-agencies/{agency_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

agency_id

Yes

String

Definition:

Agency or trust agency ID.

Constraints:

The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.

Range:

N/A

Default Value:

N/A

Request Parameters

None

Response Parameters

Status code: 202

Table 2 Response body parameters

Parameter

Type

Description

deletion_task_id

String

Definition:

ID of a deleted task.

Range:

N/A

Status code: 403

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

encoded_authorization_message

String

Definition :

Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link.

Range:

N/A.

Status code: 404

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

Status code: 409

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

Example Requests

Deleting a service-linked agency

DELETE https://{endpoint}/v5/service-linked-agencies/{agency_id}

Example Responses

Status code: 202

Successful

{
  "deletion_task_id" : "task"
}

Status Codes

Status Code

Description

202

Successful

403

Forbidden

404

Not found

409

Conflict

Error Codes

See Error Codes.