Help Center> Organizations> API Reference> API> Managing Trusted Services> Disabling a Trusted Service
Updated on 2024-05-28 GMT+08:00
View PDF

Disabling a Trusted Service

Function

This API is used to disable the integration of a cloud service (specified by service_principal) with Organizations. After you disable a trusted service, the service no longer can create a service-linked agency in new accounts in your organization. This means the service no longer can perform operations on your behalf on any new accounts in your organization. The service can still perform operations in the old accounts until the service completes its cleanup from Organizations. This API can be called only from the organization's management account.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v1/organizations/trusted-services/disable

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Minimum: 1
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

service_principal

Yes

String

Name of the service principal.

Minimum: 0

Maximum: 100

Response Parameters

None

Example Requests

Disabling a trusted service

POST https://{hostname}/v1/organizations/trusted-services/disable

{
  "service_principal" : "string"
}

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.