Registering a Delegated Administrator

Function

This API is used to register the specified member account as a delegated administrator to manage the Organizations functions of a specified service. This API grants the delegated administrator the read-only access to Organizations service data. IAM users in the delegated administrator account still need IAM permissions to access and manage the specified service. 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/delegated-administrators/register

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.
account_id	Yes	String	Unique ID of an account.

Response Parameters

None

Example Requests

Registering a delegated administrator

POST https://{endpoint}/v1/organizations/delegated-administrators/register

{
  "service_principal" : "string",
  "account_id" : "_Auft226uZhGFRo5R8unWGQZ5N48PgFrfwyc"
}