Updated on 2024-07-30 GMT+08:00

Listing Projects Accessible to Federated Users

Function

This API is used to list the projects in which resources are accessible to federated users.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

URI

GET /v3/OS-FEDERATION/projects

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

links

Object

Resource link information.

projects

Array of objects

Project information.

Table 4 projects

Parameter

Type

Description

is_domain

Boolean

The value is false.

description

String

Description of the project.

links

Object

Project resource link.

enabled

Boolean

Enabling status of the project.

id

String

Project ID.

parent_id

String

ID of the specified subproject or account ID of a specified system project, for example, the ap-southeast-1 project.

domain_id

String

Account ID of the project.

name

String

Project name.

Example Request

GET https://iam.myhuaweicloud.com/v3/OS-FEDERATION/projects

Example Response

Status code: 200

The request is successful.

{
    "projects": [
        {
            "domain_id": "d78cbac186b744899480f25...",
            "is_domain": false,
            "parent_id": "d78cbac186b744899480f2...",
            "name": "af-south-1",
            "description": "",
            "links": {
                "self": "https://iam.myhuaweicloud.com/v3/projects/06f1cbbaf280106b2f14c00313a9d065"
            },
            "id": "06f1cbbaf280106b2f14c00313a9...",
            "enabled": true
        },
        {
            "domain_id": "d78cbac186b744899480f25bd02...",
            "is_domain": false,
            "parent_id": "d78cbac186b744899480f25bd0...",
            "name": "ap-southeast-1",
            "description": "",
            "links": {
                "self": "https://iam.myhuaweicloud.com/v3/projects/065a7c66da0010992ff7c0031e..."
            },
            "id": "065a7c66da0010992ff7c0031e5...",
            "enabled": true
        }
    ],
    "links": {
        "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/projects"
    }
}

Status Codes

Status Code

Description

200

The request is successful.

400

Invalid parameters.

401

Authentication failed.

403

Access denied.

405

The requested resource cannot be found.

413

The request entity is too large.

500

Internal server error.

503

Service unavailable.

Error Codes

None