Prev Next

2.1. Listing domains¶

GET /v3/domains

List all domains.

Source: https://docs.openstack.org/api-ref/identity/v3/index.html?expanded=#list-domains

2.1.1. Request¶

2.1.1.1. Parameters¶

Name	In	Type	Description
`name` (Optional)	query	string	Filters the response by a domain name.
`enabled` (Optional)	query	string	If set to true, then only domains that are enabled will be returned, if set to false only that are disabled will be returned. Any value other than `0`, including no value, will be interpreted as true.

2.1.1.2. Example¶

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:5000/v3/domains

2.1.2. Response¶

2.1.2.1. Parameters¶

Name	In	Type	Description
`domains`	body	array	A list of `domain` objects
`description`	body	string	The description of the domain.
`enabled`	body	string	If set to `true`, domain is enabled. If set to `false`, domain is disabled.
`id`	body	string	The ID of the domain.
`links`	body	object	The links to the `domain` resource.
`name`	body	string	The name of the domain.

2.1.2.2. Status codes¶

2.1.2.2.1. Success¶

Code	Reason
`200 - OK`	Request was successful.

2.1.2.2.2. Error¶

Code	Reason
`400 - Bad Request`	Some content in the request was invalid.
`401 - Unauthorized`	User must authenticate before making a request.
`403 - Forbidden`	Policy does not allow current user to do this operation.
`404 - Not Found`	The requested resource could not be found.
`405 - Method Not Allowed`	Method is not valid for this endpoint.
`413 - Request Entity Too Large`	The request is larger than the server is willing or able to process.
`503 - Service Unavailable`	Service is not available. This is mostly caused by service configuration errors which prevents the service from successful start up.

2.1.2.3. Example¶

{
  "domains": [
    {
      "description": "The default domain",
      "links": {
        "self": "https://<node_IP_addr>:5000/v3/domains/default"
      },
      "tags": [],
      "enabled": true,
      "id": "default",
      "name": "Default"
    },
    {
      "description": "",
      "links": {
        "self": "https://<node_IP_addr>:5000/v3/domains/f2eeaaf15c254d4fa10255796122c8ec"
      },
      "tags": [],
      "enabled": true,
      "id": "f2eeaaf15c254d4fa10255796122c8ec",
      "name": "domain1"
    },
    {
      "description": "",
      "links": {
        "self": "https://<node_IP_addr>:5000/v3/domains/1254790bf4bf4f8c8a7c28b5dfa83d68"
      },
      "tags": [],
      "enabled": true,
      "id": "1254790bf4bf4f8c8a7c28b5dfa83d68",
      "name": "heat"
    }
  ],
  "links": {
    "self": "https://<node_IP_addr>:5000/v3/domains",
    "previous": null,
    "next": null
  }
}

Version 4.6.0 — Jul 28, 2021

Prev Next