Help Center> Organizations> API Reference> API> Managing Delegated Administrators> Registering a Delegated Administrator
Updated on 2024-03-15 GMT+08:00

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.

URI

POST /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.

Minimum: 1

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

service_principal

Yes

String

Name of the service principal.

Minimum: 1

Maximum: 100

account_id

Yes

String

Unique ID of an account.

Maximum: 36

Response Parameters

None

Example Requests

Registering a delegated administrator

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

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

Example Responses

None

Status Codes

Status Code

Description

201

Successful.

Error Codes

See Error Codes.