Listing Accounts Accessible to Federated Users

Updated on 2023-09-14 GMT+08:00

View PDF

Function

This API is used to list the accounts whose resources are accessible to federated users.

The API can be called using both the global endpoint and region-specific endpoints.

NOTE:

The API used to list the accounts accessible to an IAM user is recommended because it can return the same response.

URI

GET /v3/OS-FEDERATION/domains

Request Parameters

**Table 1** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Unscoped token.

Response Parameters

**Table 2** Parameters in the response body
Parameter	Type	Description
domains	Array of objects	Account information.
links	Object	Resource link information.

**Table 3** domains
Parameter	Type	Description
enabled	Boolean	Indicates whether an account is enabled. true (default value) indicates that the account is enabled. false indicates that the account is disabled.
id	String	Account ID.
name	String	Account name.
links	Object	Account resource link.
description	String	Description of the account.

**Table 4** domains.links
Parameter	Type	Description
self	String	Resource link.

**Table 5** links
Parameter	Type	Description
self	String	Resource link.

Example Request

Request for querying accounts accessible to federated users

GET https://iam.myhuaweicloud.eu/v3/OS-FEDERATION/domains

Example Response

Status code: 200

The request is successful.

{
    "domains": [
        {
            "description": "",
            "enabled": true,
            "id": "d78cbac186b744899480f25bd022f468",
            "links": {
                "self": "https://iam.myhuaweicloud.eu/v3/domains/d78cbac186b744899480f25bd022f468"
            },
            "name": "IAMDomain"
        }
    ],
    "links": {
        "self": "https://iam.myhuaweicloud.eu/v3/OS-FEDERATION/domains"
    }
}

Status Codes

Status Code	Description
200	The request is successful.
400	Invalid parameters.
401	Authentication failed.
403	Access denied.
405	The method specified in the request is not allowed for the requested resource.
413	The request entity is too large.
500	Internal server error.
503	Service unavailable.