Listing Delegated Administrator Accounts

Function

This API is used to list the accounts that are designated as delegated administrators in an organization. It can be called only from the organization's management account or from a member account that is a delegated administrator for a cloud service.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:delegatedAdministrators:list	List	-	organizations:ServicePrincipal	-	-

URI

GET /v1/organizations/delegated-administrators

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
service_principal	No	String	Name of the service principal.
limit	No	Integer	Maximum number of results on the page. If the limit is not specified, the default value is 1,000.
marker	No	String	Pagination marker.

Request Parameters

**Table 2** 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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
delegated_administrators	Array of DelegatedAdministratorDto objects	List of delegated administrators in an organization.
page_info	PageInfoDto object	Pagination information.

**Table 4** DelegatedAdministratorDto
Parameter	Type	Description
delegation_enabled_at	String	Date when the account was designated as a delegated administrator.
account_id	String	Unique ID of an account.
account_urn	String	Uniform resource name of the account.
join_method	String	How an account joined an organization.
joined_at	String	Date when an account became a part of an organization.
account_name	String	Account name.

**Table 5** PageInfoDto
Parameter	Type	Description
next_marker	String	Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null.
current_count	Integer	Number of items returned on the current page.

Example Requests

Listing delegated administrator accounts

GET /v1/organizations/delegated-administrators

Example Responses

Status code: 200

Successful.

{
  "delegated_administrators" : [ {
    "delegation_enabled_at" : "autoservice0922102321263V58H",
    "account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "account_urn" : "urnstring",
    "join_method" : "invited",
    "joined_at" : "2022-08-24T06:41:15Z",
    "account_name" : "paas_iam_573331"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}