Querying the List of Projects Accessible to Federated Users

Function

This API is used to query the list of projects accessible to federated users. The project list is used to obtain the scoped token in federated identity authentication mode.

URI

GET /v3/OS-FEDERATION/projects

Request Parameters

• Parameters in the request header

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Unscoped token. For details about how to obtain a token, see Obtaining an Unscoped Token (SP Initiated).

  

  The API described in Querying the List of Projects Accessible to Users is recommended. This API returns the same response format as the API described in this section.

• Example request

  GET /v3/OS-FEDERATION/projects

Response Parameters

• Parameters in the response body

  Parameter	Mandatory	Type	Description
  projects	Yes	array	List of projects.
  links	Yes	Object	Project resource link.

• Example response

  {
    "links": {
      "self": "https://sample.domain.com/v3/OS-FEDERATION/projects",
      "previous": null,
      "next": null
    },
    "projects": [
      {
        "is_domain": false,
        "description": "",
        "links": {
          "self": "https://sample.domain.com/v3/projects/05cf683c351e43518618d9fa96a5efa9"
        },
        "enabled": true,
        "id": "05cf683c351e43518618d9fa96a5efa9",
        "parent_id": "e31ac82d778b4d128cb6fed37fd72cdb",
        "domain_id": "e31ac82d778b4d128cb6fed37fd72cdb",
        "name": "region_name"
      },
      {
        "is_domain": false,
        "description": "",
        "links": {
          "self": "https://sample.domain.com/v3/projects/32b56f108f87418e8219317beb0fff3c"
        },
        "enabled": true,
        "id": "32b56f108f87418e8219317beb0fff3c",
        "parent_id": "e31ac82d778b4d128cb6fed37fd72cdb",
        "domain_id": "e31ac82d778b4d128cb6fed37fd72cdb",
        "name": "MOS"   //Default project name of OBS
      }
    ]
  }

Status Codes