Tenants

Use the List tenant API operation to retrieve information about Rackspace Cloud tenants. Tenant IDs are assigned when a Rackspace Cloud account is created.

List tenants

GET /v2.0/tenants

Get a list of tenants.

The list of tenants returned includes only those to which the user has access, based on the user’s X-Auth-token. The tenants to which the user has access via RCN roles are returned only if requested.

Note

• The list tenants operation can be made by any users with an Identity role.
  
• Tenants associated to a user via an RCN role will be returned only when apply_rcn_roles query parameter is set to true.
  

This table shows the possible response codes for this operation:

Request

This table shows the URI parameters for the request:

This table shows the query parameters for the request:

This operation does not accept a request body.

Response

This table shows the body parameters for the response:

Example: List tenants response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=UTF-8
Content-Length: 200
Date: Sun, 1 Jan 2011 9:00:00 GMT

<?xml version="1.0" encoding="UTF-8"?>
<tenants
   xmlns="http://docs.openstack.org/identity/api/v2.0"
   xmlns:OS-KSADM="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0"
   xmlns:atom="http://www.w3.org/2005/Atom">
   <tenant display-name="Star Wars" enabled="true" id="5781234" name="star_wars">
     <description>Used to manage the Star Wars games</description>
   </tenant>
   <tenant display-name="Star Wars" enabled="true" id="5781234_FS" name="start_wars_pictures">
     <description>Used to manage the pictures for Star Wars</description>
   </tenant>
 </tenants>

Example: List tenants response JSON

{
  "tenants": [
    {
      "id": "5784574",
      "enabled": true,
      "display-name": "Star Wars",
      "description": "Used to manage the Star Wars games",
      "name": "star_wars"
     },
    {
      "id": ""5781234_FS",
      "enabled": true,
      "display-name": "Star Wars",
      "description": "Used to manage the pictures for Start Wars",
      "name": "start_wars_pictures"
    }
   ]
}

List users for tenant

GET /v2.0/tenants/{tenantId}/users

Lists all users for a tenant.

Note

• Page query parameters are ignored when using contactId query parameter.
  

This table shows the possible response codes for this operation:

Request

This table shows the header parameters for the request:

This operation does not accept a request body.

Response

This table shows the URI parameters for the request:

This table shows the query parameters for the request:

Response:

Example: List users for tenant XML response

<?xml version="1.0" encoding="UTF-8"?>
<users
      xmlns="http://docs.openstack.org/identity/api/v2.0"
      xmlns:OS-KSADM="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0"
      xmlns:atom="http://www.w3.org/2005/Atom">
      <user
            email="[email protected]"
            enabled="true" id="123456"
            username="jqsmith"/>

      <user email="[email protected]"
            enabled="true" id="388493"
            username="miketurner"/>

      <user email="[email protected]"
            enabled="false"
            id="938439"
            username="poejo"/>
</users>

Example: List users for tenant JSON response

{
  "users": [
    {
      "id": "123456",
      "enabled": true,
      "username": "jqsmith",
      "email": "[email protected]"
    },
    {
      "id": "388493",
      "enabled": true,
      "username": "miketurner",
      "email": "[email protected]"
    },
    {
      "id": "938439",
      "enabled": false,
      "username": "poejo",
      "email": "[email protected]"
    }
  ]
}