openstack/api-site
Code Issues Proposed changes

Clean up project names per new conventions

Browse Source 
Identity Service -> Identity
Block Storage Service -> Block Storage

Closes-Bug: #1293709

Change-Id: I0c619221b5fd0e384683b26300af4acb334a7872
author: diane fleming
This commit is contained in:
Diane Fleming 2014-03-17 14:40:48 -05:00
parent fa63581a9e
commit 0fe1b6163d
19 changed files with 142 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
api-quick-start/src/docbkx/api-quick-start-intro.xml
View File

@ -5,8 +5,8 @@
xml:id="Compute_API_Quick_Start" version="5.0">
<title>OpenStack APIs</title>
<para>To authenticate access to OpenStack services, you must first
issue an authentication request to the OpenStack Identity
Service to acquire an authentication token. To request an
issue an authentication request to OpenStack Identity
to acquire an authentication token. To request an
authentication token, you must supply a payload of credentials
in the authentication request.</para>
<para>Credentials are usually a combination of your user name and
@ -26,7 +26,7 @@
<title>Authentication and API request workflow</title>
<listitem>
<para>Request an authentication token from the Identity
Service endpoint that your cloud administrator gave
endpoint that your cloud administrator gave
you. Send a payload of credentials in the
request:</para>
<informaltable rules="all" width="85%">
@ -113,8 +113,8 @@
<?hard-pagebreak?>
<section xml:id="authenticate">
<title>Authenticate</title>
<para>For a typical OpenStack deployment that runs the
Identity Service, use a cURL command like the following
<para>For a typical OpenStack deployment that runs
Identity, use a cURL command like the following
command to request a token:</para>
<screen><?db-font-size 70%?><prompt>$</prompt> <userinput>curl -i 'http://127.0.0.1:5000/v2.0/tokens' -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{"auth": {"tenantName": "admin", "passwordCredentials": {"username": "admin", "password": "devstack"}}}'</userinput></screen>
<para>If the request succeeds, you receive a <returnvalue>200
@ -140,19 +140,19 @@ Date: Wed, 06 Nov 2013 20:06:24 GMT</computeroutput></screen>
</section>
<section xml:id="send-api-requests">
<title>Send API requests</title>
<para>This section shows how to make some Identity Service and
Compute API calls. For a complete list of Identity Service
<para>This section shows how to make some Identity API and
Compute API calls. For a complete list of Identity
API calls, see <link
xlink:href="http://api.openstack.org/api-ref-identity.html"
>Identity Service APIs</link>. For a complete list of
>Identity APIs</link>. For a complete list of
Compute API calls, see <link
xlink:href="http://api.openstack.org/api-ref-compute.html"
>Compute APIs and Extensions</link>.</para>
<para>Use the Identity Service API to request a list of
<para>Use the Identity API to request a list of
tenants, as follows:</para>
<screen><?db-font-size 70%?><prompt>$</prompt> <userinput>curl -i -X GET http://166.78.21.23:35357/v2.0/tenants -H "User-Agent: python-keystoneclient" -H "X-Auth-Token: <replaceable>token</replaceable>"</userinput></screen>
<programlisting language="json"><?db-font-size 60%?><xi:include href="tenants_list_resp.json" parse="text"/></programlisting>
<para>Use the Identity Service API to request a list of
<para>Use the Identity API to request a list of
endpoints, as follows:</para>
<screen><?db-font-size 70%?><prompt>$</prompt> <userinput>curl -i -X GET http://166.78.21.23:35357/v2.0/endpoints -H "User-Agent: python-keystoneclient" -H "X-Auth-Token: <replaceable>token</replaceable>"</userinput></screen>
<programlisting language="json"><?db-font-size 60%?><xi:include href="endpoints-list-resp.json" parse="text"/></programlisting>

15
api-quick-start/src/docbkx/api-quick-start-onepager.xml
View File

@ -9,12 +9,12 @@
<?dbhtml stop-chunking?>
<para>Although you install each OpenStack service separately, the
OpenStack services work together to meet your cloud needs:
Identity Service, Compute, Image Service, Block Storage
Service, Networking, Object Storage, Orchestration, and
Telemetry. With the <link xlink:href="http://www.trystack.org/"
>TryStack</link> OpenStack installation, these services
work together in the background of the installation.</para>
<para>After you authenticate through the Identity Service, you can
Identity, Compute, Image Service, Block Storage, Networking,
Object Storage, Orchestration, and Telemetry. With the <link
xlink:href="http://www.trystack.org/">TryStack</link>
OpenStack installation, these services work together in the
background of the installation.</para>
<para>After you authenticate through Identity, you can
use the other OpenStack APIs to create and manage resources in
your OpenStack cloud. You can launch instances from images and
assign metadata to instances through the Compute API or the
@ -33,7 +33,8 @@
clients</emphasis></para>
<para>Each OpenStack project provides a command-line
client that enables you to access its API through
easy-to-use commands. See <xref linkend="cli-intro"/>.</para>
easy-to-use commands. See <xref linkend="cli-intro"
/>.</para>
</listitem>
<listitem>
<para><emphasis role="bold">REST clients</emphasis></para>

2
api-ref/src/docbkx/api-ref-identity.xml
View File

@ -8,7 +8,7 @@
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-identity-v2">
<info xreflabel="api-ref-identity.html">
<title>OpenStack Identity Service APIs and extensions</title>
<title>OpenStack Identity APIs and extensions</title>
<copyright>
<year>2010-2014</year>
</copyright>

6
api-ref/src/docbkx/bk-api-ref-identity.xml
View File

@ -20,8 +20,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-identity-pdf">
<info>
<title>OpenStack Identity Service API Reference</title>
<titleabbrev>Identity Service API Reference</titleabbrev>
<title>OpenStack Identity API Reference</title>
<titleabbrev>Identity API Reference</titleabbrev>
<author>
<personname>
<firstname/>
@ -35,7 +35,7 @@
<year>2010-2013</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack Identity Service</productname>
<productname>OpenStack Identity</productname>
<pubdate/>
<legalnotice role="cc-by">
<annotation>

6
api-ref/src/docbkx/ch_compute-v3-ext.xml
View File

@ -20,10 +20,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3">
<title>Compute API v3 extensions</title>
<para>Adds capabilities to the core Compute API. Use extensions to
add features, MIME types, actions, states, headers, parameters,
and resources to the core API. Query the Compute API to list
available extensions with a &GET; request to v3/extensions.</para>
<para>Query the Compute API to list
available extensions with a &GET; request to <code>v3/extensions</code>.</para>
<section xml:id="v3server">
<title>Server admin actions</title>
<para>Permits administrators to perform actions on a server.

4
api-ref/src/docbkx/ch_identity-admin-v2.xml
View File

@ -7,8 +7,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2"
xlink:href="#identity-admin-v2">
<title>Identity Service admin API v2.0</title>
<para>Gets an authentication token that permits access to the
<title>Identity admin API v2.0</title>
<para>Get an authentication token that permits access to the
Compute API.</para>
<wadl:resources
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl"

6
api-ref/src/docbkx/ch_identity-v2-ext.xml
View File

@ -10,10 +10,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v2-ext"
xlink:href="#identity-v2-ext">
<title>Identity Service API v2.0 extensions</title>
<para>Adds capabilities to the core Identity Service Admin API
v2.0.</para>
<para>Query the Identity Service API to list available extensions
<title>Identity API v2.0 extensions</title>
<para>Query the Identity API to list available extensions
with a &GET; request to <code>v2.0/extensions</code>.</para>
<section xml:id="hp-idm-admin-ext">
<title>HP-IDM-serviceId extended parameter</title>

4
api-ref/src/docbkx/ch_identity-v2.xml
View File

@ -7,8 +7,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v2"
xlink:href="#identity-v2">
<title>Identity Service API v2.0</title>
<para>Gets an authentication token that permits access to the
<title>Identity API v2.0</title>
<para>Get an authentication token that permits access to the
Compute API.</para>
<wadl:resources
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl"

18
api-ref/src/docbkx/ch_identity-v3-ext.xml
View File

@ -10,17 +10,15 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v3-ext"
xlink:href="#identity-v3-ext">
<title>Identity Service API v3 extensions</title>
<para>Adds capabilities to the core Identity Service Admin API
v3.</para>
<para>Query the Identity Service API to list available extensions
<title>Identity API v3 extensions</title>
<para>Query the Identity API to list available extensions
with a &GET; request to <code>v3/extensions</code>.</para>
<section xml:id="identity_v3_OS-OAUTH1-ext">
<title>OS-OAUTH1 extension</title>
<para>Enables users to delegate roles to third-party consumers
<para>Enable users to delegate roles to third-party consumers
through the <link xlink:href="http://oauth.net/core/1.0a/"
>OAuth 1.0a specification</link>.</para>
<para>A user is an Identity Service API user who delegates its
<para>A user is an Identity API user who delegates its
roles and who authorizes request tokens. A consumer is a
third-party application that uses OAuth to access a
protected resource. An OAuth-derived token enables admin
@ -31,7 +29,7 @@
required string that is provided with the corresponding
request token in exchange for an access token. An access
token is a token that the consumer uses to request
Identity Service API tokens on behalf of the authorizing
Identity API tokens on behalf of the authorizing
user instead of using the credentials for the user.</para>
<para>Request and access tokens use token keys to identify
themselves. For OpenStack purposes, the token key is the
@ -60,11 +58,9 @@
key from the consumer out-of-band.</para>
</listitem>
<listitem>
<para>The consumer uses the access token to request a
Identity Service API token.</para>
<para>The consumer uses the access token to request an
Identity API token.</para>
</listitem>
</orderedlist>
<!--<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/identity-api/src/v3/wadl/OS-OAUTH1.wadl"/>-->
</section>
</chapter>

24
api-ref/src/docbkx/ch_identity-v3.xml
View File

@ -7,8 +7,8 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v3"
xlink:href="#identity-v3">
<title>Identity Service API v3</title>
<para>Gets an authentication token that permits access to the
<title>Identity API v3</title>
<para>Get an authentication token that permits access to the
Compute API.</para>
<section xml:id="Version_Calls">
<title>Versions</title>
@ -22,7 +22,7 @@
<!-- Tokens -->
<section xml:id="Token_Calls">
<title>Tokens</title>
<para>Enables service developers to manage tokens.</para>
<para>Manage tokens.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- authenticate token -->
<wadl:resource
@ -33,7 +33,7 @@
<!-- Catalog -->
<section xml:id="Catalog_Calls">
<title>Service catalog</title>
<para>Enables service developers to manage the catalog of
<para>Manage the catalog of
services.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create service -->
@ -47,7 +47,7 @@
<!-- Endpoints -->
<section xml:id="Endpoint_Calls">
<title>Endpoints</title>
<para>Enables service developers to manage endpoints.</para>
<para>Manage endpoints.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create endpoint -->
<wadl:resource
@ -60,7 +60,7 @@
<!-- Domains -->
<section xml:id="Domain_Calls">
<title>Domains</title>
<para>Enables service developers to manage domains.</para>
<para>Manage domains.</para>
<para>Domains represent collections of users, groups, and
projects. Each is owned by exactly one domain. Users,
however, can be associated with multiple projects by
@ -113,7 +113,7 @@
<!-- Projects -->
<section xml:id="Project_Calls">
<title>Projects</title>
<para>Enables service developers to manage projects.</para>
<para>Manage projects.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create project -->
<wadl:resource
@ -140,7 +140,7 @@
<!-- Users -->
<section xml:id="User_Calls">
<title>Users</title>
<para>Enables service developers to manage users.</para>
<para>Manage users.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create user -->
<wadl:resource
@ -159,7 +159,7 @@
<!-- Groups -->
<section xml:id="Group_Calls">
<title>Groups</title>
<para>Enables service developers to manage groups.</para>
<para>Manage groups.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create group -->
<wadl:resource
@ -179,7 +179,7 @@
<!-- Credentials -->
<section xml:id="Credential_Calls">
<title>Credentials</title>
<para>Enables service developers to manage credentials.</para>
<para>Manage credentials.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create credential -->
<wadl:resource
@ -192,7 +192,7 @@
<!-- Roles -->
<section xml:id="Role_Calls">
<title>Roles</title>
<para>Enables service developers to manage roles.</para>
<para>Manage roles.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create role -->
<wadl:resource
@ -207,7 +207,7 @@
<!-- Policies -->
<section xml:id="Policy_Calls">
<title>Policies</title>
<para>Enables service developers to manage policies.</para>
<para>Manage policies.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create policy -->
<wadl:resource

6
api-ref/src/docbkx/itemizedlist-service-list.xml
View File

@ -8,7 +8,7 @@
version="5.0-extension RackBook-2.0" xml:id="service-list">
<listitem>
<para><link xlink:href="api-ref-blockstorage.html">Block
Storage Service API</link></para>
Storage API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-compute.html">Compute
@ -19,8 +19,8 @@
extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-identity.html">Identity
Service API and extensions</link></para>
<para><link xlink:href="api-ref-identity.html">Identity API
and extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-image.html">Image Service

2
api-ref/src/docbkx/preface.xml
View File

@ -16,7 +16,7 @@
<xi:include href="itemizedlist-service-list.xml"/>
<para>You must install the packages for each API separately. After
you authenticate through the <link
xlink:href="api-ref-identity.html">Identity Service
xlink:href="api-ref-identity.html">Identity
API</link>, you can use the other APIs and extensions to
launch server instances, create images, assign metadata to
instances and images, create containers and objects, and

7
api-ref/src/wadls/identity-api/src/v2.0/OS-KSADM/samples/service.xml
View File

@ -1,4 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<service xmlns="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0"
id="123" name="nova" type="compute" description="OpenStack Compute Service" />
<service
xmlns="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0"
id="123" name="nova" type="compute"
description="OpenStack Compute Service"/>

10
api-ref/src/wadls/identity-api/src/v2.0/OS-KSADM/samples/services.xml
View File

@ -1,6 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<services xmlns="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0">
<service id="123" name="nova" type="compute" description="OpenStack Compute Service" />
<service id="234" name="glance" type="image" description="OpenStack Image Service" />
<services
xmlns="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0">
<service id="123" name="nova" type="compute"
description="OpenStack Compute Service"/>
<service id="234" name="glance" type="image"
description="OpenStack Image Service"/>
</services>

8
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl
View File

@ -115,8 +115,8 @@
itemNotFound (<code>404</code>) fault is returned for
a token that is not valid.</para>
<para>This extension
might decrypt 'X-Subject-Token' header and internally
call the normal validation for the Identity Service,
might decrypt <code>X-Subject-Token</code> header and internally
call the normal validation for Identity,
passing in all headers and query parameters. It should
therefore support all existing calls on
<code>/tokens/{tokenId}</code>, including
@ -154,8 +154,8 @@
itemNotFound (<code>404</code>) fault is returned for
a token that is not valid.</para>
<para>This extension
might decrypt 'X-Subject-Token' header and internally
call the normal validation for the Identity Service,
might decrypt <code>X-Subject-Token</code> header and internally
call the normal validation for Identity,
passing in all headers and query parameters. It should
therefore support all existing calls on
<code>/tokens/{tokenId}</code>, including

114
api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl
View File

@ -199,7 +199,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get version details">
<para>Gets detailed information about a specified version
of the Identity Service API.</para>
of the Identity API.</para>
</wadl:doc>
<response status="200 203">
<!-- <param name="location" style="plain" type="xsd:anyURI"
@ -302,23 +302,22 @@
interface by using the POST method with v2.0/tokens
supplied as the path. Include a payload of credentials
in the body.</para>
<para>The Identity Service is a ReSTful web service. It is
the entry point to all service APIs. To access the
Identity Service, you must know the URL of the
Identity Service.</para>
<para>The Identity API is a ReSTful web service. It is the
entry point to all service APIs. To access the
Identity API, you must know its URL.</para>
<para>Each ReST request against the Identity Service
requires the X-Auth-Token header. Clients obtain this
token, along with the URL to other service APIs, by
first authenticating against the Identity Service with
valid credentials.</para>
first authenticating against Identity with valid
credentials.</para>
<para>If the authentication token has expired, a
<errorcode>401</errorcode> response code is
returned.</para>
<para>If the token specified in the request body has
expired, this call returns a
<errorcode>404</errorcode> response code.</para>
<para>The Identity Service treats expired tokens as
invalid tokens.</para>
<para>Identity treats expired tokens as invalid
tokens.</para>
<para>The deployment determines how long expired tokens
are stored.</para>
</wadl:doc>
@ -326,9 +325,9 @@
<param name="tenantName" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The tenant name. Both the
<code>tenantId</code> and
<code>tenantName</code> attributes are
><para>The tenant name. Both the
<code>tenantId</code> and
<code>tenantName</code> attributes are
optional, but should not be specified
together. If both attributes are specified,
the server responds with a <code>400</code>
@ -337,9 +336,9 @@
<param name="tenantId" style="plain" required="false"
type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The tenant ID. Both the
<code>tenantId</code> and
<code>tenantName</code> attributes are
><para>The tenant ID. Both the
<code>tenantId</code> and
<code>tenantName</code> attributes are
optional, but should not be specified
together. If both attributes are specified,
the server responds with a <code>400</code>
@ -348,7 +347,7 @@
<param name="passwordCredentials" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>passwordCredentials</code>
><para>A <code>passwordCredentials</code>
object. To authenticate, you must provide
either a user ID and password or a
token.</para></wadl:doc>
@ -356,7 +355,7 @@
<param name="username" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The user name. Required if you include
><para>The user name. Required if you include
the <code>passwordCredentials</code> object.
If you do not provide a password credentials,
you must provide a token.</para></wadl:doc>
@ -364,23 +363,25 @@
<param name="password" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The password of the user. Required if
><para>The password of the user. Required if
you include the
<code>passwordCredentials</code> object.
<code>passwordCredentials</code> object.
If you do not provide a password credentials,
you must provide a token.</para></wadl:doc>
</param>
<param name="token" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>token</code> object. Required if you do not
provide password credentials.</para></wadl:doc>
><para>A <code>token</code> object. Required
if you do not provide password
credentials.</para></wadl:doc>
</param>
<param name="id" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The token ID. This is a required field in the
<code>token</code> object.</para></wadl:doc>
><para>The token ID. This is a required field
in the <code>token</code>
object.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="identity:auth">
@ -388,7 +389,8 @@
<xsdxt:sample
title="Authenticate with credentials: JSON request">
<xsdxt:code
href="../samples/auth_credentials_admin.json"/>
href="../samples/auth_credentials_admin.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
@ -398,7 +400,8 @@
<xsdxt:sample
title="Authenticate with credentials: XML request">
<xsdxt:code
href="../samples/auth_credentials_admin.xml"/>
href="../samples/auth_credentials_admin.xml"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
@ -408,7 +411,8 @@
<xsdxt:sample
title="Authenticate with token: JSON request">
<xsdxt:code
href="../samples/auth_token_request.json"/>
href="../samples/auth_token_request.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
@ -427,116 +431,118 @@
<param name="access" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>An <code>access</code>
object.</para></wadl:doc>
><para>An <code>access</code>
object.</para></wadl:doc>
</param>
<param name="token" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>token</code>
object.</para></wadl:doc>
><para>A <code>token</code>
object.</para></wadl:doc>
</param>
<param name="issued_at" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A timestamp that indicates when the
><para>A timestamp that indicates when the
token was issued.</para></wadl:doc>
</param>
<param name="expires" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A timestamp that indicates when the
><para>A timestamp that indicates when the
token expires.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The authentication token. In the
><para>The authentication token. In the
example, the token is
<code>my_id</code>.</para></wadl:doc>
</param>
<param name="tenant" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>tenant</code>
object.</para></wadl:doc>
><para>A <code>tenant</code>
object.</para></wadl:doc>
</param>
<param name="description" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The description of the tenant. If not
><para>The description of the tenant. If not
set, this value is
<code>null</code>.</para></wadl:doc>
<code>null</code>.</para></wadl:doc>
</param>
<param name="enabled" style="plain" required="true"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Indicates whether the tenant is enabled
><para>Indicates whether the tenant is enabled
or disabled.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The tenant ID.</para></wadl:doc>
><para>The tenant ID.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The tenant name.</para></wadl:doc>
><para>The tenant name.</para></wadl:doc>
</param>
<param name="serviceCatalog" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>serviceCatalog</code>
><para>A <code>serviceCatalog</code>
object.</para></wadl:doc>
</param>
<param name="endpoints" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>One or more <code>endpoints</code>
><para>One or more <code>endpoints</code>
objects. Each object shows the
<code>adminURL</code>,
<code>adminURL</code>,
<code>region</code>, <code>internalURL</code>,
<code>id</code>, and
<code>publicURL</code> for the
<code>id</code>, and
<code>publicURL</code> for the
endpoint.</para></wadl:doc>
</param>
<param name="endpoints_links" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Links for the
endpoint.</para></wadl:doc>
><para>Links for the
endpoint.</para></wadl:doc>
</param>
<param name="type" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Endpoint type.</para></wadl:doc>
><para>Endpoint type.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Endpoint name.</para></wadl:doc>
><para>Endpoint name.</para></wadl:doc>
</param>
<param name="user" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>user</code> object, which shows
><para>A <code>user</code> object, which shows
the <code>username</code>,
<code>roles_links</code>, <code>id</code>,
<code>roles</code>, and
<code>roles_links</code>, <code>id</code>,
<code>roles</code>, and
<code>name</code>.</para></wadl:doc>
</param>
<param name="metadata" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>metadata</code> object.</para></wadl:doc>
><para>A <code>metadata</code>
object.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="identity:access">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Authenticate with credentials: JSON response">
<xsdxt:code href="../samples/auth_admin.json"/>
<xsdxt:code href="../samples/auth_admin.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation>

12
api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl
View File

@ -94,7 +94,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get version details">
<para role="shortdesc">Gets detailed information about a
specified version of the Identity Service API.</para>
specified version of the Identity API.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
@ -195,13 +195,13 @@
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Authenticates and generates a
token.</para>
<para>The Identity Service is a ReSTful web service. It is
<para>The Identity API is a ReSTful web service. It is
the entry point to all service APIs. To access the
Identity Service, you must know its URL.</para>
<para>Each ReST request against the Identity Service
Identity API, you must know its URL.</para>
<para>Each ReST request against Identity
requires the X-Auth-Token header. Clients obtain this
token, along with the URL to other service APIs, by
first authenticating against the Identity Service with
first authenticating against Identity with
valid credentials.</para>
<para>To authenticate, you must provide either a user ID
and password or a token.</para>
@ -211,7 +211,7 @@
<para>If the token specified in the request has expired,
this call returns a <errorcode>404</errorcode>
response code.</para>
<para>The Identity Service treats expired tokens as
<para>Identity treats expired tokens as
invalid tokens.</para>
<para>The deployment determines how long expired tokens
are stored.</para>

8
api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1.wadl
View File

@ -518,7 +518,7 @@
<para role="shortdesc">Deletes a specified
consumer.</para>
<para>When you delete a consumer, any associated request
tokens, access tokens, and Identity Service API tokens
tokens, access tokens, and Identity API tokens
are also deleted.</para>
</wadl:doc>
<response status="204"> </response> &commonFaults; </method>
@ -596,7 +596,7 @@
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The request token key that the Identity
Service returns.</para></wadl:doc>
API returns.</para></wadl:doc>
</param>
<param name="oauth_token_secret" style="plain"
type="xsd:dict" required="true">
@ -610,7 +610,7 @@
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The ISO 8601 date time when a request token
expires. If the Identity Service API does not
expires. If the Identity API does not
include this attribute or the attribute is
null, the token lasts
indefinitely.</para></wadl:doc>
@ -649,7 +649,7 @@
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The request token key that the Identity
Service returns.</para></wadl:doc>
API returns.</para></wadl:doc>
</param>
<param name="oauth_token_secret" style="plain"
type="xsd:dict" required="true">

10
api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin.wadl
View File

@ -383,7 +383,7 @@
returned.</para>
<para>If the subject token has expired, this call returns
a <errorcode>404</errorcode> response code.</para>
<para>The Identity Service treats expired tokens as not
<para>The Identity API treats expired tokens as not
valid tokens.</para>
<para>The deployment determines how long expired tokens
are stored.</para>
@ -402,11 +402,11 @@
<para>A token scoped to a <code>domain</code> also has
both a service <code>catalog</code> and the user's
roles applicable to the <code>project</code>.</para>
<para>Optionally, the identity service implementation
<para>Optionally, The Identity API implementation
might return an <code>authentication</code> attribute
to indicate the supported authentication methods.
</para><para>For authentication processes that require
multiple round trips, the identity service
multiple round trips, The Identity API
implementation might return an <code>HTTP 401 Not
Authorized</code> error with additional
information for the next authentication step.</para>
@ -611,7 +611,7 @@
<para>Pass your own token in the <code>X-Auth-Token</code>
header and the token to be validated in the
<code>X-Subject-Token</code> header. The Identity
Service returns the same response as when the subject
API returns the same response as when the subject
token was issued by <code>POST /auth/tokens</code>.
</para>
</wadl:doc>
@ -647,7 +647,7 @@
provided, even in the <code>X-Subject-Token</code>
header.</para>
<important>
<para>The Identity service returns the same response
<para>The Identity API returns the same response
as when the subject token was issued by <code>POST
/auth/tokens</code>, even if an error occurs
because the token is not valid. A 204 response