openstack-attic/identity-api
Code Issues Proposed changes

Update KSADM extension for Identity v2.0

Browse Source 
Closes-Bug: #1278847

Change-Id: I30974626610e0cb49c91910812b8e4944cfaea6f
author: diane fleming
This commit is contained in:
Diane Fleming 2014-04-25 15:42:20 -05:00
parent 85e91f7cf2
commit 871828ee21
5 changed files with 172 additions and 785 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

232
openstack-identity-api/v2.0/src/docbkx/OS-KSADM/OS-KSADM-admin-devguide.xml
View File

@ -1,232 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE book [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
<imageobject>
<imagedata fileref="img/Arrow_east.svg"
format="SVG" scale="60"/>
</imageobject>
</inlinemediaobject>'>
<!ENTITY CODES 'Normal Response Code(s):'>
<!ENTITY ERROR_CODES 'Error Response Code(s):'>
<!-- Information about the extension -->
<!ENTITY VERSION "v1.0">
<!ENTITY PUB_DATE "2011-08-26">
<!ENTITY ALIAS "OS-KSADM">
<!ENTITY URI_REFHEAD '
<thead xmlns="http://docbook.org/ns/docbook">
<tr>
<td colspan="1">Verb</td>
<td colspan="1">URI</td>
<td colspan="4">Description</td>
</tr>
</thead>'>
<!ENTITY NAMESPACE "http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0">
<!ENTITY CURRENTGUIDE "http://docs.openstack.org/api/openstack-identity/extensions/OS-KSADM/OS-KSADM-admin-devguide.pdf">
<!ENTITY CURRENTWADL "http://docs.openstack.org/api/openstack-identity/extensions/OS-KSADM/OS-KSADM-admin.wadl">
<!ENTITY EXTENSIONXSD "http://docs.openstack.org/api/openstack-identity/extensions/OS-KSADM/xsd/OS-KSADM.xsd">
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:html="http://www.w3.org/1999/xhtml" version="5.0"
status="draft" xml:id="Identity-Developer-Guide-OS-KSADM">
<?rax subtitle.font.size="20px"?>
<title>OpenStack Identity OS-KSADM (Admin Operations)</title>
<titleabbrev>OS-KSADM (Admin)</titleabbrev>
<info>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack</orgname>
</affiliation>
</author>
<copyright>
<year>2010</year>
<year>2011</year>
<holder>OpenStack</holder>
</copyright>
<releaseinfo>API v2.0</releaseinfo>
<productname>OpenStack Identity</productname>
<pubdate>2011-08-29</pubdate>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
<othercredit>
<personname>
<firstname>Joe</firstname>
<surname>Savak</surname>
</personname>
<email>joe.savak@RACKSPACE.COM</email>
</othercredit>
<extension xmlns="http://docs.openstack.org/common/api/v1.0"
xmlns:atom="http://www.w3.org/2005/Atom"
name="OpenStack Identity Admin"
namespace="http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0"
alias="OS-KSADM" updated="2011-08-14T13:25:27-06:00">
<description> OpenStack extensions to Identity API v2.0,
which enable administrative API operations. </description>
<atom:link rel="describedby" type="application/pdf"
href="https://raw.github.com/openstack/identity-api/master/openstack-identity-api/src/docbkx/extensions/OS-KSADM/OS-KSADM-admin-devguide.pdf"/>
<atom:link rel="describedby" type="application/pdf"
href="https://raw.github.com/openstack/identity-api/master/openstack-identity-api/src/docbkx/extensions/OS-KSADM/OS-KSADM-admin.wadl"
/>
</extension>
<abstract>
<para>This document includes details on various operations
supported by the OS-KSADM extensions on top of core
OpenStack Identity operations.</para>
</abstract>
<revhistory>
<revision>
<date>2011-09-13</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Initial release.</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</info>
<chapter xml:id="api_operations" role="api-reference">
<title>Extension Operations</title>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="Admin_API_Service_Developer_Operations-d1e1357"
version="5.0" role="api-reference">
<title>OS-KSADM Admin Extension</title>
<para>Extension operations.</para>
<table rules="all">
<caption>Authentication Header</caption>
<thead>
<tr>
<td>Header Type</td>
<td>Name</td>
<td>Value</td>
</tr>
</thead>
<tbody>
<tr>
<td>HTTP/1.1 Request</td>
<td>X-Auth-Token</td>
<td>txfa8426a08eaf</td>
</tr>
</tbody>
</table>
<?hard-pagebreak?>
<para>The following calls are supported by OS-KSADM-admin
Extension:</para>
<section xml:id="User_Operations_OS-KSADM">
<title>User Operations</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#users">
<wadl:method href="listUsers"/>
<wadl:method href="addUser"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#userById">
<wadl:method href="updateUser"/>
<wadl:method href="deleteUser"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#enabled">
<wadl:method href="setUserEnabled"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#userRoles">
<wadl:method href="listUserRoles"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#userRoleById">
<wadl:method href="addUserRole"/>
<wadl:method href="deleteUserRole"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#userCredentials">
<wadl:method href="ksadm-addUserCredential"/>
<wadl:method href="listCredentials"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#userCredentialsByType">
<wadl:method href="updateUserCredential"/>
<wadl:method href="deleteUserCredential"/>
<wadl:method href="getUserCredential"/>
</wadl:resource>
</wadl:resources>
</section>
<?hard-pagebreak?>
<section xml:id="Tenant_Operations_OS-KSADM">
<title>Tenant Operations</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#tenants">
<wadl:method href="addTenant"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#tenantById">
<wadl:method href="updateTenant"/>
<wadl:method href="deleteTenant"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#usersForTenant">
<wadl:method href="listUsersForTenant"/>
</wadl:resource>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#userSpecificRoleForTenant">
<wadl:method href="addRolesToUserOnTenant"/>
<wadl:method href="deleteRoleFromUserOnTenant"
/>
</wadl:resource>
</wadl:resources>
</section>
<?hard-pagebreak?>
<section xml:id="Role_Operations_OS-KSADM">
<title>Role Operations</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#roles"/>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#roleId"/>
</wadl:resources>
</section>
<?hard-pagebreak?>
<section xml:id="Service_Operations_OS-KSADM">
<title>Service Operations</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#services"/>
<wadl:resource
href="../wadl/OS-KSADM-admin.wadl#serviceId"/>
</wadl:resources>
</section>
</section>
</chapter>
</book>

161
openstack-identity-api/v2.0/src/docbkx/OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml
View File

@ -1,161 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE book [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
<imageobject>
<imagedata fileref="img/Arrow_east.svg"
format="SVG" scale="60"/>
</imageobject>
</inlinemediaobject>'>
<!ENTITY CODES 'Normal Response Code(s):'>
<!ENTITY ERROR_CODES 'Error Response Code(s):'>
<!-- Information about the extension -->
<!ENTITY VERSION "v1.0">
<!ENTITY PUB_DATE "2011-08-26">
<!ENTITY ALIAS "OS-KSCATALOG">
<!ENTITY URI_REFHEAD '
<thead xmlns="http://docbook.org/ns/docbook">
<tr>
<td colspan="1">Verb</td>
<td colspan="1">URI</td>
<td colspan="4">Description</td>
</tr>
</thead>'>
<!ENTITY NAMESPACE "http://docs.openstack.org/identity/api/ext/OS-KSCATALOG/v1.0">
<!ENTITY CURRENTGUIDE "http://docs.openstack.org/identity/api/v2.0">
<!ENTITY CURRENTWADL "OS-KSCATALOG-admin.wadl">
<!ENTITY EXTENSIONXSD "xsd/OS-KSCATALOG.xsd">
]>
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg"
xmlns:html="http://www.w3.org/1999/xhtml" version="5.0" status="draft"
xml:id="Identity-Developer-Guide-OS-KSCATALOG">
<title>OpenStack Identity OS-KSCATALOG Extension</title>
<titleabbrev>OS-KSCATALOG (Admin)</titleabbrev>
<info>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack</orgname>
</affiliation>
</author>
<copyright>
<year>2010</year>
<year>2011</year>
<holder>OpenStack</holder>
</copyright>
<releaseinfo>API v2.0</releaseinfo>
<productname>OpenStack Identity</productname>
<pubdate>2011-08-29</pubdate>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the template.</remark>
</annotation>
</legalnotice>
<othercredit>
<personname>
<firstname>Joe</firstname>
<surname>Savak</surname>
</personname>
<email>joe.savak@RACKSPACE.COM</email>
</othercredit>
<extension xmlns="http://docs.openstack.org/common/api/v1.0"
xmlns:atom="http://www.w3.org/2005/Atom"
name="OpenStack Keystone Catalog" namespace="http://docs.openstack.org/identity/api/ext/OS-KSCATALOG/v1.0"
alias="OS-KSCATALOG"
updated="2011-08-14T13:25:27-06:00">
<description>OpenStack extensions to Identity API v2.0 enabling Admin Operations to support Catalog. Adds the capability to do CRUD on Endpoint Templates and Endpoints</description>
<atom:link rel="describedby" type="application/pdf"
href="https://github.com/openstack/keystone/raw/master/keystone/content/admin/OS-KSCATALOG-admin-devguide.pdf"/>
<atom:link rel="describedby" type="application/vnd.sun.wadl+xml"
href="https://github.com/openstack/keystone/raw/master/keystone/content/admin/OS-KSCATALOG-admin.wadl"/>
</extension>
<abstract>
<para>This document includes details on various operations supported by the OS-KSCATALOG extensions on top of core OpenStack Identity operations.</para>
</abstract>
<revhistory>
<revision>
<date>2011-09-13</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>
Initial release.
</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</info>
<chapter xml:id="api_operations" role="api-reference">
<title>Extension Operations</title>
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="Admin_API_Service_Developer_Operations-OS-KSCATALOG" version="5.0" role="api-reference">
<title>OS-KSCATALOG Admin Extension</title>
<table rules="all">
<caption>Authentication Header</caption>
<thead>
<tr>
<td>Header Type</td>
<td>Name</td>
<td>Value</td>
</tr>
</thead>
<tbody>
<tr>
<td>HTTP/1.1 Request</td>
<td>X-Auth-Token</td>
<td>txfa8426a08eaf</td>
</tr>
</tbody>
</table>
<?hard-pagebreak?>
<para>The OS-KSCATALOG extension extends the OpenStack Identity Admin API v2.0 with the following calls:</para>
<section xml:id="Endpoint_Template_Operations_OS-KSCATALOG">
<title>Endpoint Template Operations</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadl/OS-KSCATALOG-admin.wadl#endpointTemplates">
<wadl:method href="listEndpointTemplates"/>
<wadl:method href="addEndpointTemplate"/>
</wadl:resource>
<wadl:resource href="../wadl/OS-KSCATALOG-admin.wadl#endpointTemplateId">
<wadl:method href="getEndpointTemplate"/>
<wadl:method href="deleteEndpointTemplate"/>
</wadl:resource>
</wadl:resources>
</section>
<?hard-pagebreak?>
<section xml:id="Tenant_Operations_OS-KSCATALOG">
<title>Endpoint Operations</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadl/OS-KSCATALOG-admin.wadl#endpoints">
<wadl:method href="listEndpoints"/>
<wadl:method href="addEndpoint"/>
</wadl:resource>
<wadl:resource href="../wadl/OS-KSCATALOG-admin.wadl#endpoint">
<wadl:method href="getEndpoint"/>
<wadl:method href="deleteEndpoint"/>
</wadl:resource>
</wadl:resources>
</section>
</section>
</chapter>
</book>

182
openstack-identity-api/v2.0/src/docbkx/OS-KSEC2/OS-KSEC2-admin-devguide.xml
View File

@ -1,182 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
<imageobject>
<imagedata fileref="img/Arrow_east.svg"
format="SVG" scale="60"/>
</imageobject>
</inlinemediaobject>'>
<!ENTITY CODES 'Normal Response Code(s):'>
<!ENTITY ERROR_CODES 'Error Response Code(s):'>
<!-- Information about the extension -->
<!ENTITY VERSION "v1.0">
<!ENTITY PUB_DATE "2011-09-13">
<!ENTITY ALIAS "OS-KSEC2">
<!ENTITY URI_REFHEAD '
<thead xmlns="http://docbook.org/ns/docbook">
<tr>
<td colspan="1">Verb</td>
<td colspan="1">URI</td>
<td colspan="4">Description</td>
</tr>
</thead>'>
<!ENTITY NAMESPACE "http://docs.openstack.org/identity/api/ext/OS-KSEC2/v1.0">
<!ENTITY CURRENTGUIDE "http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf">
<!ENTITY CURRENTWADL "../admin/OS-KSEC2-admin.wadl">
<!ENTITY EXTENSIONXSD "xsd/OS-KSEC2-credentials.xsd">
<!ENTITY EC2CREDENTIALSEXAMPLEXML "../OS-KSEC2/samples/ec2Credentials.xml">
<!ENTITY EC2CREDENTIALSEXAMPLEJSON "../OS-KSEC2/samples/ec2Credentials.json">
<!ENTITY EXTENSIONQUERYRESPONSEXML "../../samples/extension.xml">
<!ENTITY EXTENSIONQUERYRESPONSEJSON "../../samples/extension.json">
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
version="5.0" status="draft" xml:id="book-0001">
<?rax subtitle.font.size="12px"?>
<title>OpenStack Identity EC2 authentication Extension (Admin Operations)</title>
<titleabbrev>OS-KSEC2 (Admin)</titleabbrev>
<info>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack</orgname>
</affiliation>
</author>
<copyright>
<year>2010</year>
<year>2011</year>
<holder>OpenStack</holder>
</copyright>
<productname>OpenStack Identity</productname>
<pubdate>&PUB_DATE;</pubdate>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the template.</remark>
</annotation>
</legalnotice>
<abstract>
<para>
This document is intended for client developers interested
in using the OpenStack EC2 Authentication Service Extension along with the
OpenStack Identity
<abbrev>API</abbrev> v2.0.
</para>
</abstract>
<extension
xmlns="http://docs.openstack.org/common/api/v1.0" xmlns:atom="http://www.w3.org/2005/Atom"
name="OpenStack EC2 authentication Extension"
namespace="http://docs.openstack.org/identity/api/ext/OS-KSEC2/v1.0"
alias="OS-KSEC2"
updated="2011-08-25T09:50:00-00:00">
<description>
Adds the capability to support EC2 style authentication.
</description>
<atom:link rel="describedby"
type="application/pdf"
href="https://github.com/openstack/keystone/raw/master/keystone/content/admin/OS-KSEC2-admin-devguide.pdf"/>
<atom:link rel="describedby"
type="application/vnd.sun.wadl+xml"
href="https://raw.github.com/openstack/keystone/master/keystone/content/admin/OS-KSEC2-admin.wadl"/>
</extension>
<revhistory>
<revision>
<date>2011-09-13</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>
Initial release.
</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</info>
<chapter xml:id="chapter-0001">
<title>Summary of Changes</title>
<para>
The OpenStack EC2 authentication Extension allows crud/listing operations on <parameter>ec2Credentials</parameter>.
</para>
<section xml:id="NewHeaders-0001">
<title>New Headers</title>
<para>None.</para>
</section>
<section xml:id="NewFaults0001">
<title>New Faults</title>
<para>None.</para>
</section>
<section xml:id="NewResources-0001">
<title>New Resources</title>
<para>None.</para>
</section>
<section xml:id="NewActions0001">
<title>New Actions</title>
<para>None.</para>
</section>
<section xml:id="NewElement0001">
<title>New Element</title>
<section xml:id="RackExt-0001">
<title>ec2Credentials</title>
<para>This extension allows authentication calls to accept new type of credentials <parameter>ec2Credentials</parameter>.
These are additional type of credentials defined to support ec2 style authentication.
Examples of <parameter>ec2Credentials</parameter> are illustrated below
</para>
<example>
<title>ec2Credentials XML</title>
<programlisting language="xml"><xi:include href="&EC2CREDENTIALSEXAMPLEXML;" parse="text"/></programlisting>
</example>
<example>
<title>ec2Credentials JSON</title>
<programlisting language="json"><xi:include href="&EC2CREDENTIALSEXAMPLEJSON;" parse="text"/></programlisting>
</example>
</section>
</section>
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="Admin_API_Service_Developer_Operations-OS-KSEC2" version="5.0" role="api-reference">
<title>OS-KSEC2 Admin Extension</title>
<table rules="all">
<caption>Authentication Header</caption>
<thead>
<tr>
<td>Header Type</td>
<td>Name</td>
<td>Value</td>
</tr>
</thead>
<tbody>
<tr>
<td>HTTP/1.1 Request</td>
<td>X-Auth-Token</td>
<td>txfa8426a08eaf</td>
</tr>
</tbody>
</table>
<para>The OpenStack EC2 authentication extension adds the following calls:</para>
<section xml:id="User_Operations_OS-KSEC2">
<title>User Operations</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadl/OS-KSEC2-admin.wadl#userCredentials"/>
<wadl:resource href="../wadl/OS-KSEC2-admin.wadl#userCredentialsByType"/>
</wadl:resources>
</section>
</section>
</chapter>
</book>

196
openstack-identity-api/v2.0/src/docbkx/OS-KSEC2/OS-KSEC2-service-devguide.xml
View File

@ -1,196 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
<imageobject>
<imagedata fileref="img/Arrow_east.svg"
format="SVG" scale="60"/>
</imageobject>
</inlinemediaobject>'>
<!ENTITY CODES 'Normal Response Code(s):'>
<!ENTITY ERROR_CODES 'Error Response Code(s):'>
<!-- Information about the extension -->
<!ENTITY VERSION "v1.0">
<!ENTITY PUB_DATE "2011-08-26">
<!ENTITY ALIAS "OS-KSEC2">
<!ENTITY URI_REFHEAD '
<thead xmlns="http://docbook.org/ns/docbook">
<tr>
<td colspan="1">Verb</td>
<td colspan="1">URI</td>
<td colspan="4">Description</td>
</tr>
</thead>'>
<!ENTITY EC2CREDENTIALSREQUESTXML "../OS-KSEC2/samples/auth_credentials-OS-KSEC2.xml">
<!ENTITY EC2CREDENTIALSREQUESTJSON "../OS-KSEC2/samples/auth_credentials-OS-KSEC2.json">
<!ENTITY EC2CREDENTIALSRESPONSEXML "../OS-KSEC2/samples/auth.xml">
<!ENTITY EC2CREDENTIALSRESPONSEJSON "../OS-KEC2/samples/auth.json">
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml" version="5.0"
status="draft" xml:id="book-0001">
<?rax subtitle.font.size="12px"?>
<title>OpenStack Identity EC2 authentication Extension (Service
Operations)</title>
<titleabbrev>OS-KSEC2 (Admin)</titleabbrev>
<info>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack</orgname>
</affiliation>
</author>
<copyright>
<year>2010</year>
<year>2011</year>
<holder>OpenStack</holder>
</copyright>
<releaseinfo>EXT v1.0</releaseinfo>
<productname>OpenStack Identity</productname>
<pubdate>&PUB_DATE;</pubdate>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
<abstract>
<para>This document is intended for client developers
interested in using the OpenStack EC2 Authentication
Service Extension along with the Keystone - OpenStack
Identity (<abbrev>API</abbrev>).</para>
</abstract>
<extension xmlns="http://docs.openstack.org/common/api/v1.0"
xmlns:atom="http://www.w3.org/2005/Atom"
name="OpenStack EC2 authentication Extension"
namespace="http://docs.openstack.org/identity/api/ext/OS-KSEC2/v1.0"
alias="OS-KSEC2-service"
updated="2011-08-25T09:50:00-00:00">
<description> Adds the capability to support EC2 style
authentication. </description>
<atom:link rel="describedby" type="application/pdf"
href="https://github.com/openstack/keystone/raw/master/keystone/content/service/OS-KSEC2-service-devguide.pdf"/>
<atom:link rel="describedby" type="application/xml"
href="http://docs.openstack.org/api/openstack-identity/ext/os/common/xsd/OS-KSEC2-credentials.xsd"
/>
</extension>
<revhistory>
<revision>
<date>2011-08-26</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Initial release.</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</info>
<chapter xml:id="chapter-0001">
<title>Summary of Changes</title>
<para>The OpenStack EC2 authentication Service Extension
allows authenticate call using ec2Credentials.</para>
<section xml:id="NewHeaders-0001">
<title>New Headers</title>
<para>None.</para>
</section>
<section xml:id="NewFaults0001">
<title>New Faults</title>
<para>None.</para>
</section>
<section xml:id="NewResources-0001">
<title>New Resources</title>
<para>None.</para>
</section>
<section xml:id="NewActions0001">
<title>New Actions</title>
<para>None.</para>
</section>
<section xml:id="NewElement0001">
<title>New Element</title>
<section xml:id="RackExt-0001">
<title>OS-KSEC2 Admin Extension</title>
<section xml:id="Authenticate-d1e1166">
<title>Authenticate</title>
<para>This extension enables the
<parameter>ec2Credentials</parameter>
parameter, which supports the EC2 style of
authentication.</para>
<informaltable rules="all"> &URI_REFHEAD; <tbody>
<tr>
<td colspan="1"> &POST; </td>
<td colspan="1">/tokens</td>
<td colspan="4">Authenticate to
generate a token.</td>
</tr>
</tbody>
</informaltable>
<simpara>&CODES;<returnvalue>200</returnvalue>,
<returnvalue>203</returnvalue></simpara>
<simpara>&ERROR_CODES; unauthorized
(<errorcode>401</errorcode>), userDisabled
(<errorcode>403</errorcode>), badRequest
(<errorcode>400</errorcode>),
identityFault (<errorcode>500</errorcode>),
serviceUnavailable(<errorcode>503</errorcode>)</simpara>
<para>This call returns a token if successful.
Clients obtain this token, along with the URL
to other service APIs, by first authenticating
against Identity and supplying valid
credentials. This extension provides support
for Rackspace style API key
credentials.</para>
<para>Client authentication is provided via a ReST
interface using the POST method, with
v2.0/tokens supplied as the path. A payload of
credentials must be included in the
body.</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>
<example>
<title>XML Auth Request using
EC2CREDENTIALS</title>
<programlisting language="xml"><xi:include href="../OS-KSEC2/samples/auth_credentials-OS-KSEC2.xml" parse="text"/></programlisting>
</example>
<example>
<title>JSON Auth Request using
EC2CREDENTIALS</title>
<programlisting language="json"><xi:include href="&EC2CREDENTIALSREQUESTJSON;" parse="text"/></programlisting>
</example>
<example>
<title>XML Auth Response</title>
<programlisting language="xml"><xi:include href="../samples/auth.xml" parse="text"/></programlisting>
</example>
<example>
<title>JSON Auth Response</title>
<programlisting language="json"><xi:include href="../samples/auth.json" parse="text"/></programlisting>
</example>
</section>
</section>
</section>
</chapter>
</book>

186
openstack-identity-api/v2.0/src/docbkx/common/ch_os_extensions.xml
View File

@ -1,19 +1,177 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter xmlns="http://docbook.org/ns/docbook"
xml:id="openstack_identity_extensions" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude"
role="api-reference">
xmlns:xi="http://www.w3.org/2001/XInclude" role="api-reference">
<title>OpenStack Identity Extensions</title>
<xi:include href="../OS-KSADM/OS-KSADM-admin-devguide.xml"
xpointer="element(Admin_API_Service_Developer_Operations-d1e1357)"/>
<xi:include href="../OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml"
xpointer="element(Admin_API_Service_Developer_Operations-OS-KSCATALOG)"/>
<xi:include href="../OS-KSEC2/OS-KSEC2-admin-devguide.xml"
xpointer="element(Admin_API_Service_Developer_Operations-OS-KSEC2)"/>
<xi:include href="../OS-KSS3/OS-KSS3-admin-devguide.xml"
xpointer="element(KSS3_OPERATIONS-token)"/>
<xi:include href="../OS-KSVALIDATE/OS-KSVALIDATE-admin-devguide.xml"
xpointer="element(KSVALIDATE_OPERATIONS-token)"/>
<section xml:id="os-ksadm-admin-ext">
<title>OS-KSADM admin extension</title>
<section xml:id="ksadm-users">
<title>Users</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#users-v2.0">
<wadl:method href="#listUsers"/>
<wadl:method href="#addUser"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#userById-v2.0">
<wadl:method href="#updateUser"/>
<wadl:method href="#deleteUser"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="ksadm-roles">
<title>Roles</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#userRoles-v2.0">
<wadl:method href="#listUserRoles"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#userRoleById-v2.0">
<wadl:method href="#addUserRole"/>
<wadl:method href="#deleteUserRole"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#roles-v2.0">
<wadl:method href="#getRoleByName"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#roles_list-v2.0">
<wadl:method href="#listRoles"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#roles-v2.0">
<wadl:method href="#addRole"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#roleId-v2.0">
<wadl:method href="#getRole"/>
<wadl:method href="#deleteRole"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="ksadm-tenants">
<title>Tenants</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#tenants-v2.0">
<wadl:method href="#addTenant"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#tenantById-v2.0">
<wadl:method href="#updateTenant"/>
<wadl:method href="#deleteTenant"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#usersForTenant-v2.0">
<wadl:method href="#listUsersForTenant"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#userSpecificRoleForTenant-v2.0">
<wadl:method href="#addRolesToUserOnTenant"/>
<wadl:method href="#deleteRoleFromUserOnTenant"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="ksadm-services">
<title>Services</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#services-v2.0">
<wadl:method href="#listServices"/>
<wadl:method href="#addService"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#serviceName-v2.0">
<wadl:method href="#getServiceByName"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl#serviceId-v2.0">
<wadl:method href="#getService"/>
<wadl:method href="#deleteService"/>
</wadl:resource>
</wadl:resources>
</section>
</section>
<section
xml:id="Admin_API_Service_Developer_Operations-OS-KSCATALOG">
<title>OS-KSCATALOG admin extension</title>
<section xml:id="Endpoint_Template_Operations_OS-KSCATALOG">
<title>Endpoint templates</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl#endpointTemplates">
<wadl:method href="listEndpointTemplates"/>
<wadl:method href="addEndpointTemplate"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl#endpointTemplateId">
<wadl:method href="getEndpointTemplate"/>
<wadl:method href="deleteEndpointTemplate"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="Tenant_Operations_OS-KSCATALOG">
<title>Endpoints</title>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl#endpoints">
<wadl:method href="listEndpoints"/>
<wadl:method href="addEndpoint"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl#endpoint">
<wadl:method href="getEndpoint"/>
<wadl:method href="deleteEndpoint"/>
</wadl:resource>
</wadl:resources>
</section>
</section>
<section xml:id="Admin_API_Service_Developer_Operations-OS-KSEC2">
<title>OS-KSEC2 admin extension</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl#userCredentials"/>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl#userCredentialsByType"
/>
</wadl:resources>
</section>
<section xml:id="RackExt-0001">
<title>OS-KSS3 admin extension</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl#userCredentials">
<wadl:method href="listCredentials"/>
<wadl:method href="addUserCredential"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl#userCredentialsByType">
<wadl:method href="getUserCredential"/>
<wadl:method href="updateUserCredential"/>
<wadl:method href="deleteUserCredential"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="KSVALIDATE_OPERATIONS-token" version="5.0">
<title>OS-KSVALIDATE admin extension</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl#validate">
<wadl:method href="validateToken"/>
<wadl:method href="checkToken"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl#endpointsForToken">
<wadl:method href="listEndpointsForToken"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>