Get Tenant Information by Name

 
MethodURIDescription
GET/v2.0/tenants​{?marker,​limit,​name}

Gets detailed information about a specified tenant by name.

Normal response codes: 200, 203

Error response codes: identityFault (400, 500, ), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), serviceUnavailable (503), itemNotFound (404)

 Request

This table shows the header parameters for the get tenant information by name request:

NameTypeDescription

X-Auth-Token

​String

(Required)

A valid authentication token for an administrative user.

This table shows the query parameters for the get tenant information by name request:

NameTypeDescription

marker

​String

(Optional)

The ID of the last item in the previous list.

limit

​Int

(Optional)

The page size.

name

​String

(Required)

The name of the tenant.

 Response

 

Example 3.17. Get tenant by name: JSON response

{
  "tenant": {
    "id": "1234",
    "name": "ACME corp",
    "description": "A description ...",
    "enabled": true
  }
}

 

Example 3.18. Get tenant by name: XML response

<?xml version="1.0" encoding="UTF-8"?>
<tenant xmlns="http://docs.openstack.org/identity/api/v2.0"
        enabled="true" id="1234" name="ACME Corp">
    <description>A description...</description>
</tenant>

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page

loading table of contents...