This section provides sample authentication request and response examples with detailed information about the values returned in the authentication response body.
Note
To learn more about authentication, see the following information:
- Getting Started provides instructions for submitting an authentication request.
- Token operations API reference pages provide information about other authentication methods and more examples.
Sample request
The following authentication JSON and XML examples show the authentication header and request body for the POST tokens API operation. When you authenticate, use your own credentials for user name and API key rather than the sample values shown in the examples. For attribute descriptions, see the authentication request attribute descriptions in the table following the examples.
Example: Authentication request with headers: JSON
POST /v2.0/tokens HTTP/1.1
Host: identity.api.rackspacecloud.com
Content-Type: application/json
Accept: application/json
{"auth":
{"RAX-KSKEY:apiKeyCredentials":
{"username":"yourUserName",
"apiKey":"a4bbc55a951242c48b03e88e32123456"}
}
}
Example: Authentication request with headers: XML
POST /v2.0/tokens HTTP/1.1
Host: identity.api.rackspacecloud.com
Content-Type: application/xml
Accept: application/xml
<auth>
<apiKeyCredentials
xmlns="http://docs.rackspace.com/identity/api/ext/RAX-KSKEY/v1.0"
username="yourUserName"
apiKey="a4bbc55a951242c48b03e88e32123456"/>
</auth>
Table: Authentication request attribute descriptions
| Attribute | Type | Description |
| auth | Object | The auth object provides the credentials for the authentication request. |
| RAX-KSKEY:apiKeyCredentials | String | The API key associated with the Rackspace Cloud account. You can find your API key on the Account Settings page in the Cloud Control panel. After logging in, click your user ID. Then, select Account Settings from the menu. You can authenticate using other credentials like password or multi-factor authentication passcode. For details, see the Tokens API operation reference. |
| username | String | This value is the user name that you use to log in to the Rackspace Cloud Control Panel at https://login.rackspace.com. |
| tenantId | String (Optional) | Some services have multiple layers of authentication, with service-specific credentials in addition to vendor-specific credentials. In such cases, associating a user with a tenant can be a method of passing that additional level of identifying information to the service. |
Sample response
When you submit a POST tokens authentication request with valid credentials, the Identity service returns a response. The following authentication JSON and XML examples show the entire authentication response header and body content.
The sections that follow these examples provide detailed information about the following parts of the response:
- Token resource. The token object returns a scoped authentication token that can be used to access Rackspace Cloud services for the specified tenant. Token scope is determined by tenant and user role assignments for the authenticated user.
- Service catalog resource The service catalog object returns a list of service objects that provide the endpoint and description for each service that can be accessed using the authentication token.
If you have questions or issues with the services and endpoints included in the catalog, contact Rackspace support. - User resource The user object returns the user name, ID, default Cloud service region, and information about the roles assigned to the user. User role assignments determine the API operations available to a user after authenticating to a Rackspace Cloud service.
Example: Authentication response: JSON
{
"access": {
"token": {
"id": "d74f592f986e4d6e995853ccf0123456",
"expires": "2015-06-05T16:24:57.637Z",
"tenant": {
"id": "123456",
"name": "123456"
},
"RAX-AUTH:authenticatedBy": [
"APIKEY"
]
},
"serviceCatalog": [
{
"name": "cloudBlockStorage",
"endpoints": [
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.blockstorage.api.rackspacecloud.com/v1/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.blockstorage.api.rackspacecloud.com/v1/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.blockstorage.api.rackspacecloud.com/v1/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.blockstorage.api.rackspacecloud.com/v1/123456>"
}
],
"type": "volume"
},
{
"name": "cloudImages",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.images.api.rackspacecloud.com/v2>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.images.api.rackspacecloud.com/v2>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.images.api.rackspacecloud.com/v2>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.images.api.rackspacecloud.com/v2>"
}
],
"type": "image"
},
{
"name": "cloudQueues",
"endpoints": [
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.queues.api.rackspacecloud.com/v1/123456">,
"internalURL": "<https://snet-hkg.queues.api.rackspacecloud.com/v1/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.queues.api.rackspacecloud.com/v1/123456">,
"internalURL": "<https://snet-syd.queues.api.rackspacecloud.com/v1/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.queues.api.rackspacecloud.com/v1/123456">,
"internalURL": "<https://snet-dfw.queues.api.rackspacecloud.com/v1/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.queues.api.rackspacecloud.com/v1/123456">,
"internalURL": "<https://snet-iad.queues.api.rackspacecloud.com/v1/123456>"
}
],
"type": "rax:queues"
},
{
"name": "cloudBigData",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.bigdata.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.bigdata.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:bigdata"
},
{
"name": "cloudOrchestration",
"endpoints": [
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.orchestration.api.rackspacecloud.com/v1/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.orchestration.api.rackspacecloud.com/v1/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.orchestration.api.rackspacecloud.com/v1/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.orchestration.api.rackspacecloud.com/v1/123456>"
}
],
"type": "orchestration"
},
{
"name": "cloudServersOpenStack",
"endpoints": [
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.servers.api.rackspacecloud.com/v2/123456">,
"versionInfo": "<https://syd.servers.api.rackspacecloud.com/v2">,
"versionList": "<https://syd.servers.api.rackspacecloud.com/">,
"versionId": "2"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.servers.api.rackspacecloud.com/v2/123456">,
"versionInfo": "<https://dfw.servers.api.rackspacecloud.com/v2">,
"versionList": "<https://dfw.servers.api.rackspacecloud.com/">,
"versionId": "2"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.servers.api.rackspacecloud.com/v2/123456">,
"versionInfo": "<https://iad.servers.api.rackspacecloud.com/v2">,
"versionList": "<https://iad.servers.api.rackspacecloud.com/">,
"versionId": "2"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.servers.api.rackspacecloud.com/v2/123456">,
"versionInfo": "<https://hkg.servers.api.rackspacecloud.com/v2">,
"versionList": "<https://hkg.servers.api.rackspacecloud.com/">,
"versionId": "2"
}
],
"type": "compute"
},
{
"name": "autoscale",
"endpoints": [
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.autoscale.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.autoscale.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.autoscale.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.autoscale.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:autoscale"
},
{
"name": "cloudDatabases",
"endpoints": [
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.databases.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.databases.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.databases.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:database"
},
{
"name": "cloudBackup",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.backup.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.backup.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.backup.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.backup.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:backup"
},
{
"name": "cloudNetworks",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.networks.api.rackspacecloud.com/v2.0>"
},
{
"region": "LON",
"tenantId": "123456",
"publicURL": "<https://lon.networks.api.rackspacecloud.com/v2.0>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.networks.api.rackspacecloud.com/v2.0>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.networks.api.rackspacecloud.com/v2.0>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.networks.api.rackspacecloud.com/v2.0>"
}
],
"type": "network"
},
{
"name": "cloudMetrics",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://global.metrics.api.rackspacecloud.com/v2.0/123456>"
}
],
"type": "rax:cloudmetrics"
},
{
"name": "cloudLoadBalancers",
"endpoints": [
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.loadbalancers.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.loadbalancers.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.loadbalancers.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.loadbalancers.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:load-balancer"
},
{
"name": "cloudFeeds",
"endpoints": [
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.feeds.api.rackspacecloud.com/123456">,
"internalURL": "<https://atom.prod.hkg1.us.ci.rackspace.net/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.feeds.api.rackspacecloud.com/123456">,
"internalURL": "<https://atom.prod.syd2.us.ci.rackspace.net/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.feeds.api.rackspacecloud.com/123456">,
"internalURL": "<https://atom.prod.iad3.us.ci.rackspace.net/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.feeds.api.rackspacecloud.com/123456">,
"internalURL": "<https://atom.prod.dfw1.us.ci.rackspace.net/123456>"
}
],
"type": "rax:feeds"
},
{
"name": "cloudMonitoring",
"endpoints": [
{
"tenantId": "123456",
"publicURL": "<https://monitoring.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:monitor"
},
{
"name": "cloudDNS",
"endpoints": [
{
"tenantId": "123456",
"publicURL": "<https://dns.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:dns"
},
{
"name": "cloudServers",
"endpoints": [
{
"tenantId": "123456",
"publicURL": "<https://servers.api.rackspacecloud.com/v1.0/123456">,
"versionInfo": "<https://servers.api.rackspacecloud.com/v1.0">,
"versionList": "<https://servers.api.rackspacecloud.com/">,
"versionId": "1.0"
}
],
"type": "compute"
},
{
"name": "rackCDN",
"endpoints": [
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://global.cdn.api.rackspacecloud.com/v1.0/123456">,
"internalURL": "<https://global.cdn.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:cdn"
},
{
"name": "cloudFilesCDN",
"endpoints": [
{
"region": "DFW",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://cdn1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "SYD",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://cdn4.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "HKG",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://cdn6.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "IAD",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://cdn5.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
}
],
"type": "rax:object-cdn"
},
{
"name": "cloudFiles",
"endpoints": [
{
"region": "DFW",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://storage101.dfw1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f">,
"internalURL": "<https://snet-storage101.dfw1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "SYD",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://storage101.syd2.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f">,
"internalURL": "<https://snet-storage101.syd2.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "IAD",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://storage101.iad3.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f">,
"internalURL": "<https://snet-storage101.iad3.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "HKG",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://storage101.hkg1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f">,
"internalURL": "<https://snet-storage101.hkg1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
}
],
"type": "object-store"
}
],
"user": {
"id": "172157",
"roles": [
{
"id": "10000150",
"description": "Checkmate Access role",
"name": "checkmate"
},
{
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"id": "5",
"description": "A Role that allows a user access to keystone Service methods",
"name": "object-store:default"
},
{
"tenantId": "123456",
"id": "6",
"description": "A Role that allows a user access to keystone Service methods",
"name": "compute:default"
},
{
"id": "3",
"description": "User Admin Role.",
"name": "identity:user-admin"
}
],
"name": "yourUserName",
"RAX-AUTH:defaultRegion": "DFW",
"RAX-AUTH:sessionInactivityTimeout": "PT15M"
}
}
}
Example: Authentication response: XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<access
xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:rax-auth="http://docs.rackspace.com/identity/api/ext/RAX-AUTH/v1.0"
xmlns="http://docs.openstack.org/identity/api/v2.0"
xmlns:ns4="http://docs.rackspace.com/identity/api/ext/RAX-KSGRP/v1.0"
xmlns:rax-ksqa="http://docs.rackspace.com/identity/api/ext/RAX-KSQA/v1.0"
xmlns:os-ksadm="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0"
xmlns:rax-kskey="http://docs.rackspace.com/identity/api/ext/RAX-KSKEY/v1.0"
xmlns:os-ksec2="http://docs.openstack.org/identity/api/ext/OS-KSEC2/v1.0">
<token id="d74f592f986e4d6e995853ccf01d25fe" expires="2015-06-05T16:24:57.637Z">
<tenant id="123456" name="123456"/>
\<rax-auth:authenticatedBy>
\<rax-auth:credential>APIKEY\</rax-auth:credential>
\</rax-auth:authenticatedBy>
</token>
<user id="172157" name="yourUserName" rax-auth:defaultRegion="DFW" rax-auth:sessionInactivityTimeout="PT15M">
<roles>
<role id="10000150" name="checkmate" description="Checkmate Access role" rax-auth:propagate="false"/>
<role id="5" name="object-store:default" description="A Role that allows a user access to keystone Service methods"
tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f" rax-auth:propagate="true"/>
<role id="6" name="compute:default" description="A Role that allows a user access to keystone Service methods"
tenantId="123456" rax-auth:propagate="true"/>
<role id="3" name="identity:user-admin" description="User Admin Role." rax-auth:propagate="false"/>
</roles>
</user>
<serviceCatalog>
<service type="volume" name="cloudBlockStorage">
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.blockstorage.api.rackspacecloud.com/v1/123456"/>]();
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.blockstorage.api.rackspacecloud.com/v1/123456"/>]();
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.blockstorage.api.rackspacecloud.com/v1/123456"/>]();
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.blockstorage.api.rackspacecloud.com/v1/123456"/>]();
</service>
<service type="image" name="cloudImages">
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.images.api.rackspacecloud.com/v2"/>]();
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.images.api.rackspacecloud.com/v2"/>]();
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.images.api.rackspacecloud.com/v2"/>]();
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.images.api.rackspacecloud.com/v2"/>]();
</service>
<service type="rax:queues" name="cloudQueues">
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.queues.api.rackspacecloud.com/v1/123456"
internalURL="https://snet-hkg.queues.api.rackspacecloud.com/v1/123456"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.queues.api.rackspacecloud.com/v1/123456"
internalURL="https://snet-syd.queues.api.rackspacecloud.com/v1/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.queues.api.rackspacecloud.com/v1/123456"
internalURL="https://snet-dfw.queues.api.rackspacecloud.com/v1/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.queues.api.rackspacecloud.com/v1/123456"
internalURL="https://snet-iad.queues.api.rackspacecloud.com/v1/123456"/>
</service>
<service type="rax:bigdata" name="cloudBigData">
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.bigdata.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.bigdata.api.rackspacecloud.com/v1.0/123456"/>]();
</service>
<service type="orchestration" name="cloudOrchestration">
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.orchestration.api.rackspacecloud.com/v1/123456"/>]();
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.orchestration.api.rackspacecloud.com/v1/123456"/>]();
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.orchestration.api.rackspacecloud.com/v1/123456"/>]();
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.orchestration.api.rackspacecloud.com/v1/123456"/>]();
</service>
<service type="compute" name="cloudServersOpenStack">
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.servers.api.rackspacecloud.com/v2/123456">]();
<version id="2" info="[https://syd.servers.api.rackspacecloud.com/v2]()" list="[https://syd.servers.api.rackspacecloud.com/"/>]();
</endpoint>
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.servers.api.rackspacecloud.com/v2/123456">]();
<version id="2" info="[https://dfw.servers.api.rackspacecloud.com/v2]()" list="[https://dfw.servers.api.rackspacecloud.com/"/>]();
</endpoint>
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.servers.api.rackspacecloud.com/v2/123456">]();
<version id="2" info="[https://iad.servers.api.rackspacecloud.com/v2]()" list="[https://iad.servers.api.rackspacecloud.com/"/>]();
</endpoint>
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.servers.api.rackspacecloud.com/v2/123456">]();
<version id="2" info="[https://hkg.servers.api.rackspacecloud.com/v2]()" list="[https://hkg.servers.api.rackspacecloud.com/"/>]();
</endpoint>
</service>
<service type="rax:autoscale" name="autoscale">
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.autoscale.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.autoscale.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.autoscale.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.autoscale.api.rackspacecloud.com/v1.0/123456"/>]();
</service>
<service type="rax:database" name="cloudDatabases">
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.databases.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.databases.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.databases.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.databases.api.rackspacecloud.com/v1.0/123456"/>]();
</service>
<service type="rax:backup" name="cloudBackup">
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.backup.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.backup.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.backup.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.backup.api.rackspacecloud.com/v1.0/123456"/>]();
</service>
<service type="network" name="cloudNetworks">
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.networks.api.rackspacecloud.com/v2.0"/>]();
<endpoint region="LON" tenantId="123456" publicURL="[https://lon.networks.api.rackspacecloud.com/v2.0"/>]();
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.networks.api.rackspacecloud.com/v2.0"/>]();
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.networks.api.rackspacecloud.com/v2.0"/>]();
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.networks.api.rackspacecloud.com/v2.0"/>]();
</service>
<service type="rax:cloudmetrics" name="cloudMetrics">
<endpoint region="IAD" tenantId="123456" publicURL="[https://global.metrics.api.rackspacecloud.com/v2.0/123456"/>]();
</service>
<service type="rax:load-balancer" name="cloudLoadBalancers">
<endpoint region="SYD" tenantId="123456" publicURL="[https://syd.loadbalancers.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="IAD" tenantId="123456" publicURL="[https://iad.loadbalancers.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="HKG" tenantId="123456" publicURL="[https://hkg.loadbalancers.api.rackspacecloud.com/v1.0/123456"/>]();
<endpoint region="DFW" tenantId="123456" publicURL="[https://dfw.loadbalancers.api.rackspacecloud.com/v1.0/123456"/>]();
</service>
<service type="rax:feeds" name="cloudFeeds">
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.feeds.api.rackspacecloud.com/123456"
internalURL="https://atom.prod.hkg1.us.ci.rackspace.net/123456"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.feeds.api.rackspacecloud.com/123456"
internalURL="https://atom.prod.syd2.us.ci.rackspace.net/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.feeds.api.rackspacecloud.com/123456"
internalURL="https://atom.prod.iad3.us.ci.rackspace.net/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.feeds.api.rackspacecloud.com/123456"
internalURL="https://atom.prod.dfw1.us.ci.rackspace.net/123456"/>
</service>
<service type="rax:monitor" name="cloudMonitoring">
<endpoint tenantId="123456" publicURL="[https://monitoring.api.rackspacecloud.com/v1.0/123456"/>]();
</service>
<service type="rax:dns" name="cloudDNS">
<endpoint tenantId="123456" publicURL="[https://dns.api.rackspacecloud.com/v1.0/123456"/>]();
</service>
<service type="compute" name="cloudServers">
<endpoint tenantId="123456" publicURL="[https://servers.api.rackspacecloud.com/v1.0/123456">]();
<version id="1.0" info="[https://servers.api.rackspacecloud.com/v1.0]()" list="[https://servers.api.rackspacecloud.com/"/>]();
</endpoint>
</service>
<service type="rax:cdn" name="rackCDN">
<endpoint region="DFW" tenantId="123456" publicURL="https://global.cdn.api.rackspacecloud.com/v1.0/123456"
internalURL="https://global.cdn.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="rax:object-cdn" name="cloudFilesCDN">
<endpoint region="DFW" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://cdn1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="SYD" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://cdn4.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="HKG" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://cdn6.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="IAD" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://cdn5.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
</service>
<service type="object-store" name="cloudFiles">
<endpoint region="DFW" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://storage101.dfw1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
internalURL="https://snet-storage101.dfw1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="SYD" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://storage101.syd2.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
internalURL="https://snet-storage101.syd2.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="IAD" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://storage101.iad3.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
internalURL="https://snet-storage101.iad3.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="HKG" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://storage101.hkg1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
internalURL="https://snet-storage101.hkg1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
</service>
</serviceCatalog>
</access>
The token object supplies a scoped authentication token that customers and processes can use to access Rackspace Cloud services for the specified tenant. Token scope is determined by tenant and user role assignments for the authenticated user. Responses can be in JSON or XML format as shown in the following examples. For details, see the :ref:token object attribute descriptions in the table following the examples.
You include the token ID returned in the response to verify your identity when in subsequent API requests to Rackspace Cloud services, you
Example: Authentication response token object in JSON format
{
"token": {
"id": "d74f592f986e4d6e995853ccf0123456",
"expires": "2015-06-05T16:24:57.637Z",
"tenant": {
"id": "123456",
"name": "123456"
},
"RAX-AUTH:authenticatedBy": [
"APIKEY"
]
}
Example: Authentication response token object in XML format
<token id="abcdef123ghi4j5k67m8910n12op3qrs" expires="2014-12-05T17:36:38.662Z">
<tenant id="123456" name="123456"/>
<rax-auth:authenticatedBy>
<rax-auth:credential>APIKEY</rax-auth:credential>
</rax-auth:authenticatedBy>
</token>
Table: Authentication response: Token object attributes descriptions
| Attribute | Type | Description |
|---|---|---|
| id | > String (Optional) | The unique, system-assigned ID for the authentication token. The token ID can be presented to a service as evidence of authentication. Tokens are valid for a finite duration; a token’s default lifespan is twenty-four hours. In the authentication response example, the token is aaaaa-bbbbb-ccccc-dddd. |
| expires | > String (Required) | A timestamp that indicates when the token expires. By default, a token id expires 24-hours after being generated, unless the token is revoked before it expires. Clients are encouraged to cache the token until it expires. After the token expires, client users and applications must re-authenticate to get a new token. |
| RAX-AUTH:Auth enticatedBy | > String (Required) | Indicates the type of authentication credentials used to generate the token, which can include the following values: APIKEY for the API key assigned to the user account. PASSCODE sent to a mobile phone associated with a user account. PASSWORD for Rackspace Cloud account password. FEDERATED if the user authenticated through a trusted third-party Identity provider. |
Service catalog resource: Authentication response attributes
The Service catalog object provides service and endpoint information for services that you can access with the authentication token returned in the authentication response.
The information returned for a service is determined by the Identity service configuration and the tenant and role assignments of the authenticated user. For example, if a service has an endpoint for administrative use that endpoint is classified as an AdminURL. The AdminURL is visible only to authenticated Rackspace administrators.
Responses can be in JSON or XML. For details, see the table of service resource object attribute description descriptions following the examples.
Example: Authentication response: Service catalog object in JSON format
"serviceCatalog": [
{
"name": "cloudBlockStorage",
"endpoints": [
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.blockstorage.api.rackspacecloud.com/v1/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.blockstorage.api.rackspacecloud.com/v1/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.blockstorage.api.rackspacecloud.com/v1/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.blockstorage.api.rackspacecloud.com/v1/123456>"
}
],
"type": "volume"
},
{
"name": "cloudImages",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.images.api.rackspacecloud.com/v2>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.images.api.rackspacecloud.com/v2>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.images.api.rackspacecloud.com/v2>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.images.api.rackspacecloud.com/v2>"
}
],
"type": "image"
},
{
"name": "cloudQueues",
"endpoints": [
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.queues.api.rackspacecloud.com/v1/123456">,
"internalURL": "<https://snet-hkg.queues.api.rackspacecloud.com/v1/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.queues.api.rackspacecloud.com/v1/123456">,
"internalURL": "<https://snet-syd.queues.api.rackspacecloud.com/v1/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.queues.api.rackspacecloud.com/v1/123456">,
"internalURL": "<https://snet-dfw.queues.api.rackspacecloud.com/v1/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.queues.api.rackspacecloud.com/v1/123456">,
"internalURL": "<https://snet-iad.queues.api.rackspacecloud.com/v1/123456>"
}
],
"type": "rax:queues"
},
{
"name": "cloudBigData",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.bigdata.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.bigdata.api.rackspacecloud.com/v1.0/123456>"
},
],
"type": "rax:bigdata"
},
{
"name": "cloudOrchestration",
"endpoints": \[
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.orchestration.api.rackspacecloud.com/v1/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.orchestration.api.rackspacecloud.com/v1/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.orchestration.api.rackspacecloud.com/v1/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.orchestration.api.rackspacecloud.com/v1/123456>"
}
],
"type": "orchestration"
},
{
"name": "cloudServersOpenStack",
"endpoints": [
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.servers.api.rackspacecloud.com/v2/123456">,
"versionInfo": "<https://syd.servers.api.rackspacecloud.com/v2">,
"versionList": "<https://syd.servers.api.rackspacecloud.com/">,
"versionId": "2"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.servers.api.rackspacecloud.com/v2/123456">,
"versionInfo": "<https://dfw.servers.api.rackspacecloud.com/v2">,
"versionList": "<https://dfw.servers.api.rackspacecloud.com/">,
"versionId": "2"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.servers.api.rackspacecloud.com/v2/123456">,
"versionInfo": "<https://iad.servers.api.rackspacecloud.com/v2">,
"versionList": "<https://iad.servers.api.rackspacecloud.com/">,
"versionId": "2"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.servers.api.rackspacecloud.com/v2/123456">,
"versionInfo": "<https://hkg.servers.api.rackspacecloud.com/v2">,
"versionList": "<https://hkg.servers.api.rackspacecloud.com/">,
"versionId": "2"
}
],
"type": "compute"
},
{
"name": "autoscale",
"endpoints": [
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.autoscale.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.autoscale.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.autoscale.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.autoscale.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:autoscale"
},
{
"name": "cloudDatabases",
"endpoints": [
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.databases.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.databases.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.databases.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.databases.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:database"
},
{
"name": "cloudBackup",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.backup.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.backup.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.backup.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.backup.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:backup"
},
{
"name": "cloudNetworks",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.networks.api.rackspacecloud.com/v2.0>"
},
{
"region": "LON",
"tenantId": "123456",
"publicURL": "<https://lon.networks.api.rackspacecloud.com/v2.0>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.networks.api.rackspacecloud.com/v2.0>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.networks.api.rackspacecloud.com/v2.0>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.networks.api.rackspacecloud.com/v2.0>"
}
],
"type": "network"
},
{
"name": "cloudMetrics",
"endpoints": [
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://global.metrics.api.rackspacecloud.com/v2.0/123456>"
}
],
"type": "rax:cloudmetrics"
},
{
"name": "cloudLoadBalancers",
"endpoints": [
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.loadbalancers.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.loadbalancers.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.loadbalancers.api.rackspacecloud.com/v1.0/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.loadbalancers.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:load-balancer"
},
{
"name": "cloudFeeds",
"endpoints": [
{
"region": "HKG",
"tenantId": "123456",
"publicURL": "<https://hkg.feeds.api.rackspacecloud.com/123456">,
"internalURL": "<https://atom.prod.hkg1.us.ci.rackspace.net/123456>"
},
{
"region": "SYD",
"tenantId": "123456",
"publicURL": "<https://syd.feeds.api.rackspacecloud.com/123456">,
"internalURL": "<https://atom.prod.syd2.us.ci.rackspace.net/123456>"
},
{
"region": "IAD",
"tenantId": "123456",
"publicURL": "<https://iad.feeds.api.rackspacecloud.com/123456">,
"internalURL": "<https://atom.prod.iad3.us.ci.rackspace.net/123456>"
},
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://dfw.feeds.api.rackspacecloud.com/123456">,
"internalURL": "<https://atom.prod.dfw1.us.ci.rackspace.net/123456>"
}
],
"type": "rax:feeds"
},
{
"name": "cloudMonitoring",
"endpoints": [
{
"tenantId": "123456",
"publicURL": "<https://monitoring.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:monitor"
},
{
"name": "cloudDNS",
"endpoints": [
{
"tenantId": "123456",
"publicURL": "<https://dns.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:dns"
},
{
"name": "cloudServers",
"endpoints": [
{
"tenantId": "123456",
"publicURL": "<https://servers.api.rackspacecloud.com/v1.0/123456">,
"versionInfo": "<https://servers.api.rackspacecloud.com/v1.0">,
"versionList": "<https://servers.api.rackspacecloud.com/">,
"versionId": "1.0"
}
],
"type": "compute"
},
{
"name": "rackCDN",
"endpoints": [
{
"region": "DFW",
"tenantId": "123456",
"publicURL": "<https://global.cdn.api.rackspacecloud.com/v1.0/123456">,
"internalURL": "<https://global.cdn.api.rackspacecloud.com/v1.0/123456>"
}
],
"type": "rax:cdn"
},
{
"name": "cloudFilesCDN",
"endpoints": [
{
"region": "DFW",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://cdn1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "SYD",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://cdn4.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "HKG",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://cdn6.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "IAD",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://cdn5.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
}
],
"type": "rax:object-cdn"
},
{
"name": "cloudFiles",
"endpoints": [
{
"region": "DFW",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://storage101.dfw1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f">,
"internalURL": "<https://snet-storage101.dfw1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "SYD",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://storage101.syd2.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f">,
"internalURL": "<https://snet-storage101.syd2.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "IAD",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://storage101.iad3.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f">,
"internalURL": "<https://snet-storage101.iad3.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
},
{
"region": "HKG",
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"publicURL": "<https://storage101.hkg1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f">,
"internalURL": "<https://snet-storage101.hkg1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f>"
}
],
"type": "object-store"
}
]
Example: Authentication response: Service catalog object in XML format
<serviceCatalog>
<service type="volume" name="cloudBlockStorage">
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.blockstorage.api.rackspacecloud.com/v1/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.blockstorage.api.rackspacecloud.com/v1/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.blockstorage.api.rackspacecloud.com/v1/123456"/>
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.blockstorage.api.rackspacecloud.com/v1/123456"/>
</service>
<service type="image" name="cloudImages">
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.images.api.rackspacecloud.com/v2"/>
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.images.api.rackspacecloud.com/v2"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.images.api.rackspacecloud.com/v2"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.images.api.rackspacecloud.com/v2"/>
</service>
<service type="rax:queues" name="cloudQueues">
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.queues.api.rackspacecloud.com/v1/123456"
internalURL="https://snet-hkg.queues.api.rackspacecloud.com/v1/123456"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.queues.api.rackspacecloud.com/v1/123456"
internalURL="https://snet-syd.queues.api.rackspacecloud.com/v1/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.queues.api.rackspacecloud.com/v1/123456"
internalURL="https://snet-dfw.queues.api.rackspacecloud.com/v1/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.queues.api.rackspacecloud.com/v1/123456"
internalURL="https://snet-iad.queues.api.rackspacecloud.com/v1/123456"/>
</service>
<service type="rax:bigdata" name="cloudBigData">
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.bigdata.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.bigdata.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="orchestration" name="cloudOrchestration">
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.orchestration.api.rackspacecloud.com/v1/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.orchestration.api.rackspacecloud.com/v1/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.orchestration.api.rackspacecloud.com/v1/123456"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.orchestration.api.rackspacecloud.com/v1/123456"/>
</service>
<service type="compute" name="cloudServersOpenStack">
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.servers.api.rackspacecloud.com/v2/123456">
<version id="2" info="https://syd.servers.api.rackspacecloud.com/v2" list="https://syd.servers.api.rackspacecloud.com/"/>
</endpoint>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.servers.api.rackspacecloud.com/v2/123456">
<version id="2" info="https://dfw.servers.api.rackspacecloud.com/v2" list="https://dfw.servers.api.rackspacecloud.com/"/>
</endpoint>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.servers.api.rackspacecloud.com/v2/123456">
<version id="2" info="https://iad.servers.api.rackspacecloud.com/v2" list="https://iad.servers.api.rackspacecloud.com/"/>
</endpoint>
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.servers.api.rackspacecloud.com/v2/123456">
<version id="2" info="https://hkg.servers.api.rackspacecloud.com/v2" list="https://hkg.servers.api.rackspacecloud.com/"/>
</endpoint>
</service>
<service type="rax:autoscale" name="autoscale">
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.autoscale.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.autoscale.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.autoscale.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.autoscale.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="rax:database" name="cloudDatabases">
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.databases.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.databases.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.databases.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.databases.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="rax:backup" name="cloudBackup">
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.backup.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.backup.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.backup.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.backup.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="network" name="cloudNetworks">
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.networks.api.rackspacecloud.com/v2.0"/>
<endpoint region="LON" tenantId="123456" publicURL="https://lon.networks.api.rackspacecloud.com/v2.0"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.networks.api.rackspacecloud.com/v2.0"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.networks.api.rackspacecloud.com/v2.0"/>
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.networks.api.rackspacecloud.com/v2.0"/>
</service>
<service type="rax:cloudmetrics" name="cloudMetrics">
<endpoint region="IAD" tenantId="123456" publicURL="https://global.metrics.api.rackspacecloud.com/v2.0/123456"/>
</service>
<service type="rax:load-balancer" name="cloudLoadBalancers">
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.loadbalancers.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.loadbalancers.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.loadbalancers.api.rackspacecloud.com/v1.0/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.loadbalancers.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="rax:feeds" name="cloudFeeds">
<endpoint region="HKG" tenantId="123456" publicURL="https://hkg.feeds.api.rackspacecloud.com/123456"
internalURL="https://atom.prod.hkg1.us.ci.rackspace.net/123456"/>
<endpoint region="SYD" tenantId="123456" publicURL="https://syd.feeds.api.rackspacecloud.com/123456"
internalURL="https://atom.prod.syd2.us.ci.rackspace.net/123456"/>
<endpoint region="IAD" tenantId="123456" publicURL="https://iad.feeds.api.rackspacecloud.com/123456"
internalURL="https://atom.prod.iad3.us.ci.rackspace.net/123456"/>
<endpoint region="DFW" tenantId="123456" publicURL="https://dfw.feeds.api.rackspacecloud.com/123456"
internalURL="https://atom.prod.dfw1.us.ci.rackspace.net/123456"/>
</service>
<service type="rax:monitor" name="cloudMonitoring">
<endpoint tenantId="123456" publicURL="https://monitoring.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="rax:dns" name="cloudDNS">
<endpoint tenantId="123456" publicURL="https://dns.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="compute" name="cloudServers">
<endpoint tenantId="123456" publicURL="https://servers.api.rackspacecloud.com/v1.0/123456">
<version id="1.0" info="https://servers.api.rackspacecloud.com/v1.0" list="https://servers.api.rackspacecloud.com/"/>
</endpoint>
</service>
<service type="rax:cdn" name="rackCDN">
<endpoint region="DFW" tenantId="123456" publicURL="https://global.cdn.api.rackspacecloud.com/v1.0/123456"
internalURL="https://global.cdn.api.rackspacecloud.com/v1.0/123456"/>
</service>
<service type="rax:object-cdn" name="cloudFilesCDN">
<endpoint region="DFW" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://cdn1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="SYD" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://cdn4.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="HKG" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://cdn6.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="IAD" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://cdn5.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
</service>
<service type="object-store" name="cloudFiles">
<endpoint region="DFW" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://storage101.dfw1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
internalURL="https://snet-storage101.dfw1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="SYD" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://storage101.syd2.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
internalURL="https://snet-storage101.syd2.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="IAD" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://storage101.iad3.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
internalURL="https://snet-storage101.iad3.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
<endpoint region="HKG" tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
publicURL="https://storage101.hkg1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"
internalURL="https://snet-storage101.hkg1.clouddrive.com/v1/MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f"/>
</service>
</serviceCatalog>
The user object returns a service catalog with the collection of services that the user can access. Each service object includes an endpoint object with information about the service region, tenant, and service access endpoints.
Table: Authentication response: Service object attributes
| Attribute | Type | Description |
|---|---|---|
| service | Object | Returns information about the service |
| service. name | String | The service name attribute identifies each unique service in the,catalog. Service names are defined in the Identity Service configuration,and do not change. However, new services of the same service type can be,added to the catalog with new names. |
| service. type | String | The type of service provided at the specified endpoint,, compute, object-store, or rax:loadbalancer for example. Service types categorize the services registered with OpenStack or custom types,registered with the Rackspace Identity service. For a list of service types, see Service Types. |
Important
Use service type as the primary value for locating a service. If multiple endpoints of the same service type exist in the same region, use service name as the tiebreaker. See Suggested workflow for processing a Service Catalog.
Table: Authentication response: Endpoint catalog object attributes
| Attribute | Type | Description |
|---|---|---|
| endpoint | Object | Returns information to access the specified service. |
| endpoint.region | String | The location of the Rackspace data center where the specified service is hosted. Accessing a service from a regional endpoint allows clients to provision resources in a manner that provides high availability. |
| endpoint.tenantId | String | Some services recognize specification of a tenant. If a service recognizes tenants, the format of the tenant specification is defined only by the service. For details about whether and how to specify a tenant, check the documentation for the service you are using. |
| endpoint.publicURL internalURL AdminURL internalURL | URI | An endpoint can be assigned public, internal, and administrative service URLs. Access to a public URL usually incurs traffic charges. Internal and admin URLs are accessible only to services within the same region. Access to an internal URL is free of charge. The URL includes the API version and tenant ID for services that require it. For example, in the https://iad.servers.api.rackspacecloud.com/v2/12345 URL, the version ID is 2 and the tenant ID is 12345. (The tenant ID is also referred to as the account number.) |
| endpoint.versionId | String | Specifies the API version for the endpoint. The API version is also included in the URL to access the service. |
| endpoint.versionInfo | URI | URI to get information about the specified API version. You can also retrieve information about an API version by using the Show version details API operation for the specified service–for example, GET endpointURL// version_number. |
| endpoint.versionList | URI | URI to get information about all versions. You can also retrieve this information by using the List versions API operation for the specified service, GET endpointURL for example. |
User resource: authentication response attributes
The user object returns account information for the authenticated user that includes user name, ID, default region assignment, and information about role assignments.
Users can have multiple roles, with each role providing specific privileges. For example, each account has an Identity role such as Identity:default to authenticate and gain access to Identity service capabilities and any other RBAC roles assigned to the account.
Responses can be in JSON or XML. For details, see the user object attribute descriptions in the table following the examples.
Example: Authentication response: User object in JSON format
"user": {
"id": "172157",
"roles": [
{
"id": "10000150",
"description": "Checkmate Access role",
"name": "checkmate"
},
{
"tenantId": "MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f",
"id": "5",
"description": "A Role that allows a user access to keystone Service methods",
"name": "object-store:default"
},
{
"tenantId": "123456",
"id": "6",
"description": "A Role that allows a user access to keystone Service methods",
"name": "compute:default"
},
{
"id": "3",
"description": "User Admin Role.",
"name": "identity:user-admin"
}
],
"name": "yourUserName",
"RAX-AUTH:defaultRegion": "DFW",
"RAX-AUTH:sessionInactivityTimeout": "PT15M"
}
Example: Authentication response: User object in XML format
<user id="187345" name="yourUserName" rax-auth:defaultRegion="DFW" rax-auth:sessionInactivityTimeout="PT15M">
<roles>
<role id="10000150" name="checkmate" description="Checkmate Access role" rax-auth:propagate="false"/>
<role id="5" name="object-store:default" description="A Role that allows a user access to keystone Service methods"
tenantId="MossoCloudFS_9c24e3db-52bf-4f26-8dc1-220871796e9f" rax-auth:propagate="true"/>
<role id="6" name="compute:default" description="A Role that allows a user access to keystone Service methods"
tenantId="123456" rax-auth:propagate="true"/>
<role id="3" name="identity:user-admin" description="User Admin Role." rax-auth:propagate="false"/>
</roles>
</user>
The user object returns user information and a roles object that lists the roles associated with the user account.
Table: The user object attributes
| Attribute | Type | Description |
|---|---|---|
| user | Object | Returns user and role information for the user associated with the credentials submitted in the authentication request. |
| user.id | String | The unique, system-generated ID assigned to the user account. The user ID is required by many API operations for managing user accounts and information. |
| user.name | String | The name assigned to the user account. |
| user.RAX-AUTH:defaultRegion | String | If API requests to a Rackspace Cloud service do not explicitly specify a region and multiple endpoints are available, the RAX-AUTH:defaultRegion determines the region that is selected by default. Use the update user API operation to change the value. change the value. |
| user.RAX-AUTH:sessionInactivityTimeout | Duration | Session inactivity timeout property used across all Rackspace UIs. |
| user.roles | Object | Returns information about the roles assigned to the user account associated with the credentials submitted in the authentication request. |
| user.roles.role | Object | Returns information about a role associated with the user account. |
| roles.role.id | String | The unique, system-generated ID assigned to the role in the Identity system. |
| roles.role.name | String | The name that identifies the role in the Identity system. |
| roles.role.description | String | Provides information about the role and its intended use. |
| roles.role.tenantID | String | Identifies the tenant for which the role is scoped. |