Help Center/ Organizations/ API Reference/ APIs/ Managing Trusted Services/ Enabling a Trusted Service
Updated on 2024-10-21 GMT+08:00
View PDF
Share

Enabling a Trusted Service

Function

This API is used to enable the integration of a cloud service (specified by service_principal) with Organizations. When you enable a trusted service, you allow the trusted service to create a service-linked agency in all accounts in your organization. This allows the trusted service to perform operations on your behalf in your organization and its accounts. 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 https://{endpoint}/v1/organizations/trusted-services/enable

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.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

service_principal

Yes

String

Name of the service principal.

Response Parameters

None

Example Requests

Enabling a trusted service

POST https://{endpoint}/v1/organizations/trusted-services/enable

{
  "service_principal" : "string"
}

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.