diff --git a/openstack-identity-api/.gitignore b/openstack-identity-api/.gitignore index 47cd855d..8c3987ee 100644 --- a/openstack-identity-api/.gitignore +++ b/openstack-identity-api/.gitignore @@ -1,4 +1,4 @@ -*.DS_Store +.DS_Store .DS_Store? target/ *.bak diff --git a/openstack-identity-api/pom.xml b/openstack-identity-api/pom.xml index 4724a530..88eb6574 100644 --- a/openstack-identity-api/pom.xml +++ b/openstack-identity-api/pom.xml @@ -1,395 +1,117 @@ - - - 4.0.0 - org.openstack.identity - docs - 1.0.0 - jar - OpenStack Specifications - - - - com.rackspace.cloud.api - clouddocs-maven-plugin - 1.8.0 - - - identity-dev-guide - - generate-webhelp - - generate-sources - - os-identitydevguide - 1 - UA-17511903-6 - src/docbkx/common - identity-dev-guide.xml - 1 - target/docbkx/webhelp/api/openstack-identity-service - 2.0 - identity-dev-guide-2.0 - - - - - - - - - - - - - - OS-KSS3 - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/OS-KSS3/OS-KSS3-admin-devguide.xml - 1 - OS-KSS3-admin-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/OS-KSS3/content - 0 - - - - - - - - - - - - OS-KSADM - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/OS-KSADM/OS-KSADM-admin-devguide.xml - 1 - OS-KSADM-admin-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/OS-KSADM/content - 0 - - - - - - - - - - - - OS-KSVALIDATE - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/OS-KSVALIDATE/OS-KSVALIDATE-admin-devguide.xml - 1 - OS-KSVALIDATE-admin-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/OS-KSVALIDATE/content - 0 - - - - - - - - - - - - OS-KSCATALOG - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml - 1 - OS-KSCATALOG-admin-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/OS-KSCATALOG/content - 0 - - - - - - - - - - - - RAX-KSGRP - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/RAX-KSGRP/RAX-KSGRP-service-devguide.xml - 1 - RAX-KSGRP-service-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/RAX-KSGRP/content - 0 - - - - - - - - - - - - HP-IDM - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/HP-IDM/HP-IDM.xml - 1 - hp-idm.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/hp-idm/content - 0 - - - - - - - - - - - - RAX-KSKEY - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-service-devguide.xml - 1 - RAX-KSKEY-service-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/RAX-KSKEY-service-devguide/content - 0 - - - - - - - - - - - - RAX-KSKEY-admin - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-admin-devguide.xml - 1 - RAX-KSKEY-admin-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/RAX-KSKEY-admin-devguide/content - 0 - - - - - - - - - - - RAX-KSQA-admin - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/RAX-KSQA/RAX-KSQA-admin-devguide.xml - 1 - RAX-KSQA-admin-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/RAX-KSQA-admin/content - 0 - - - - - - - - - - - - RAX-GRPADM - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/RAX-GRPADM/RAX-GRPADM-devguide.xml - 1 - RAX-GRPADM-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/RAX-GRPADM/content - 0 - - - - - - - - - - - - OS-KSEC2-admin - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/OS-KSEC2/OS-KSEC2-admin-devguide.xml - 1 - OS-KSEC2-admin-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/OS-KSEC2-admin-devguide/content - 0 - - - - - - - - - - - - OS-KSEC2-service - - generate-pdf - generate-webhelp - - generate-sources - - src/docbkx/extensions/OS-KSEC2/OS-KSEC2-service-devguide.xml - 1 - OS-KSEC2-service-devguide.pdf - http://docs.rackspacecloud.com/openstack-extensions/auth/OS-KSEC2-service-devguide/content - 0 - - - - - - - - - - - - - true - src/docbkx/common/ - identity-dev-guide.xml - reviewer - openstack - - - - - - - Rackspace Research Repositories - - true - - - - rackspace-research - Rackspace Research Repository - http://maven.research.rackspacecloud.com/content/groups/public/ - - - - - rackspace-research - Rackspace Research Repository - http://maven.research.rackspacecloud.com/content/groups/public/ - - - - - - UTF-8 - - + + + 4.0.0 + org.openstack.identity + docs + 1.0.0 + jar + OpenStack API Reference + + + + com.rackspace.cloud.api + clouddocs-maven-plugin + 1.8.0 + + + generate-pdf + + generate-pdf + + generate-sources + + src/docbkx/common + identity-dev-guide.xml + false + + + + identity-dev-guide + + generate-webhelp + + generate-sources + + os-identitydevguide + 1 + UA-17511903-6 + src/docbkx/common + identity-dev-guide.xml + 1 + target/docbkx/webhelp/api/openstack-identity-service + 2.0 + + appendix toc,title + article/appendix nop + article toc,title + book toc,title,figure,table,example,equation + chapter toc + section toc + part toc,title + preface toc + qandadiv toc + qandaset toc + reference toc,title + set toc,title + + identity-dev-guide-2.0 + + + + + + + + + + + + + + + + + + + + + + true + src/docbkx/common/ + identity-dev-guide.xml + reviewer + openstack + + + + + + + Rackspace Research Repositories + + true + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + + UTF-8 + + \ No newline at end of file diff --git a/openstack-identity-api/src/docbkx/extensions/HP-IDM/HP-IDM.xml b/openstack-identity-api/src/docbkx/HP-IDM/HP-IDM.xml similarity index 91% rename from openstack-identity-api/src/docbkx/extensions/HP-IDM/HP-IDM.xml rename to openstack-identity-api/src/docbkx/HP-IDM/HP-IDM.xml index d77e3d23..9d2c7d4a 100644 --- a/openstack-identity-api/src/docbkx/extensions/HP-IDM/HP-IDM.xml +++ b/openstack-identity-api/src/docbkx/HP-IDM/HP-IDM.xml @@ -67,7 +67,7 @@ Validate token with the optional HP-IDM-serviceId parameter so that only the roles associated with the given service IDs are returned. See - https://bugs.launchpad.net/keystone/+bug/890411 for more + https://bugs.launchpad.net/keystone/+bug/890411 for more details. - - HP-IDM Admin Extension to Keystone V2.0 API adds capability to filter roles +
HP-IDM Admin Extension to Identity Service API v2.0 + HP-IDM Admin Extension to Identity Service API v2.0 adds capability to filter roles with optional service IDs for token validation to mitigate security risks with role name conflicts. See @@ -126,10 +126,10 @@ --> Sample Valid Token Request - + - Sample Valid Token Request With Global Service ID Specified + Sample Valid Token Request with Global Service ID Specified
@@ -169,7 +169,7 @@ (see pom.xml). --> - +
@@ -186,6 +186,6 @@ Describe any new states. --> None. - + diff --git a/openstack-identity-api/src/docbkx/extensions/HP-IDM/samples/sample_request.txt b/openstack-identity-api/src/docbkx/HP-IDM/samples/sample_request.txt similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/HP-IDM/samples/sample_request.txt rename to openstack-identity-api/src/docbkx/HP-IDM/samples/sample_request.txt diff --git a/openstack-identity-api/src/docbkx/extensions/HP-IDM/samples/sample_request_with_global_sid.txt b/openstack-identity-api/src/docbkx/HP-IDM/samples/sample_request_with_global_sid.txt similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/HP-IDM/samples/sample_request_with_global_sid.txt rename to openstack-identity-api/src/docbkx/HP-IDM/samples/sample_request_with_global_sid.txt diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/OS-KSADM-admin-devguide.xml b/openstack-identity-api/src/docbkx/OS-KSADM/OS-KSADM-admin-devguide.xml similarity index 84% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/OS-KSADM-admin-devguide.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/OS-KSADM-admin-devguide.xml index 0b6ce337..4a1bb568 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/OS-KSADM-admin-devguide.xml +++ b/openstack-identity-api/src/docbkx/OS-KSADM/OS-KSADM-admin-devguide.xml @@ -42,7 +42,7 @@ format="SVG" scale="60"/> + xml:id="Identity-Service-Developer-Guide-OS-KSADM"> OpenStack Identity OS-KSADM (Admin Operations) OS-KSADM (Admin) @@ -78,12 +78,12 @@ format="SVG" scale="60"/> - Openstack extensions to Keystone v2.0 - API enabling Admin Operations. + Openstack extensions to Identity Service API v2.0 + enabling Admin Operations. @@ -92,7 +92,7 @@ format="SVG" scale="60"/> - This document includes details on various operations supported by the OS-KSADM extensions on top of core keystone operations. + This document includes details on various operations supported by the OS-KSADM extensions on top of core OpenStack Identity Service operations. @@ -140,29 +140,29 @@ format="SVG" scale="60"/>
User Operations - + - + - + - + - + - + - + @@ -173,17 +173,17 @@ format="SVG" scale="60"/>
Tenant Operations - + - + - + - + @@ -193,11 +193,11 @@ format="SVG" scale="60"/>
Role Operations - + - + @@ -207,11 +207,11 @@ format="SVG" scale="60"/>
Service Operations - + - + diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/credentials.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/credentials.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/credentials.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/credentials.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/credentials.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/credentials.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/credentials.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/credentials.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/passwordcredentials.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/passwordcredentials.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/passwordcredentials.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/passwordcredentials.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/passwordcredentials.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/passwordcredentials.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/passwordcredentials.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/passwordcredentials.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/role.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/role.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/role.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/role.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/role.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/role.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/role.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/role.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/roles.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/roles.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/roles.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/roles.json diff --git a/openstack-identity-api/src/docbkx/common/samples/roles.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/roles.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/roles.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/roles.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/service.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/service.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/service.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/service.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/service.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/service.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/service.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/service.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/services.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/services.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/services.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/services.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/services.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/services.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/services.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/services.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/tenant.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/tenant.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/tenant.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/tenant.json diff --git a/openstack-identity-api/src/docbkx/common/samples/tenant.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/tenant.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/tenant.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/tenant.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/tenantwithoutid.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/tenantwithoutid.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/tenantwithoutid.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/tenantwithoutid.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/tenantwithoutid.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/tenantwithoutid.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/tenantwithoutid.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/tenantwithoutid.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/user.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/user.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/user.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/user.json diff --git a/openstack-identity-api/src/docbkx/common/samples/user.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/user.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/user.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/user.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/users.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/users.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/users.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/users.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/users.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/users.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/users.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/users.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/userwithenabledonly.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/userwithenabledonly.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/userwithenabledonly.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/userwithenabledonly.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/userwithenabledonly.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/userwithenabledonly.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/userwithenabledonly.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/userwithenabledonly.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/userwithoutid.json b/openstack-identity-api/src/docbkx/OS-KSADM/samples/userwithoutid.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/userwithoutid.json rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/userwithoutid.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/userwithoutid.xml b/openstack-identity-api/src/docbkx/OS-KSADM/samples/userwithoutid.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/samples/userwithoutid.xml rename to openstack-identity-api/src/docbkx/OS-KSADM/samples/userwithoutid.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml b/openstack-identity-api/src/docbkx/OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml similarity index 87% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml index acb0b0ca..89f60c71 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml +++ b/openstack-identity-api/src/docbkx/OS-KSCATALOG/OS-KSCATALOG-admin-devguide.xml @@ -42,7 +42,7 @@ format="SVG" scale="60"/> + xml:id="Identity-Service-Developer-Guide-OS-KSCATALOG"> OpenStack Identity OS-KSCATALOG Extension OS-KSCATALOG (Admin) @@ -80,14 +80,14 @@ format="SVG" scale="60"/> 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"> - Openstack extensions to Keystone v2.0 API enabling Admin Operations to support Catalog. Adds the capability to do CRUD on Endpoint Templates and Endpoints + Openstack extensions to Identity Service API v2.0 enabling Admin Operations to support Catalog. Adds the capability to do CRUD on Endpoint Templates and Endpoints - This document includes details on various operations supported by the OS-KSCATALOG extensions on top of core keystone operations. + This document includes details on various operations supported by the OS-KSCATALOG extensions on top of core OpenStack Identity Service operations. @@ -110,7 +110,7 @@ format="SVG" scale="60"/>
+ xml:id="Admin_API_Service_Developer_Operations-OS-KSCATALOG" version="5.0" role="api-reference"> OS-KSCATALOG Admin Extension Extension operations. @@ -134,15 +134,15 @@ format="SVG" scale="60"/> - The following calls are supported by API OS-KSCATALOG Extension on top of Keystone Admin 2.0: + The following calls are supported by API OS-KSCATALOG Extension on top of OpenStack Identity Service Admin API v2.0:
Endpoint Template Operations - + - + @@ -152,11 +152,11 @@ format="SVG" scale="60"/>
Endpoint Operations - + - + diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpoint.json b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpoint.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpoint.json rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpoint.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpoint.xml b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpoint.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpoint.xml rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpoint.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplate.json b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplate.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplate.json rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplate.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplate.xml b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplate.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplate.xml rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplate.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplateWithOnlyId.json b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplateWithOnlyId.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplateWithOnlyId.json rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplateWithOnlyId.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplateWithOnlyId.xml b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplateWithOnlyId.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplateWithOnlyId.xml rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplateWithOnlyId.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplates.json b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplates.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplates.json rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplates.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplates.xml b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplates.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpointTemplates.xml rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpointTemplates.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpoints.json b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpoints.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpoints.json rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpoints.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpoints.xml b/openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpoints.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/samples/endpoints.xml rename to openstack-identity-api/src/docbkx/OS-KSCATALOG/samples/endpoints.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-admin-devguide.xml b/openstack-identity-api/src/docbkx/OS-KSEC2/OS-KSEC2-admin-devguide.xml similarity index 83% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-admin-devguide.xml rename to openstack-identity-api/src/docbkx/OS-KSEC2/OS-KSEC2-admin-devguide.xml index 994093b9..c730cac2 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-admin-devguide.xml +++ b/openstack-identity-api/src/docbkx/OS-KSEC2/OS-KSEC2-admin-devguide.xml @@ -4,23 +4,19 @@ - GET'> PUT'> POST'> DELETE'> - '> - - @@ -37,11 +33,10 @@ format="SVG" scale="60"/> - - - - - + + + + ]> This document is intended for client developers interested in using the OpenStack EC2 Authentication Service Extension along with the - Keystone - OpenStack Identity - (API). + OpenStack Identity Service + API v2.0. namespace="http://docs.openstack.org/identity/api/ext/OS-KSEC2/v1.0" alias="OS-KSEC2" updated="2011-08-25T09:50:00-00:00"> - Adds the capability to support EC2 style authentication. - @@ -151,13 +144,13 @@ format="SVG" scale="60"/> ec2Credentials JSON - +
+ xml:id="Admin_API_Service_Developer_Operations-OS-KSEC2" version="5.0" role="api-reference"> OS-KSEC2-admin Extension API Operations @@ -180,16 +173,8 @@ format="SVG" scale="60"/>
User Operations - - - - - - - - - - + +
diff --git a/openstack-identity-api/src/docbkx/OS-KSEC2/OS-KSEC2-service-devguide.xml b/openstack-identity-api/src/docbkx/OS-KSEC2/OS-KSEC2-service-devguide.xml new file mode 100644 index 00000000..fd081582 --- /dev/null +++ b/openstack-identity-api/src/docbkx/OS-KSEC2/OS-KSEC2-service-devguide.xml @@ -0,0 +1,201 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + '> + + + + + + + + + + + + + + + '> + + + + +]> + + + OpenStack Identity EC2 authentication Extension (Service + Operations) + OS-KSEC2 (Admin) + + + + + + + + OpenStack + + + + 2010 + 2011 + OpenStack + + EXT v1.0 + OpenStack Identity + &PUB_DATE; + + + Copyright details are filled in by the + template. + + + + This document is intended for client developers + interested in using the OpenStack EC2 Authentication + Service Extension along with the Keystone - OpenStack + Identity (API). + + + + Adds the capability to support EC2 style + authentication. + + + + + + + 2011-08-26 + + + + Initial release. + + + + + + + + Summary of Changes + The OpenStack EC2 authentication Service Extension + allows authenticate call using ec2Credentials. +
+ New Headers + None. +
+
+ New Faults + None. +
+
+ New Resources + None. +
+
+ New Actions + None. +
+
+ New Element +
+ Openstack extension to Identity Service v2.0 + API enabling EC2 style authentication. +
+ Authenticate + This extension allows authentication calls + to accept new type of credentials + ec2Credentials. + These are additional type of credentials + defined to support EC2 style authentication. + The usage of + ec2Credentials on a + existing call to authenticate is illustrated + below + &URI_REFHEAD;
+ + + + + + + + &CODES;200, + 203 + &ERROR_CODES; unauthorized + (401), userDisabled + (403), badRequest + (400), + identityFault (500), + serviceUnavailable(503) + This call will return a token if + successful. Clients obtain this token, along + with the URL to other service APIs, by first + authenticating against the Identity Service + and supplying valid credentials. This + extension provides support for Rackspace style + API key credentials. + 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. + 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. + + XML Auth Request using + EC2CREDENTIALS + + + + JSON Auth Request using + EC2CREDENTIALS + + + + XML Auth Response + + + + JSON Auth Response + + + + + + + diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/auth_credentials-OS-KSEC2.json b/openstack-identity-api/src/docbkx/OS-KSEC2/samples/auth_credentials-OS-KSEC2.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/auth_credentials-OS-KSEC2.json rename to openstack-identity-api/src/docbkx/OS-KSEC2/samples/auth_credentials-OS-KSEC2.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/auth_credentials-OS-KSEC2.xml b/openstack-identity-api/src/docbkx/OS-KSEC2/samples/auth_credentials-OS-KSEC2.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/auth_credentials-OS-KSEC2.xml rename to openstack-identity-api/src/docbkx/OS-KSEC2/samples/auth_credentials-OS-KSEC2.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/credentialswithec2.json b/openstack-identity-api/src/docbkx/OS-KSEC2/samples/credentialswithec2.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/credentialswithec2.json rename to openstack-identity-api/src/docbkx/OS-KSEC2/samples/credentialswithec2.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/credentialswithec2.xml b/openstack-identity-api/src/docbkx/OS-KSEC2/samples/credentialswithec2.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/credentialswithec2.xml rename to openstack-identity-api/src/docbkx/OS-KSEC2/samples/credentialswithec2.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/ec2Credentials.json b/openstack-identity-api/src/docbkx/OS-KSEC2/samples/ec2Credentials.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/ec2Credentials.json rename to openstack-identity-api/src/docbkx/OS-KSEC2/samples/ec2Credentials.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/ec2Credentials.xml b/openstack-identity-api/src/docbkx/OS-KSEC2/samples/ec2Credentials.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/samples/ec2Credentials.xml rename to openstack-identity-api/src/docbkx/OS-KSEC2/samples/ec2Credentials.xml diff --git a/openstack-identity-api/src/docbkx/OS-KSS3/OS-KSS3-admin-devguide.xml b/openstack-identity-api/src/docbkx/OS-KSS3/OS-KSS3-admin-devguide.xml new file mode 100644 index 00000000..7185584a --- /dev/null +++ b/openstack-identity-api/src/docbkx/OS-KSS3/OS-KSS3-admin-devguide.xml @@ -0,0 +1,212 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + '> + + + + + + + + + + + + + + + '> + + + + + + +]> + + + OpenStack Identity OS-KSS3 Extension (Admin + Operations) + OS-KSS3 (Admin) + + + + + + + + Rackspace Cloud + + + + 2011 + Rackspace US, Inc. + + EXT v1.0 + OpenStack Identity + &PUB_DATE; + + + Copyright details are filled in by the + template. + + + + + Joe + Savak + + joe.savak@RACKSPACE.COM + + + Identity Service v2.0 API extension. + + + + + This document is intended for client developers + interested in using the OS-KSS3 Extension (Admin) + along with the OpenStack Identity Service + (API). + + + + 2011-09-13 + + + + Initial release. + + + + + + + + Summary of Changes + The OS-KSS3 Extension allows crud/listing operations on + s3Credentials. +
+ New Headers + None. +
+
+ New Faults + None. +
+
+ New Resources + None. +
+
+ New Actions + None. +
+
+ New Element +
+ s3Credentials + This extension allows authentication calls to + accept new type of credentials + s3Credentials. These + are additional type of credentials defined to + support Amazon's S3 style Authentication. Examples + of s3Credentials are + illustrated below. + + s3Credentials XML + + + + s3Credentials JSON + + +
+
+
+ OS-KSS3 extension to Identity Service v2.0 + API +
+ New Elements + This extension allows token validation and + endpoint retrieval without sending tokens in the + URI. +
+
+ OS-KSS3 Extension API Operations + +
Authentication Header
VerbURIDescription
&POST; /tokensAuthenticate to + generate a token.
VerbURIDescription
+ + + + + + + + + + + + + + + +
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
+ Following operations are the list of operations + available in the OS-KSS3 Admin Extension: +
+ API operations + + + + + + + + + + + +
+
+
+ +
diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/samples/credentialswiths3.json b/openstack-identity-api/src/docbkx/OS-KSS3/samples/credentialswiths3.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSS3/samples/credentialswiths3.json rename to openstack-identity-api/src/docbkx/OS-KSS3/samples/credentialswiths3.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/samples/credentialswiths3.xml b/openstack-identity-api/src/docbkx/OS-KSS3/samples/credentialswiths3.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSS3/samples/credentialswiths3.xml rename to openstack-identity-api/src/docbkx/OS-KSS3/samples/credentialswiths3.xml diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/samples/s3Credentials.json b/openstack-identity-api/src/docbkx/OS-KSS3/samples/s3Credentials.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSS3/samples/s3Credentials.json rename to openstack-identity-api/src/docbkx/OS-KSS3/samples/s3Credentials.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/samples/s3Credentials.xml b/openstack-identity-api/src/docbkx/OS-KSS3/samples/s3Credentials.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSS3/samples/s3Credentials.xml rename to openstack-identity-api/src/docbkx/OS-KSS3/samples/s3Credentials.xml diff --git a/openstack-identity-api/src/docbkx/OS-KSVALIDATE/OS-KSVALIDATE-admin-devguide.xml b/openstack-identity-api/src/docbkx/OS-KSVALIDATE/OS-KSVALIDATE-admin-devguide.xml new file mode 100644 index 00000000..a45822ae --- /dev/null +++ b/openstack-identity-api/src/docbkx/OS-KSVALIDATE/OS-KSVALIDATE-admin-devguide.xml @@ -0,0 +1,195 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + '> + + + + + + + + + + + Verb + URI + Description + + '> + + + +]> + + + OpenStack Identity OS-KSVALIDATE Extension (Service + Operations) + OS-KSVALIDATE (Service) + + + + + + + + Rackspace Cloud + + + + 2010 + 2011 + OpenStack + + API v2.0 + OpenStack Identity + 2011-08-29 + + + Copyright details are filled in by the + template. + + + + + Joe + Savak + + joe.savak@RACKSPACE.COM + + + Identity Service v2.0 API extension. + + + + + This document is intended for client developers + interested in using the OS-KSVALIDATE Extension + (Service) along with the OpenStack Identity Service + (API). + + + + 2011-09-13 + + + + Initial release. + + + + + + + + Summary of Changes + OS-KSVALIDATE extension allows a Token to be optionally + encrypted and passed in the 'X-Subject-Token' header for + validation, rather than in the URI. +
+ New Headers + None. +
+
+ New Faults + None. +
+
+ New Resources + None. +
+
+ New Actions + None. +
+
+ New Elements +
+ OS-KSVALIDATE extension to Identity Service + v2.0 API +
+ New Elements + This extension allows token validation and + endpoint retrieval without sending tokens in + the URI. +
+
+ OS-KSVALIDATE Extension API + Operations + + + + + + + + + + + + + + + + + +
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
+ + Following operations are the list of + operations available in the OS-KSVALIDATE + Service Extension: +
+ API operations + + + + + + + + + +
+
+
+
+
+
diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/samples/endpoints.json b/openstack-identity-api/src/docbkx/OS-KSVALIDATE/samples/endpoints.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/samples/endpoints.json rename to openstack-identity-api/src/docbkx/OS-KSVALIDATE/samples/endpoints.json diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/samples/endpoints.xml b/openstack-identity-api/src/docbkx/OS-KSVALIDATE/samples/endpoints.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/samples/endpoints.xml rename to openstack-identity-api/src/docbkx/OS-KSVALIDATE/samples/endpoints.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/validatetoken.json b/openstack-identity-api/src/docbkx/OS-KSVALIDATE/samples/validatetoken.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/validatetoken.json rename to openstack-identity-api/src/docbkx/OS-KSVALIDATE/samples/validatetoken.json diff --git a/openstack-identity-api/src/docbkx/common/samples/validatetoken.xml b/openstack-identity-api/src/docbkx/OS-KSVALIDATE/samples/validatetoken.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/validatetoken.xml rename to openstack-identity-api/src/docbkx/OS-KSVALIDATE/samples/validatetoken.xml diff --git a/openstack-identity-api/src/docbkx/RAX-GRPADM/RAX-GRPADM-devguide.xml b/openstack-identity-api/src/docbkx/RAX-GRPADM/RAX-GRPADM-devguide.xml new file mode 100644 index 00000000..f6826bc9 --- /dev/null +++ b/openstack-identity-api/src/docbkx/RAX-GRPADM/RAX-GRPADM-devguide.xml @@ -0,0 +1,219 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + '> + + + + + + + + + Verb + URI + Description + + '> + + + + + + + + + + + + + + + + + + +]> + + + OpenStack Identity Rackspace Group Admin Extension + &ALIAS; + + + + + + + + Rackspace Cloud + + + + 2011 + Rackspace US, Inc. + + OpenStack Identity + &PUB_DATE; + + + Copyright details are filled in by the + template. + + + + + Joe + Savak + + joe.savak@RACKSPACE.COM + + + Rackspace extensions to Identity Service + v2.0 API enabling Group Admin. + + + + + This document is for software developers + who want to use the Group Admin Extension to the + OpenStack Identity Application Programming Interface + (API). + + + + 2012-01-23 + + + + Initial release. + + + + + + + + + Summary of Changes + This extension adds capabilities to the RAX-KSGRP + extension. It allows for CRUD operations on + groups and gives the ability to + associate groups with + users. +
+ New Headers + None. +
+
+ New Faults + None. +
+
+ New Resources + None. +
+
+ New Actions + None. +
+
+ New Element +
+ groups + This extension adds capabilities to the + RAX-KSGRP extension. It allows for CRUD operations + on groups and gives the + ability to associate groups + with users. + + group XML + + + + groups JSON + + +
+
+ +
+ RAX-GRPADM Extension API Operations + + + + + + + + + + + + + + + + +
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
+ A new resource is created at /RAX-GRPADM/groups that + allows for the management of groups. +
+ User Operations + + + + + + + + + + + + + + + +
+
+
+
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-for-create.json b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-for-create.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-for-create.json rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-for-create.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-for-create.xml b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-for-create.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-for-create.xml rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-for-create.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-for-update.json b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-for-update.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-for-update.json rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-for-update.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-for-update.xml b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-for-update.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-for-update.xml rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-for-update.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-updated.json b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-updated.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-updated.json rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-updated.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-updated.xml b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-updated.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group-updated.xml rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group-updated.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group.json b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group.json rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group.xml b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/group.xml rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/group.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/groups.json b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/groups.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/groups.json rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/groups.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/groups.xml b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/groups.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/groups.xml rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/groups.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/users.json b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/users.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/users.json rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/users.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/users.xml b/openstack-identity-api/src/docbkx/RAX-GRPADM/samples/users.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/samples/users.xml rename to openstack-identity-api/src/docbkx/RAX-GRPADM/samples/users.xml diff --git a/openstack-identity-api/src/docbkx/RAX-KSGRP/RAX-KSGRP-service-devguide.xml b/openstack-identity-api/src/docbkx/RAX-KSGRP/RAX-KSGRP-service-devguide.xml new file mode 100644 index 00000000..c4ca8029 --- /dev/null +++ b/openstack-identity-api/src/docbkx/RAX-KSGRP/RAX-KSGRP-service-devguide.xml @@ -0,0 +1,208 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + '> + + + + + + + + + + + Verb + URI + Description + + '> + + + + + + + + + + + + + +]> + + + OpenStack Identity Rackspace Group Extension (Service + Operations) + RAX-KSGRP (Service) + + + + + + + + Rackspace Cloud + + + + 2011 + Rackspace US, Inc. + + EXT v1.0 + OpenStack Identity + &PUB_DATE; + + + Copyright details are filled in by the + template. + + + + + Joe + Savak + + joe.savak@RACKSPACE.COM + + + Rackspace extensions to Identity Service v2.0 + API enabling groups. + + + + + This document is intended for client developers + interested in using the Rackspace Identity Service + Group Extension (Service) along with the OpenStack + Identity Service (API). + + + + 2011-09-13 + + + + Initial release. + + + + + + + + Summary of Changes + Rackspace extensions to Identity Service v2.0 API + allows authenticate call to also return information about + group memberships of the user. +
+ New Headers + None. +
+
+ New Faults + None. +
+
+ New Resources + None. +
+
+ New Actions + None. +
+
+ New Elements +
+ Rackspace extensions to Identity Service v2.0 + API enabling groups. +
+ New Elements + This extension starts returning groups as a + part of response when an authenticate call is + made. The samples of new elements that are + defined as a part of this extension are listed + below. + + Groups Sample XML + + + + Groups Sample JSON + + +
+
+ RAX-KSGRP Extension API Operations + + + + + + + + + + + + + + + + + +
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
+ + Following operations are the list of + operations whose behavior is altered by + Rackspace API Groups Service Extension: +
+ User Operations + + + + + +
+
+
+
+
+
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/samples/RAX-KSGRP-group.json b/openstack-identity-api/src/docbkx/RAX-KSGRP/samples/RAX-KSGRP-group.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/samples/RAX-KSGRP-group.json rename to openstack-identity-api/src/docbkx/RAX-KSGRP/samples/RAX-KSGRP-group.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/samples/RAX-KSGRP-group.xml b/openstack-identity-api/src/docbkx/RAX-KSGRP/samples/RAX-KSGRP-group.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/samples/RAX-KSGRP-group.xml rename to openstack-identity-api/src/docbkx/RAX-KSGRP/samples/RAX-KSGRP-group.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/samples/RAX-KSGRP-groups.json b/openstack-identity-api/src/docbkx/RAX-KSGRP/samples/RAX-KSGRP-groups.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/samples/RAX-KSGRP-groups.json rename to openstack-identity-api/src/docbkx/RAX-KSGRP/samples/RAX-KSGRP-groups.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/samples/RAX-KSGRP-groups.xml b/openstack-identity-api/src/docbkx/RAX-KSGRP/samples/RAX-KSGRP-groups.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/samples/RAX-KSGRP-groups.xml rename to openstack-identity-api/src/docbkx/RAX-KSGRP/samples/RAX-KSGRP-groups.xml diff --git a/openstack-identity-api/src/docbkx/RAX-KSKEY/RAX-KSKEY-admin-devguide.xml b/openstack-identity-api/src/docbkx/RAX-KSKEY/RAX-KSKEY-admin-devguide.xml new file mode 100644 index 00000000..9319e43d --- /dev/null +++ b/openstack-identity-api/src/docbkx/RAX-KSKEY/RAX-KSKEY-admin-devguide.xml @@ -0,0 +1,203 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + '> + + + + + + + + + Verb + URI + Description + + '> + + +]> + + + OpenStack Identity Rackspace API Key Authentication + Extension (Admin Operations) + RAX-KSKEY (Admin) + + + + + + + + Rackspace Cloud + + + + 2011 + Rackspace US, Inc. + + OpenStack Identity + &PUB_DATE; + + + Copyright details are filled in by the + template. + + + + + Joe + Savak + + joe.savak@RACKSPACE.COM + + + Rackspace extensions to Identity Service + v2.0 API enabling API Key authentication. + + + + + This document is intended for service developers + interested in using the Rackspace API Key + Authentication Admin Extension along with the + OpenStack Identity Service (API). + + + + + 2011-09-13 + + + + Initial release. + + + + + + + + + Summary of Changes + The Rackspace API Key Authentication Admin Extension + allows crud/listing operations on + apikeyCredentials. +
+ New Headers + None. +
+
+ New Faults + None. +
+
+ New Resources + None. +
+
+ New Actions + None. +
+
+ New Element +
+ apikeyCredentials + This extension allows authentication calls to + accept new type of credentials + apikeyCredentials. + These are additional type of credentials defined + to support rackspace style authentication. + Examples of + apikeyCredentials are + illustrated below + + apikeyCredentials XML + + + + apikeyCredentials JSON + + +
+
+ +
+ RAX-KSKEY-admin Extension API Operations + + + + + + + + + + + + + + + + + +
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
+ + Following operations are the list of operations + whose behavior is altered by Rackspace API Key + Authentication Extension: +
+ User Operations + + + + + + + + + + + +
+
+
+
diff --git a/openstack-identity-api/src/docbkx/RAX-KSKEY/RAX-KSKEY-service-devguide.xml b/openstack-identity-api/src/docbkx/RAX-KSKEY/RAX-KSKEY-service-devguide.xml new file mode 100644 index 00000000..f222f689 --- /dev/null +++ b/openstack-identity-api/src/docbkx/RAX-KSKEY/RAX-KSKEY-service-devguide.xml @@ -0,0 +1,211 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + '> + + + + + + + + + Verb + URI + Description + + '> + + + + + + +]> + + + OpenStack Identity Rackspace API Key Authentication + Extension (Service Operations) + RAX-KSKEY (Service) + + + + + + + + Rackspace Cloud + + + + 2011 + Rackspace US, Inc. + + OpenStack Identity + &PUB_DATE; + + + Copyright details are filled in by the + template. + + + + This document is intended for client developers + interested in using the Rackspace API Key + Authentication Service Extension along with the + OpenStack Identity Service (API). + + + + + Joe + Savak + + joe.savak@RACKSPACE.COM + + + Rackspace extensions to Identity Service v2.0 API + enabling API Key authentication. + + + + + + 2011-08-24 + + + + Initial release. + + + + + + + + Summary of Changes + The Rackspace API Key Authentication Service Extension + allows authenticate call to happen using + apikeyCredentials. +
+ New Headers + None. +
+
+ New Faults + None. +
+
+ New Resources + None. +
+
+ New Actions + None. +
+
+ New Element +
+ Rackspace extensions to Identity Service v2.0 API + enabling API Key authentication. +
+ RAX-KSKEY apikeyCredentials Extension + This extension allows authentication calls + to accept new type of credentials + apikeyCredentials. + These are additional type of credentials + defined to support Rackspace style + authentication. The usage of + apikeyCredentials + on an existing call to authenticate is + illustrated below. + + + + Verb + URI + Description + + + + &POST; + /tokens + Authenticate to + generate a token. + + + + &CODES;200, + 203 + &ERROR_CODES; unauthorized + (401), userDisabled + (403), badRequest + (400), + identityFault (500), + serviceUnavailable(503) + This call will return a token if + successful. Clients obtain this token, along + with the URL to other service APIs, by first + authenticating against the OpenStack Identity Service + and supplying valid credentials. This + extension provides support for Rackspace style + API Key credentials. + 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. + 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. + + XML Auth Request using + apikeyCredentials + + + + JSON Auth Request using + apikeyCredentials + + + + XML Auth Response + + + + JSON Auth Response + + +
+
+
+
+
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/apiKeyCredentials.json b/openstack-identity-api/src/docbkx/RAX-KSKEY/samples/apiKeyCredentials.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/apiKeyCredentials.json rename to openstack-identity-api/src/docbkx/RAX-KSKEY/samples/apiKeyCredentials.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/apiKeyCredentials.xml b/openstack-identity-api/src/docbkx/RAX-KSKEY/samples/apiKeyCredentials.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/apiKeyCredentials.xml rename to openstack-identity-api/src/docbkx/RAX-KSKEY/samples/apiKeyCredentials.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/auth_credentials-RAX-KSKEY.json b/openstack-identity-api/src/docbkx/RAX-KSKEY/samples/auth_credentials-RAX-KSKEY.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/auth_credentials-RAX-KSKEY.json rename to openstack-identity-api/src/docbkx/RAX-KSKEY/samples/auth_credentials-RAX-KSKEY.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/auth_credentials-RAX-KSKEY.xml b/openstack-identity-api/src/docbkx/RAX-KSKEY/samples/auth_credentials-RAX-KSKEY.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/auth_credentials-RAX-KSKEY.xml rename to openstack-identity-api/src/docbkx/RAX-KSKEY/samples/auth_credentials-RAX-KSKEY.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/credentials.json b/openstack-identity-api/src/docbkx/RAX-KSKEY/samples/credentials.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/credentials.json rename to openstack-identity-api/src/docbkx/RAX-KSKEY/samples/credentials.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/credentials.xml b/openstack-identity-api/src/docbkx/RAX-KSKEY/samples/credentials.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/credentials.xml rename to openstack-identity-api/src/docbkx/RAX-KSKEY/samples/credentials.xml diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/credentialswithapikey.json b/openstack-identity-api/src/docbkx/RAX-KSKEY/samples/credentialswithapikey.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/credentialswithapikey.json rename to openstack-identity-api/src/docbkx/RAX-KSKEY/samples/credentialswithapikey.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/credentialswithapikey.xml b/openstack-identity-api/src/docbkx/RAX-KSKEY/samples/credentialswithapikey.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/samples/credentialswithapikey.xml rename to openstack-identity-api/src/docbkx/RAX-KSKEY/samples/credentialswithapikey.xml diff --git a/openstack-identity-api/src/docbkx/RAX-KSQA/RAX-KSQA-admin-devguide.xml b/openstack-identity-api/src/docbkx/RAX-KSQA/RAX-KSQA-admin-devguide.xml new file mode 100644 index 00000000..d75b92d3 --- /dev/null +++ b/openstack-identity-api/src/docbkx/RAX-KSQA/RAX-KSQA-admin-devguide.xml @@ -0,0 +1,185 @@ + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> + + + + + + '> + + + + + + + + + Verb + URI + Description + + '> + + +]> + + + OpenStack Identity Rackspace API Secret Question and Answer + (Admin Operations) + RAX-KSQA (Admin) + + + + + + + + Rackspace Cloud + + + + 2011 + Rackspace US, Inc. + + OpenStack Identity + 2012-01-23 + + + Copyright details are filled in by the + template. + + + + This document is intended for client developers + interested in using the Rackspace API Secret Question + and Answer Extension. + + + + Joe + Savak + + joe.savak@RACKSPACE.COM + + + Allows the management of a User's Secret + Question and Answer. + + + + + 2011-01-23 + + + + Initial release. + + + + + + + + Summary of Changes + The Rackspace API Secret Question and Answer Extension + allows the management of a User's Secret Question and + Answer. +
+ New Headers + None. +
+
+ New Faults + None. +
+
+ New Resources + None. +
+
+ New Actions + None. +
+
+ New Element +
+ secretQA + A secretQA element is + added that allows the management of a user's + secret question and answer. + + secretQA XML + + + + secretQA JSON + + +
+
+ +
+ RAX-KSQA Extension API Operations + + + + + + + + + + + + + + + + + +
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
+ + Following operations are the list of operations + supported by Rackspace Secret Question and Answer + Extension: +
+ User Operations + + + + +
+
+
+
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/samples/RAX-KSQA-secretQA.json b/openstack-identity-api/src/docbkx/RAX-KSQA/samples/RAX-KSQA-secretQA.json similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSQA/samples/RAX-KSQA-secretQA.json rename to openstack-identity-api/src/docbkx/RAX-KSQA/samples/RAX-KSQA-secretQA.json diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/samples/RAX-KSQA-secretQA.xml b/openstack-identity-api/src/docbkx/RAX-KSQA/samples/RAX-KSQA-secretQA.xml similarity index 100% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSQA/samples/RAX-KSQA-secretQA.xml rename to openstack-identity-api/src/docbkx/RAX-KSQA/samples/RAX-KSQA-secretQA.xml diff --git a/openstack-identity-api/src/docbkx/admin/identity-admin.wadl b/openstack-identity-api/src/docbkx/admin/identity-admin.wadl deleted file mode 100644 index c63090d5..00000000 --- a/openstack-identity-api/src/docbkx/admin/identity-admin.wadl +++ /dev/null @@ -1,509 +0,0 @@ - - - - - - - - - - %common; -]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - You need a valid admin token for access. - - - - - - - - - - - - - - You need a valid admin token for access. - - - - - - - - - - - - - - - -

- You need a valid admin token for access. -

-
- - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - - - - -

- A list of supported extensions. -

-
- -
- - - - - - - - - -

- Returns detailed information about this specific version of the API. -

-
- - - - - - - - - &commonFaults; - &getFaults; -
- - - - - -

- Lists supported extensions. -

-
- - - - - - - - - - - - &commonFaults; -
- - -

- Gets details about a specific extension. -

-
- - - - - &commonFaults; - &getFaults; -
- - - - - -

- Authenticate to generate a token. -

-

- This call will return a token if successful. Each ReST request against other services (or other - calls on Keystone such as the GET /tenants call) - requires the inclusion of a specific authorization token HTTP x-header, defined as X-Auth-Token. - Clients obtain - this token, along with the URL to other service APIs, by first authenticating against the - Keystone Service and supplying valid credentials. -

-

- 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. -

-

- The Keystone Service is a ReSTful web service. It is the entry point to all service APIs. - To access the Keystone Service, you must know URL of the Keystone service. -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Check that a token is valid and that it belongs to a supplied tenant - and return the permissions relevant to a particular client. -

-

- Valid tokens will exist in the - /tokens/{tokenId} path and invalid - tokens will not. In other words, a user should expect an - itemNotFound (404) fault for an - invalid token. -

-
- - - -

- Validates a token has the supplied tenant in scope. -

-
- -
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Check that a token is valid and that it belongs to a particular tenant - (For performance). -

-
- - - -

- Validates a token has the supplied tenant in scope. (for performance). -

-

- Valid tokens will exist in the - /tokens/{tokenId} path and invalid - tokens will not. In other words, a user should expect an - itemNotFound (404) fault for an - invalid token. -

-

- If `belongsTo` is provided, validates that a token has a specific tenant in scope. -

-

- No response body is returned for this method. -

-
- -
- - &commonFaults; - &getFaults; -
- - - - -

- Returns detailed information about a specific user, by user name. -

-
- - - - - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns detailed information about a specific user, by user id. -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns global roles for a specific user (excludes tenant roles). -

-

Returns a list of global roles associated with a specific - user (excludes tenant roles).

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - - - - -

- Get a list of tenants. -

-

- The operation returns a list of tenants which the supplied token provides - access to. This call must be authenticated, so a valid token must - be passed in as a header. -

- - - - - -
- - - - - - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns detailed information about a tenant, by name. -

-
- - - - - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns detailed information about a tenant, by id. -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns a list of endpoints associated with a specific token. -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - - -

- Returns roles for a specific user on a specific tenant (excludes global roles). -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- -
diff --git a/openstack-identity-api/src/docbkx/admin/identity-service-api.xml b/openstack-identity-api/src/docbkx/admin/identity-service-api.xml new file mode 100644 index 00000000..08814866 --- /dev/null +++ b/openstack-identity-api/src/docbkx/admin/identity-service-api.xml @@ -0,0 +1,73 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Administrative API Operations + The OpenStack Identity Service administrative API operations + enable service developers to get and validate access tokens, + manage users, tenants, roles, and service endpoints. + Most administrative API calls require authentication. The + only calls available without authentication are the calls to + discover the service – getting version info, WADL + contract, dev guide, help, and so on – and the call to + authenticate and get a token. + Authentication is performed by passing in a valid token in + the X-Auth-Token header on the request from the + client. The Identity Service will verify the token has (or + belongs to a user that has) the Admin role. + See the readme file or administrator guides for how to + bootstrap the Identity Service and create your first + administrator. + + + + + + + + + + + + + + + + +
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
+ The following calls are core for the OpenStack Identity + Service administrative APIs v2.0: +
+ Token Operations + + + + + +
+
+ User Operations + See . +
+
+ Tenant Operations + See . +
+
diff --git a/openstack-identity-api/src/docbkx/client/identity-client-api.xml b/openstack-identity-api/src/docbkx/client/identity-client-api.xml index b162a5ac..e666a2f9 100644 --- a/openstack-identity-api/src/docbkx/client/identity-client-api.xml +++ b/openstack-identity-api/src/docbkx/client/identity-client-api.xml @@ -1,18 +1,20 @@ -
- Service API (Client Operations) - The operations described in this chapter allow clients tokens - authenticate and get access tokens and service endpoints. The following - calls are core Keystone Service APIs in version 2.0: - - - - - - - - -
+ + Client API Operations + These operations enable clients to get authentication tokens and list tenants. +
Token Operations + + + +
+
Tenant Operations + + + +
+
diff --git a/openstack-identity-api/src/docbkx/common/ch_hp_extensions.xml b/openstack-identity-api/src/docbkx/common/ch_hp_extensions.xml new file mode 100644 index 00000000..5c28bbb6 --- /dev/null +++ b/openstack-identity-api/src/docbkx/common/ch_hp_extensions.xml @@ -0,0 +1,10 @@ + + + HP Identity Service Extensions + + + diff --git a/openstack-identity-api/src/docbkx/common/ch_os_extensions.xml b/openstack-identity-api/src/docbkx/common/ch_os_extensions.xml new file mode 100644 index 00000000..6c755cf7 --- /dev/null +++ b/openstack-identity-api/src/docbkx/common/ch_os_extensions.xml @@ -0,0 +1,19 @@ + + + OpenStack Identity Service Extensions + + + + + + + + diff --git a/openstack-identity-api/src/docbkx/common/ch_rax_extensions.xml b/openstack-identity-api/src/docbkx/common/ch_rax_extensions.xml new file mode 100644 index 00000000..ece97949 --- /dev/null +++ b/openstack-identity-api/src/docbkx/common/ch_rax_extensions.xml @@ -0,0 +1,18 @@ + + + Rackspace Identity Service Extensions + + + + + + + diff --git a/openstack-identity-api/src/docbkx/common/ch_rax_identity_extensions.xml b/openstack-identity-api/src/docbkx/common/ch_rax_identity_extensions.xml new file mode 100644 index 00000000..8d7e1866 --- /dev/null +++ b/openstack-identity-api/src/docbkx/common/ch_rax_identity_extensions.xml @@ -0,0 +1,10 @@ + + + Identity Service API Extensions - Rackspace + + + diff --git a/openstack-identity-api/src/docbkx/common/identity-admin.wadl b/openstack-identity-api/src/docbkx/common/identity-admin.wadl deleted file mode 100644 index 60b99382..00000000 --- a/openstack-identity-api/src/docbkx/common/identity-admin.wadl +++ /dev/null @@ -1,508 +0,0 @@ - - - - - - - - - - %common; -]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - You need a valid admin token for access. - - - - - - - - - - - - - - You need a valid admin token for access. - - - - - - - - - - - - - - - -

- You need a valid admin token for access. -

-
- - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - - - - -

- A list of supported extensions. -

-
- -
- - - - - - - - - -

- Returns detailed information about this specific version of the API. -

-
- - - - - - - - - &commonFaults; - &getFaults; -
- - - - - -

- Lists supported extensions. -

-
- - - - - - - - - - - - &commonFaults; -
- - -

- Gets details about a specific extension. -

-
- - - - - &commonFaults; - &getFaults; -
- - - - - -

- Authenticate to generate a token. -

-

- This call will return a token if successful. Each ReST request against other services (or other - calls on Keystone such as the GET /tenants call) - requires the inclusion of a specific authorization token HTTP x-header, defined as X-Auth-Token. - Clients obtain - this token, along with the URL to other service APIs, by first authenticating against the - Keystone Service and supplying valid credentials. -

-

- 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. -

-

- The Keystone Service is a ReSTful web service. It is the entry point to all service APIs. - To access the Keystone Service, you must know URL of the Keystone service. -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Check that a token is valid and that it belongs to a supplied tenant - and return the permissions relevant to a particular client. -

-

- Valid tokens will exist in the - /tokens/{tokenId} path and invalid - tokens will not. In other words, a user should expect an - itemNotFound (404) fault for an - invalid token. -

-
- - - -

- Validates a token has the supplied tenant in scope. -

-
- -
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Check that a token is valid and that it belongs to a particular tenant - (For performance). -

-
- - - -

- Validates a token has the supplied tenant in scope. (for performance). -

-

- Valid tokens will exist in the - /tokens/{tokenId} path and invalid - tokens will not. In other words, a user should expect an - itemNotFound (404) fault for an - invalid token. -

-

- If `belongsTo` is provided, validates that a token has a specific tenant in scope. -

-

- No response body is returned for this method. -

-
- -
- - &commonFaults; - &getFaults; -
- - - - -

- Returns detailed information about a specific user, by user name. -

-
- - - - - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns detailed information about a specific user, by user id. -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns global roles for a specific user (excludes tenant roles). -

-

Returns a list of global roles associated with a specific - user (excludes tenant roles).

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - - - - -

- Get a list of tenants. -

-

- The operation returns a list of tenants which the supplied token provides - access to. This call must be authenticated, so a valid token must - be passed in as a header. -

- - - - - -
- - - - - - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns detailed information about a tenant, by name. -

-
- - - - - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns detailed information about a tenant, by id. -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Returns a list of endpoints associated with a specific token. -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - - -

- Returns roles for a specific user on a specific tenant (excludes global roles). -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
-
diff --git a/openstack-identity-api/src/docbkx/common/identity-concepts.xml b/openstack-identity-api/src/docbkx/common/identity-concepts.xml index b994728e..8e47b4a3 100644 --- a/openstack-identity-api/src/docbkx/common/identity-concepts.xml +++ b/openstack-identity-api/src/docbkx/common/identity-concepts.xml @@ -1,96 +1,130 @@ - Identity Service Concepts - - The Keystone Identity Service has several key concepts, which are - important to understand: - + The OpenStack Identity Service has the following key + concepts: User - A digital representation of a person, system, or service who uses OpenStack cloud services. - Keystone authentication services will validate that incoming request are being made by the user - who claims to be making the call. Users have a login and may be assigned tokens to access - resources. Users may be directly assigned to a particular tenant and - behave as if they are contained in that tenant. + + A digital representation of a person, system, or + service that uses OpenStack cloud services. + OpenStack Identity authentication services + validate that an incoming request is being made by + the user who claims to be making the call. Users + have a login and may be assigned tokens to access + resources. Users may be directly assigned to a + particular tenant and behave as if they are + contained in that tenant. + Credentials - - Data that belongs to, is owned by, and generally only known by a user that the user can present - to prove they are who they are (since nobody else should know that data). - Examples are: - - a matching username and password - a matching username and API key - yourself and a driver's license with a picture of you - a token that was issued to you that nobody else knows of - - + + Data that belongs to, is owned by, and generally + only known by a user that the user can present to + prove their identity. + Examples include: + + A matching username and + password + + + A matching username and API + key + + + A token that was issued to you + + + + Authentication - - In the context of Keystone, the act of confirming the identity of a - user or the truth of a claim. - Keystone will confirm that incoming request are being made by the user - who claims to be making the call by validating a set of claims that the user is making. - These claims are initially in the form of a set of credentials (username & password, - or username and API key). After initial confirmation, Keystone will issue the user a token - which the user can then provide to demonstrate that their identity has been authenticated - when making subsequent requests. - + + In the context of OpenStack Identity Service, + the act of confirming the identity of a user or + the truth of a claim. OpenStack Identity Service + confirms that an incoming request is being made by + the user who claims to be making the call by + validating a set of claims that the user is + making. These claims are initially in the form of + a set of credentials (username & password, or + username and API key). After initial confirmation, + OpenStack Identity Service issues the user a + token, which the user can then provide to + demonstrate that their identity has been + authenticated when making subsequent requests. + + Token - - An arbitrary bit of text that is used to access - resources. Each token has a scope which describes which - resources are accessible with it. A token may be - revoked at anytime and is valid for a finite duration. - - - While Keystone supports token-based authentication in this release, - the intention is for it to support additional protocols in the - future. The intent is for it to be an integration service foremost, and not - a aspire to be a full-fledged identity store and management solution. - + + An arbitrary bit of text that is used to access + resources. Each token has a scope that describes + which resources are accessible with it. A token + may be revoked at anytime and is valid for a + finite duration. + While OpenStack Identity Service supports + token-based authentication in this release, the + intention is for it to support additional + protocols in the future. The intent is for it to + be an integration service foremost, and not a + aspire to be a full-fledged identity store and + management solution. + Tenant - - A container used to group or isolate resources and/or identity - objects. Depending on the service operator, a tenant may map to a customer, - account, organization, or project. - + + A container used to group or isolate resources + and/or identity objects. Depending on the service + operator, a tenant can map to a customer, account, + organization, or project. + Service - - An OpenStack service, such as Compute (Nova), Object Storage (Swift), or Image Service (Glance). A service provides - one or more endpoints through which users can access resources and perform - (presumably useful) operations. - + + An OpenStack service, such as Compute (Nova), + Object Storage (Swift), or Image Service (Glance). + A service provides one or more endpoints through + which users can access resources and perform + operations. + Endpoint - - An network-accessible address, usually described by URL, where a service may be accessed. If using an extension for templates, you can create an endpoint template, which represents the templates of all the consumable services that are available across the regions. - + + An network-accessible address, usually described + by a URL, where a service may be accessed. If + using an extension for templates, you can create + an endpoint template, which represents the + templates of all the consumable services that are + available across the regions. + Role - A personality that a user assumes when performing a specific set of operations. - A role includes a set of right and privileges. A user assuming that role inherits - those rights and privileges. - - In Keystone, a token that is issued to a user includes the list of roles that user - can assume. Services that are being called by that user determine how they interpret the set - of roles a user has and which operations or resources each roles grants access to. - + + A personality that a user assumes when + performing a specific set of operations. A role + includes a set of right and privileges. A user + assuming that role inherits those rights and + privileges. + In OpenStack Identity Service, a token that is + issued to a user includes the list of roles that + user can assume. Services that are being called by + that user determine how they interpret the set of + roles a user has and which operations or resources + each roles grants access to. + - +
+ diff --git a/openstack-identity-api/src/docbkx/common/identity-dev-guide.xml b/openstack-identity-api/src/docbkx/common/identity-dev-guide.xml index 40642431..50b4785f 100644 --- a/openstack-identity-api/src/docbkx/common/identity-dev-guide.xml +++ b/openstack-identity-api/src/docbkx/common/identity-dev-guide.xml @@ -4,9 +4,9 @@ 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" - xml:id="Keystone-Developer-Guide"> + xml:id="Identity-Service-Developer-Guide"> OpenStack Identity Service API v2.0 Reference - + Identity Service API Reference @@ -35,15 +35,42 @@ - This document describes how to develop - applications that use the OpenStack Identity Service API v2.0 - for authentication. This document also describes how - to integrate services with the OpenStack Identity - Service API v2.0. + This document describes how to develop applications + that use the OpenStack Identity Service API v2.0 for + authentication. This document also describes how to + integrate services with the OpenStack Identity Service + API v2.0. + + + 2013-05-30 + + + + Added back missing client operations + and extensions. + + + + + + 2011-09-13 + + + + Initial release. + + + + + - + - + + + + + diff --git a/openstack-identity-api/src/docbkx/common/identity-general-api-info.xml b/openstack-identity-api/src/docbkx/common/identity-general-api-info.xml index 020bcad1..019c188d 100644 --- a/openstack-identity-api/src/docbkx/common/identity-general-api-info.xml +++ b/openstack-identity-api/src/docbkx/common/identity-general-api-info.xml @@ -13,7 +13,7 @@ - '> @@ -41,223 +41,197 @@ This operation does not require a request body.'> - Overview of Keystone API - The Keystone Identity Service allows clients to obtain tokens that can be used to access - OpenStack cloud services. This document is intended for software developers interested in - developing applications that utilize the Keystone Identity Service API for authentication. - - This Guide assumes the reader is familiar with RESTful web services, HTTP/1.1, and JSON - and/or XML serialization formats. -
- General API Information - The Keystone API is implemented using a RESTful web service interface. All requests to - authenticate and operate against the Keystone API should be performed using SSL over HTTP - (HTTPS) on TCP port 443. -
+ xml:id="Overview-Identity-Service-API-d1e62"> + + General API Information + + The OpenStack Identity Service API is implemented using a + RESTful web service interface. All requests to authenticate + and operate against the OpenStack Identity Service API should + be performed using SSL over HTTP (HTTPS) on TCP port + 443. +
- Request/Response Types - The Keystone API supports both the JSON and XML data serialization formats. The request - format is specified using the Content-Type header and is required for - operations that have a request body. The response format can be specified in requests using - either the Accept header or adding an .xml or .json - extension to the request URI. Note that it is possible for a response to be serialized using - a format different from the request (see example below). If no response format is specified, - JSON is the default. If conflicting formats are specified using both an Accept - header and a query extension, the query extension takes precedence. - - - - - - - - - - - - - - - - - - - - - - - - -
Response Types
FormatAccept HeaderQuery ExtensionDefault
JSONapplication/json.jsonYes
XMLapplication/xml.xmlNo
- - JSON Request with Headers - - - - - - - - - XML Response with Headers - - - - - - - + Request/Response Types + The OpenStack Identity Service API supports both the + JSON and XML data serialization formats. The request + format is specified using the Content-Type + header and is required for operations that have a request + body. The response format can be specified in requests + using either the Accept header or adding an + .xml or .json extension to + the request URI. Note that it is possible for a response + to be serialized using a format different from the request + (see example below). If no response format is specified, + JSON is the default. If conflicting formats are specified + using both an Accept header and a query + extension, the query extension takes precedence. + + + + + + + + + + + + + + + + + + + + + + + + +
Response Types
FormatAccept HeaderQuery ExtensionDefault
JSONapplication/json.jsonYes
XMLapplication/xml.xmlNo
+ + JSON Request with Headers + + + + + XML Response with Headers + + +
- Content Compression - Request and response body data my be encoded with gzip compression in order to - accelerate interactive performance of API calls and responses. This is controlled using the - Accept-Encoding header on the request from the client and indicated by the - Content-Encoding header in the server response. Unless the header is - explicitly set, encoding defaults to disabled. - - - - - - - - - - - - - - - - - - - - - -
Compression Headers
Header TypeNameValue
HTTP/1.1 RequestAccept-Encodinggzip
HTTP/1.1 ResponseContent-Encodinggzip
+ Content Compression + Request and response body data my be encoded with gzip + compression in order to accelerate interactive performance + of API calls and responses. This is controlled using the + Accept-Encoding header on the request + from the client and indicated by the + Content-Encoding header in the server + response. Unless the header is explicitly set, encoding + defaults to disabled. + + + + + + + + + + + + + + + + + + + + + +
Compression Headers
Header TypeNameValue
HTTP/1.1 RequestAccept-Encodinggzip
HTTP/1.1 ResponseContent-Encodinggzip
Paginated Collections - - To reduce load on the service, list operations will - return a maximum number of items at a time. The - maximum number of items returned is determined by the - Identity provider. To navigate the collection, the - parameters limit and - marker can be set in the URI - (e.g.?limit=100&marker=1234). - The marker parameter is the ID - of the last item in the previous list. Items are - sorted by update time. When an update time is not - available they are sorted by ID. The - limit parameter sets the page - size. Both parameters are optional. If the client - requests a limit beyond that + To reduce load on the service, list operations will + return a maximum number of items at a time. The maximum + number of items returned is determined by the Identity + provider. To navigate the collection, the parameters + limit and + marker can be set in the URI + (for example, + ?limit=100&marker=1234). + The marker parameter is the ID of + the last item in the previous list. Items are sorted by + update time. When an update time is not available they are + sorted by ID. The limit parameter + sets the page size. Both parameters are optional. If the + client requests a limit beyond that which is supported by the deployment an overLimit - (413) fault may be thrown. A + (413) fault may be thrown. A marker with an invalid ID will return an itemNotFound - (404) fault. - + (404) fault. - - Paginated collections never return itemNotFound - (404) faults when the - collection is empty — clients should expect - an empty collection. - + Paginated collections never return itemNotFound + (404) faults when the + collection is empty — clients should expect an + empty collection. - - For convenience, collections contain atom "next" and + For convenience, collections contain atom "next" and "previous" links. The first page in the list will not - contain a "previous" link, the last page in the list - will not contain a "next" link. The following examples - illustrate three pages in a collection of tenants. The - first page was retrieved via a &GET; to + contain a "previous" link, the last page in the list will + not contain a "next" link. The following examples + illustrate three pages in a collection of tenants. The + first page was retrieved through a &GET; to http://identity.api.openstack.org/v2.0/1234/tenants?limit=1. In these examples, the limit - parameter sets the page size to a single item. - Subsequent "next" and "previous" links will honor the - initial page size. Thus, a client may follow links to - traverse a paginated collection without having to - input the marker parameter. - + parameter sets the page size to a single item. Subsequent + "next" and "previous" links will honor the initial page + size. Thus, a client may follow links to traverse a + paginated collection without having to input the + marker parameter. Tenant Collection, First Page: XML - - - + Tenant Collection, First Page: JSON - + Tenant Collection, Second Page: XML - - - + Tenant Collection, Second Page: JSON - + Tenant Collection, Last Page: XML - - - + Tenant Collection, Last Page: JSON - + - - In the JSON representation, paginated collections contain - a values property that contains the - items in the collections. Links are accessed via the - links property. The approach allows - for extensibility of both the collection members and of - the paginated collection itself. It also allows + In the JSON representation, paginated collections + contain a values property that + contains the items in the collections. Links are accessed + via the links property. The approach + allows for extensibility of both the collection members + and of the paginated collection itself. It also allows collections to be embedded in other objects as illustrated below. Here, a subset of groups are presented within a user. Clients must follow the "next" link to continue to - retrieve additional groups belonging to a user. - + retrieve additional groups belonging to a user. Paginated Roles in a User: XML - - - + Paginated Roles in an User: JSON - +
Versions - - The OpenStack Identity API uses both a URI and a MIME + The OpenStack Identity API uses both a URI and a MIME type versioning scheme. In the URI scheme, the first - element of the path contains the target version - identifier (e.g. https://identity.api.openstack.org/ - v2.0/…). The MIME type versioning scheme uses - HTTP content negotiation where the Accept - or Content-Type headers contains a MIME - type that includes the version ID as a parameter + element of the path contains the target version identifier + (e.g. https://identity.api.openstack.org/ v2.0/…). + The MIME type versioning scheme uses HTTP content + negotiation where the Accept or + Content-Type headers contains a MIME type + that includes the version ID as a parameter (application/vnd.openstack.identity+xml;version=1.1). A version MIME type is always linked to a base MIME type (application/xml or application/json). If conflicting versions are specified using both an HTTP header and a - URI, the URI takes precedence. - + URI, the URI takes precedence. Request with MIME type versioning @@ -277,57 +251,46 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb - - The MIME type versioning approach allows for the + The MIME type versioning approach allows for the creating of permanent links, because the version scheme is not specified in the URI path: https://api.identity.openstack.org/tenants/12234. - - If a request is made without a version specified in - the URI or via HTTP headers, then a multiple-choices - response (300) will follow - providing links and MIME types to available versions. - + If a request is made without a version specified in the + URI or via HTTP headers, then a multiple-choices response + (300) will follow providing + links and MIME types to available versions. Multiple Choices Response: XML - - - + Multiple Choices Response: JSON - + - - New features and functionality that do not break + New features and functionality that do not break API-compatibility will be introduced in the current - version of the API as extensions (see below) and the - URI and MIME types will remain unchanged. Features or - functionality changes that would necessitate a break - in API-compatibility will require a new version, which - will result in URI and MIME type version being updated + version of the API as extensions (see below) and the URI + and MIME types will remain unchanged. Features or + functionality changes that would necessitate a break in + API-compatibility will require a new version, which will + result in URI and MIME type version being updated accordingly. When new API versions are released, older - versions will be marked as - DEPRECATED. Providers should work with - developers and partners to ensure there is adequate - time to migrate to the new version before deprecated - versions are discontinued. - - - Your application can programmatically determine - available API versions by performing a &GET; on the - root URL (i.e. with the version and everything to the - right of it truncated) returned from the - authentication system. Note that an Atom - representation of the versions resources is supported - when issuing a request with the Accept - header containing application/atom+xml or by adding a - .atom to the request URI. This allows standard Atom - clients to track version changes. - + versions will be marked as DEPRECATED. + Providers should work with developers and partners to + ensure there is adequate time to migrate to the new + version before deprecated versions are discontinued. + Your application can programmatically determine + available API versions by performing a &GET; on the root + URL (such as, with the version and everything to the right + of it truncated) returned from the authentication system. + Note that an Atom representation of the versions resources + is supported when issuing a request with the + Accept header containing + application/atom+xml or by adding a .atom to the request + URI. This allows standard Atom clients to track version + changes. Versions List Request @@ -335,45 +298,35 @@ GET HTTP/1.1 Host: identity.api.openstack.org - &CODES;200, 203 + &CODES;200, + 203 &ERROR_CODES; badRequest - (400), identityFault - (500), - serviceUnavailable(503) - &NO_REQUEST; - + (400), identityFault + (500), + serviceUnavailable(503) + &NO_REQUEST; Versions List Response: XML - - - + Versions List Response: Atom - - - + Versions List Response: JSON - + - - You can also obtain additional information about a - specific version by performing a &GET; on the base - version URL - (e.g. https://identity.api.openstack.org/v1.1/). + You can also obtain additional information about a + specific version by performing a &GET; on the base version + URL (e.g. https://identity.api.openstack.org/v1.1/). Version request URLs should always end with a trailing - slash (/). If the slash is omitted, the server may - respond with a 302 - redirection request. Format extensions may be placed - after the slash - (e.g. https://identity.api.openstack.org/v1.1/.xml). Note - that this is a special case that does not hold true - for other API requests. In general, requests such as - /tenants.xml and /tenants/.xml are handled - equivalently. - + slash (/). If the slash is omitted, the server may respond + with a 302 redirection request. + Format extensions may be placed after the slash (e.g. + https://identity.api.openstack.org/v1.1/.xml). Note that + this is a special case that does not hold true for other + API requests. In general, requests such as /tenants.xml + and /tenants/.xml are handled equivalently. Version Details Request @@ -381,55 +334,47 @@ GET HTTP/1.1 Host: identity.api.openstack.org/v1.1/ - &CODES;200, 203 + &CODES;200, + 203 &ERROR_CODES; badRequest - (400), identityFault - (500), - serviceUnavailable(503) - &NO_REQUEST; - + (400), identityFault + (500), + serviceUnavailable(503) + &NO_REQUEST; Version Details Response: XML - - - + Version Details Response: Atom - - - + Version Details Response: JSON - + - - The detailed version response contains pointers to - both a human-readable and a machine-processable - description of the API service. The machine-processable description is written in the Web - Application Description Language (WADL). - + The detailed version response contains pointers to both + a human-readable and a machine-processable description of + the API service. The machine-processable description is + written in the Web Application Description Language + (WADL). - If there is a discrepancy between the two specifications, the WADL is - authoritative as it contains the most accurate and up-to-date description of the - API service. + If there is a discrepancy between the two + specifications, the WADL is authoritative as it + contains the most accurate and up-to-date description + of the API service.
Extensions - - The OpenStack Identity API is extensible. Extensions + The OpenStack Identity API is extensible. Extensions serve two purposes: They allow the introduction of new - features in the API without requiring a version change - and they allow the introduction of vendor specific - niche functionality. Applications can programmatically - determine what extensions are available by performing - a &GET; on the /extensions URI. Note that this is a - versioned request — that is, an extension - available in one API version may not be available in - another. - + features in the API without requiring a version change and + they allow the introduction of vendor specific niche + functionality. Applications can programmatically determine + what extensions are available by performing a &GET; on the + /extensions URI. Note that this is a versioned request + — that is, an extension available in one API version + may not be available in another. @@ -442,39 +387,34 @@ Host: identity.api.openstack.org/v1.1/ &GET; /extensions - Returns a list of available extensions + Returns a list of available + extensions - &CODES;200, 203 + &CODES;200, + 203 &ERROR_CODES; badRequest - (400), identityFault (500), - serviceUnavailable(503) - &NO_REQUEST; - - Each extension is identified by two unique identifiers, a - namespace and an - alias. Additionally an extension - contains documentation links in various formats. - + (400), identityFault + (500), + serviceUnavailable(503) + &NO_REQUEST; Each extension is identified by two unique + identifiers, a namespace and an + alias. Additionally an extension + contains documentation links in various formats. Extensions Response: XML - - - + Extensions Response: JSON - + - - Extensions may also be queried individually by their - unique alias. This provides the simplest method of + Extensions may also be queried individually by their + unique alias. This provides the simplest method of checking if an extension is available as an unavailable extension will issue an itemNotFound - (404) response. - + (404) response. @@ -486,159 +426,151 @@ Host: identity.api.openstack.org/v1.1/ &GET; - /extensions/alias - Return details of a single extension + /extensions/alias + Return details of a single + extension - &CODES;200, 203 + &CODES;200, + 203 &ERROR_CODES; itemNotFound - (404), badRequest - (400), identityFault - (500), - serviceUnavailable(503) - &NO_REQUEST; - + (404), badRequest + (400), identityFault + (500), + serviceUnavailable(503) + &NO_REQUEST; Extension Response: xml - - - + Extensions Response: JSON - + - - Extensions may define new data types, parameters, actions, - headers, states, and resources. In XML, additional - elements and attributes may be defined. These elements - must be defined in the extension's namespace. In JSON, the - alias must be used. The volumes element in the and - + Extensions can define new data types, parameters, + actions, headers, states, and resources. In XML, + additional elements and attributes may be defined. These + elements must be defined in the extension's namespace. In + JSON, the alias must be used. The volumes element in the + and is defined in the RS-META namespace. Extended headers are always prefixed with X- followed by the alias and a dash: (X-RS-META-HEADER1). Parameters must be prefixed with the extension alias - followed by a colon. - + followed by a colon. - - Applications should be prepared to ignore response + Applications should be prepared to ignore response data that contains extension elements. Also, applications should also verify that an extension is - available before submitting an extended request. - + available before submitting an extended request. Extended User Response: XML - - - + Extended User Response: JSON - +
- Faults - When an error occurs the system will return an HTTP error response code denoting the - type of error. The system will also return additional information about the fault in the - body of the response. - - XML Fault Response - - - - - - JSON Fault Response - - - - - The error code is returned in the body of the response for convenience. The message - section returns a human readable message. The details section is optional and may contain - useful information for tracking down an error (e.g a stack trace). - The root element of the fault (e.g. identityFault) may change depending on the type of error. - The following is an example of an itemNotFound error. - - XML Not Found Fault - - - - - - JSON Not Found Fault - - - - - The following is a list of possible fault types along with their associated error - codes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fault Types
Fault ElementAssociated Error CodeExpected in All Requests
identityFault500, 400 ✓
serviceUnavailable503 ✓
badRequest400 ✓
unauthorized401 ✓
overLimit413 -
userDisabled403 -
forbidden403 -
itemNotFound404 -
tenantConflict409 -
- From an XML schema perspective, all API faults are extensions of the base fault type - identityFault. When working with a system that binds XML to actual classes (such - as JAXB), one should be capable of using identityFault as a “catch-all” if - there's no interest in distinguishing between individual fault types. + Faults + When an error occurs the system will return an HTTP + error response code denoting the type of error. The system + will also return additional information about the fault in + the body of the response. + + XML Fault Response + + + + JSON Fault Response + + + The error code is returned in the body of the response + for convenience. The message section returns a human + readable message. The details section is optional and may + contain useful information for tracking down an error (e.g + a stack trace). + The root element of the fault (e.g. identityFault) may + change depending on the type of error. The following is an + example of an itemNotFound error. + + XML Not Found Fault + + + + JSON Not Found Fault + + + The following is a list of possible fault types along + with their associated error codes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fault Types
Fault ElementAssociated Error CodeExpected in All Requests
identityFault500, 400 ✓
serviceUnavailable503 ✓
badRequest400 ✓
unauthorized401 ✓
overLimit413 +
userDisabled403 +
forbidden403 +
itemNotFound404 +
tenantConflict409 +
+ From an XML schema perspective, all API faults are + extensions of the base fault type + identityFault. When working with a system + that binds XML to actual classes (such as JAXB), one + should be capable of using identityFault as a + “catch-all” if there's no interest in distinguishing + between individual fault types.
-
+ diff --git a/openstack-identity-api/src/docbkx/common/identity-service-api.xml b/openstack-identity-api/src/docbkx/common/identity-service-api.xml index c647c765..994abfcf 100644 --- a/openstack-identity-api/src/docbkx/common/identity-service-api.xml +++ b/openstack-identity-api/src/docbkx/common/identity-service-api.xml @@ -16,9 +16,9 @@ token. You perform authentication by passing a valid token in the X-Auth-Token header on the request from the - client. Keystone verifies the token belongs to a user with the + client. The Identity Service verifies the token belongs to a user with the Admin role. - For how to bootstrap Keystone and create your first + For how to bootstrap the Identity Service and create your first administrator, see the readme file and administrator guides. @@ -37,7 +37,7 @@
Authentication Header
- The following calls are core for the Keystone Admin 2.0 + The following calls are core for the Identity Service Admin 2.0 APIs:
Token Operations diff --git a/openstack-identity-api/src/docbkx/common/preface.xml b/openstack-identity-api/src/docbkx/common/preface.xml new file mode 100644 index 00000000..c4ba1fd7 --- /dev/null +++ b/openstack-identity-api/src/docbkx/common/preface.xml @@ -0,0 +1,29 @@ + + + Preface + + The OpenStack Identity Service allows clients to obtain + tokens that can be used to access OpenStack cloud services. +
+ Intended Audience + This reference is for software developers who develop + applications that use the Identity Service API for + authentication. + This reference assumes that the reader is familiar with + RESTful web services, HTTP/1.1, and JSON and/or XML + serialization formats. +
+
+ Document Change History + This version of the reference replaces and obsoletes all + previous versions. The following table describes recent + changes: + + +
+
diff --git a/openstack-identity-api/src/docbkx/common/xsd/endpoints.xsd b/openstack-identity-api/src/docbkx/common/xsd/endpoints.xsd deleted file mode 100644 index 26d33031..00000000 --- a/openstack-identity-api/src/docbkx/common/xsd/endpoints.xsd +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - - - - - - - -

- An Endpoint. -

-
-
-
- - - -

- A list of Endpoints. -

-
-
-
- - - - - - - -

- Version details. -

-
-
-
- - -
- - - -

- An ID uniquely identifying the Endpoint. -

-
-
-
- - - -

- The OpenStack-registered type (e.g. 'compute', 'object-store', etc). -

-
-
-
- - - -

- The commercial service name (e.g. 'My Nova Cloud Servers'). -

-
-
-
- - - -

- The region of Endpoint Template. -

-
-
-
- - - -

- The public URL to access represented service. -

-
-
-
- - - -

- The internal version of the public URL. -

-
-
-
- - - -

- The admin URL. -

-
-
-
- - - -

- Tenant id to which the endpoints belong. -

-
-
-
- -
- - - - - - - - -
diff --git a/openstack-identity-api/src/docbkx/common/xsd/extensions.xsd b/openstack-identity-api/src/docbkx/common/xsd/extensions.xsd deleted file mode 100644 index a7b44f6c..00000000 --- a/openstack-identity-api/src/docbkx/common/xsd/extensions.xsd +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - - - - - Extensions - - - -

- This schema file defines types related to API - extensions. -

-
-
- - - - - - - -

- A list of supported extensions. -

-
- - - - - - - - - - -
-
- - - -

- Detials about a specific extension. -

-
- - - - - - - - - - -
-
- - - - -

- A list of extensions. -

-
-
- - - - - - -
- - - - -

- Detials about a specific extension. -

-
-
- - - - -

- A short description of what the extension - does. -

-
-
-
- - -
- - - -

- A human reabable extension name. -

-
-
-
- - - -

- Extension namespace used for XML representations. -

-
-
-
- - - -

- A vendor prefix alieas used for non-XML - representations. -

-
-
-
- - - -

- The time that the extension was added or - modifided. -

-
-
-
- - - - -

- There should be at least one atom link with a - describedby relation. This relation provides - developer info for the extension. -

-
-
-
-
- - - - -

- Vendor aliases are used to differentiate - extensions in non-XML representations as well as - in HTTP headers and in the URL path. An alias is - made of a vendor prefix, followed be a a dash (-) - followed be a short extension ID. For example: - RAX-PIE. -

-
-
- - - -
-
diff --git a/openstack-identity-api/src/docbkx/common/xsd/token.xsd b/openstack-identity-api/src/docbkx/common/xsd/token.xsd deleted file mode 100644 index 428a3874..00000000 --- a/openstack-identity-api/src/docbkx/common/xsd/token.xsd +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - - - - - - - - - - - - - -

- A token is an arbitrary bit of text that is used to access - resources. Each token has a scope which describes which - resources are accessible with it. A token may be - revoked at anytime and is valid for a finite duration. -

-

- While Keystone supports token-based authentication in this release, - the intention is for it to support additional protocols in the - future. The desire is for it to be an integration service, and not - a full-fledged identity store and management solution. -

-
- - - - - - - - - - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- The service catalog lists the services you have access to -

-
-

- We optimized for future flexibility around the hierarchy. So we - left the design as a flat list of endpoints with attributes and the - consumer can categorize as they need. - This results in potential duplication (such as with the version/@list) - but we acceopt that normalization cost in order to not force an - artificial hierarchy (suchas on region, which can be optional). -

-
-
- - -           -             -           -           -             -           -         - -
- - - - -

- A list of services. -

-
-
-
- - -
- -
- - - - - - -

- A list of endpoints. -

-
-
-
- - -
- - - -

- The OpenStack-registered type (e.g. 'compute', 'object-store', etc). -

-
-
-
- - - -

- The commercial service name (e.g. 'My Nova Cloud Servers'). -

-
-
-
- -
- - - - - - - -

- Version details. -

-
-
-
- - -
- - - -

- The name of the region where the endpoint - lives. Example: airport codes; LHR (UK), - STL (Saint Louis) -

-
-
-
- - - -

- Tenant id to which the endpoints belong. -

-
-
-
- - - -

- Public accessible service URL. -

-
-
-
- - - -

- A service URL, accessible only locally within that - cloud (generally over a high bandwidth, low latency, - free of charge link). -

-
-
-
- - - -

- An Admin URL (used for administration using privileged - calls). This may expose - additional functionality not found in the public and - internal URL. -

-
-
-
- -
- - - - - - -

- Id of the version. -

-
-
-
- - - -

- URI to get the information specific to this version. -

-
-
-
- - - -

- URI to get the information about all versions. -

-
-
-
- -
-
diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-service-devguide.xml b/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-service-devguide.xml deleted file mode 100644 index 940df74d..00000000 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-service-devguide.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - - - - - - Verb - URI - Description - - '> - - - - -]> - - - OpenStack Identity EC2 authentication Extension (Service Operations) - OS-KSEC2 (Admin) - - - - - - - - OpenStack - - - - 2010 - 2011 - OpenStack - - EXT v1.0 - OpenStack Identity - &PUB_DATE; - - - Copyright details are filled in by the template. - - - - - This document is intended for client developers interested - in using the OpenStack EC2 Authentication Service Extension along with the - Keystone - OpenStack Identity - (API). - - - - - - Adds the capability to support EC2 style authentication. - - - - - - - - 2011-08-26 - - - - - Initial release. - - - - - - - - - Summary of Changes - The OpenStack EC2 authentication Service Extension allows - authenticate call using ec2Credentials. -
- New Headers - None. -
-
- New Faults - None. -
-
- New Resources - None. -
-
- New Actions - None. -
-
- New Element -
- - Openstack extension to Keystone v2.0 API enabling EC2 style authentication. - -
- Authenticate - This extension allows authentication calls to accept new type of credentials ec2Credentials. - These are additional type of credentials defined to support EC2 style authentication. - The usage of ec2Credentials on a existing call to authenticate is illustrated below - - - &URI_REFHEAD; - - - &POST; - /tokens - Authenticate to generate a token. - - - - &CODES;200, 203 - &ERROR_CODES; unauthorized (401), userDisabled - (403), badRequest (400), identityFault - (500), serviceUnavailable(503) - - This call will return a token if successful. - Clients obtain - this token, along with the URL to other service APIs, by first authenticating against the - Keystone Service and supplying valid credentials. - This extension provides support for Rackspace Style API Key credentials. - - - 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. - - - The Keystone Service is a ReSTful web service. It is the entry point to all service APIs. - To access the Keystone Service, you must know URL of the Keystone service. - - - XML Auth Request using EC2CREDENTIALS - - - - JSON Auth Request using EC2CREDENTIALS - - - - XML Auth Response - - - - JSON Auth Response - - -
-
-
-
-
diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/OS-KSS3-admin-devguide.xml b/openstack-identity-api/src/docbkx/extensions/OS-KSS3/OS-KSS3-admin-devguide.xml deleted file mode 100644 index 9ede7675..00000000 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/OS-KSS3-admin-devguide.xml +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - - - - - - Verb - URI - Description - - '> - - - - - - -]> - - - OpenStack Identity OS-KSS3 Extension (Admin Operations) - OS-KSS3 (Admin) - - - - - - - - Rackspace Cloud - - - - 2011 - Rackspace US, Inc. - - EXT v1.0 - OpenStack Identity - &PUB_DATE; - - - Copyright details are filled in by the template. - - - - - Joe - Savak - - joe.savak@RACKSPACE.COM - - - - Keystone v2.0 API extension. - - - - - - - This document is intended for client developers interested - in using the OS-KSS3 Extension (Admin) along with the - Keystone - OpenStack Identity - (API). - - - - - 2011-09-13 - - - - - Initial release. - - - - - - - - - Summary of Changes - - The OS-KSS3 Extension allows crud/listing operations on s3Credentials. - -
- New Headers - None. -
-
- New Faults - None. -
-
- New Resources - None. -
-
- New Actions - None. -
-
- New Element -
- s3Credentials - This extension allows authentication calls to accept new type of credentials s3Credentials. - These are additional type of credentials defined to support Amazon's S3 style Authentication. - Examples of s3Credentials are illustrated below. - - - s3Credentials XML - - - - s3Credentials JSON - - -
-
-
- OS-KSS3 extension to Keystone v2.0 API -
- New Elements - - This extension allows token validation and endpoint retrieval without sending tokens in the URI. - -
-
- OS-KSS3 Extension API Operations - - - - - - - - - - - - - - - - - -
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
- - Following operations are the list of operations available in the OS-KSS3 Admin Extension: -
- API operations - - - - - - - - - - - -
-
-
-
-
diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/OS-KSVALIDATE-admin-devguide.xml b/openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/OS-KSVALIDATE-admin-devguide.xml deleted file mode 100644 index a945ca72..00000000 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/OS-KSVALIDATE-admin-devguide.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - - - - - - Verb - URI - Description - - '> - - - -]> - - - OpenStack Identity OS-KSVALIDATE Extension (Service Operations) - OS-KSVALIDATE (Service) - - - - - - - - Rackspace Cloud - - - - 2010 - 2011 - OpenStack - - API v2.0 - OpenStack Identity - 2011-08-29 - - - Copyright details are filled in by the template. - - - - - Joe - Savak - - joe.savak@RACKSPACE.COM - - - - Keystone v2.0 API extension. - - - - - - - This document is intended for client developers interested - in using the OS-KSVALIDATE Extension (Service) along with the - Keystone - OpenStack Identity - (API). - - - - - 2011-09-13 - - - - - Initial release. - - - - - - - - - Summary of Changes - - OS-KSVALIDATE extension allows a Token to be optionally encrypted and passed in the 'X-Subject-Token' header for validation, rather than in the URI. - -
- New Headers - None. -
-
- New Faults - None. -
-
- New Resources - None. -
-
- New Actions - None. -
-
- New Elements -
- OS-KSVALIDATE extension to Keystone v2.0 API -
- New Elements - - This extension allows token validation and endpoint retrieval without sending tokens in the URI. - -
-
- OS-KSVALIDATE Extension API Operations - - - - - - - - - - - - - - - - - -
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
- - Following operations are the list of operations available in the OS-KSVALIDATE Service Extension: -
- API operations - - - - - - - - - -
-
-
-
-
-
diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/OS-KSVALIDATE-admin.wadl b/openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/OS-KSVALIDATE-admin.wadl deleted file mode 100644 index 610a4116..00000000 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSVALIDATE/OS-KSVALIDATE-admin.wadl +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - - - - %common; -]> - - - - - - - - - - - - - - - - - - - - You need a valid admin token for access. - - - You need to supply a token to validate. - - - - - - - - - - You need a valid admin token for access. - - - You need to supply a token to validate. - - - - - - - - - - - - - - - - -

- Check that a token is valid and that it belongs to a supplied tenant - and services and return the permissions relevant to a particular client. -

-

- Behaviour is similar to /tokens/{tokenId}. In - other words, a user should expect an - itemNotFound (404) fault for an - invalid token. -

-

- 'X-Subject-Token' may be encrypted, but can still be used for - caching. This extension may decrypt this header and - internally call Keystone's normal validation, passing along all - headers and query parameters. It should therefore support - all exsting calls on /tokens/{tokenId}, including - extensions such as HP-IDM. -

-
- - - -

- Validates a token has the supplied tenant in scope. -

-
- - - -

- If provided, filter the roles to be returned by the given service IDs. -

-
- -
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- - -

- Check that a token is valid and that it belongs to a particular - tenant and services (For performance). -

-

- Behaviour is similar to /tokens/{tokenId}. In - other words, a user should expect an - itemNotFound (404) fault for an - invalid token. -

-

- 'X-Subject-Token' may be encrypted, but can still be used for - caching. This extension may decrypt this header and - internally call Keystone's normal validation, passing along all - headers and query parameters. It should therefore support - all exsting calls on /tokens/{tokenId}, including - extensions such as HP-IDM. -

-

- No response body is returned for this method. -

-
- - - -

- Validates a token has the supplied tenant in scope. (for performance). -

-
- - - -

- Check the roles against the given service IDs. -

-
- -
- - &commonFaults; - &getFaults; -
- - -

- Returns a list of endpoints associated with a specific token. -

-
- - - - - - - - - - - - - &commonFaults; - &getFaults; -
- -
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/RAX-GRPADM-devguide.xml b/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/RAX-GRPADM-devguide.xml deleted file mode 100644 index 3b7b194f..00000000 --- a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/RAX-GRPADM-devguide.xml +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - - - - Verb - URI - Description - - '> - - - - - - - - - - - - - - - - - - -]> - - - OpenStack Identity Rackspace Group Admin Extension - &ALIAS; - - - - - - - - Rackspace Cloud - - - - 2011 - Rackspace US, Inc. - - OpenStack Identity - &PUB_DATE; - - - Copyright details are filled in by the template. - - - - - Joe - Savak - - joe.savak@RACKSPACE.COM - - - - Rackspace extensions to Keystone v2.0 API - enabling Group Admin. - - - - - - - This document is intended for software developers interested - in using the Group Admin Extension to the OpenStack - Identity Application Programming Interface - (API). - - - - - 2012-01-23 - - - - - Initial release. - - - - - - - - - - Summary of Changes - - This extension adds capabilites to the RAX-KSGRP extension. - It allows for CRUD operations on groups and gives the - ability to associate groups with users. - -
- New Headers - None. -
-
- New Faults - None. -
-
- New Resources - None. -
-
- New Actions - None. -
-
- New Element -
- groups - - This extension adds capabilites to the RAX-KSGRP extension. - It allows for CRUD operations on groups and gives the - ability to associate groups with users. - - - group XML - - - - groups JSON - - -
-
- -
- RAX-GRPADM Extension API Operations - - - - - - - - - - - - - - - - -
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
- A new resource is created at /RAX-GRPADM/groups that allows for the management of groups. -
- User Operations - - - - - - - - - - - - - - - - - -
-
-
-
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/RAX-KSGRP-service-devguide.xml b/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/RAX-KSGRP-service-devguide.xml deleted file mode 100644 index 7709d362..00000000 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/RAX-KSGRP-service-devguide.xml +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - - - - - - Verb - URI - Description - - '> - - - - - - - - - - - - - -]> - - - OpenStack Identity Rackspace Group Extension (Service Operations) - RAX-KSGRP (Service) - - - - - - - - Rackspace Cloud - - - - 2011 - Rackspace US, Inc. - - EXT v1.0 - OpenStack Identity - &PUB_DATE; - - - Copyright details are filled in by the template. - - - - - Joe - Savak - - joe.savak@RACKSPACE.COM - - - Rackspace extensions to Keystone v2.0 API enabling groups. - - - - - - This document is intended for client developers interested - in using the Rackspace Keystone Group Extension (Service) along with the - Keystone - OpenStack Identity - (API). - - - - - 2011-09-13 - - - - - Initial release. - - - - - - - - - Summary of Changes - - Rackspace extensions to Keystone v2.0 API allows authenticate call to also return information about group memberships of the user. - -
- New Headers - None. -
-
- New Faults - None. -
-
- New Resources - None. -
-
- New Actions - None. -
-
- New Elements -
- Rackspace extensions to Keystone v2.0 API enabling groups. -
- New Elements - - This extension starts returning groups as a part of response when an authenticate call is made. - The samples of new elements that are defined as a part of this extension are listed below. - - - Groups Sample XML - - - - Groups Sample JSON - - -
-
- RAX-KSGRP Extension API Operations - - - - - - - - - - - - - - - - - -
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
- - Following operations are the list of operations whose behavior is altered by Rackspace API Groups Service Extension: -
- User Operations - - - - - -
-
-
-
-
-
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-admin-devguide.xml b/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-admin-devguide.xml deleted file mode 100644 index a4b76076..00000000 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-admin-devguide.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - - - - Verb - URI - Description - - '> - - -]> - - - OpenStack Identity Rackspace API Key Authentication Extension (Admin Operations) - RAX-KSKEY (Admin) - - - - - - - - Rackspace Cloud - - - - 2011 - Rackspace US, Inc. - - OpenStack Identity - &PUB_DATE; - - - Copyright details are filled in by the template. - - - - - Joe - Savak - - joe.savak@RACKSPACE.COM - - - - Rackspace extensions to Keystone v2.0 API - enabling API Key authentication. - - - - - - - This document is intended for service developers interested - in using the Rackspace API Key Authentication Admin Extension along with the - Keystone - OpenStack Identity - (API). - - - - - 2011-09-13 - - - - - Initial release. - - - - - - - - - - Summary of Changes - - The Rackspace API Key Authentication Admin Extension allows crud/listing operations on apikeyCredentials. - -
- New Headers - None. -
-
- New Faults - None. -
-
- New Resources - None. -
-
- New Actions - None. -
-
- New Element -
- apikeyCredentials - This extension allows authentication calls to accept new type of credentials apikeyCredentials. - These are additional type of credentials defined to support rackspace style authentication. - Examples of apikeyCredentials are illustrated below - - - apikeyCredentials XML - - - - apikeyCredentials JSON - - -
-
- -
- RAX-KSKEY-admin Extension API Operations - - - - - - - - - - - - - - - - - -
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
- - Following operations are the list of operations whose behavior is altered by Rackspace API Key Authentication Extension: -
- User Operations - - - - - - - - - - - -
-
-
-
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-service-devguide.xml b/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-service-devguide.xml deleted file mode 100644 index 3a53dc7c..00000000 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-service-devguide.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - - - - Verb - URI - Description - - '> - - - - - - -]> - - - OpenStack Identity Rackspace API Key Authentication Extension (Service Operations) - RAX-KSKEY (Service) - - - - - - - - Rackspace Cloud - - - - 2011 - Rackspace US, Inc. - - OpenStack Identity - &PUB_DATE; - - - Copyright details are filled in by the template. - - - - - This document is intended for client developers interested - in using the Rackspace API Key Authentication Service Extension along with the - Keystone - OpenStack Identity - (API). - - - - - Joe - Savak - - joe.savak@RACKSPACE.COM - - - - Rackspace extensions to Keystone v2.0 API - enabling API Key authentication. - - - - - - - - - 2011-08-24 - - - - - Initial release. - - - - - - - - - Summary of Changes - - The Rackspace API Key Authentication Service Extension allows authenticate call to happen using apikeyCredentials. - -
- New Headers - None. -
-
- New Faults - None. -
-
- New Resources - None. -
-
- New Actions - None. -
-
- New Element -
- - Rackspace extensions to Keystone v2.0 API enabling API Key authentication. - -
- Authenticate - This extension allows authentication calls to accept new type of credentials apikeyCredentials. - These are additional type of credentials defined to support rackspace style authentication. - The usage of apikeyCredentials on a existing call to authenticate is illustrated below. - - - &URI_REFHEAD; - - - &POST; - /tokens - Authenticate to generate a token. - - - - &CODES;200, 203 - &ERROR_CODES; unauthorized (401), userDisabled - (403), badRequest (400), identityFault - (500), serviceUnavailable(503) - - This call will return a token if successful. - Clients obtain - this token, along with the URL to other service APIs, by first authenticating against the - Keystone Service and supplying valid credentials. - This extension provides support for Rackspace Style API Key credentials. - - - 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. - - - The Keystone Service is a ReSTful web service. It is the entry point to all service APIs. - To access the Keystone Service, you must know URL of the Keystone service. - - - XML Auth Request using apikeyCredentials - - - - JSON Auth Request using apikeyCredentials - - - - XML Auth Response - - - - JSON Auth Response - - -
-
-
-
-
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/RAX-KSQA-admin-devguide.xml b/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/RAX-KSQA-admin-devguide.xml deleted file mode 100644 index 8dcf5d9e..00000000 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/RAX-KSQA-admin-devguide.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - - GET'> - PUT'> - POST'> - DELETE'> - - - - - - '> - - - - - - - - - Verb - URI - Description - - '> - - -]> - - - OpenStack Identity Rackspace API Secret Question and Answer (Admin Operations) - RAX-KSQA (Admin) - - - - - - - - Rackspace Cloud - - - - 2011 - Rackspace US, Inc. - - OpenStack Identity - 2012-01-23 - - - Copyright details are filled in by the template. - - - - - This document is intended for client developers interested - in using the Rackspace API Secret Question and Answer Extension. - - - - - Joe - Savak - - joe.savak@RACKSPACE.COM - - - Allows the management of a User's Secret Question and Answer. - - - - - 2011-01-23 - - - - - Initial release. - - - - - - - - - Summary of Changes - - The Rackspace API Secret Question and Answer Extension - allows the management of a User's Secret Question and - Answer. - -
- New Headers - None. -
-
- New Faults - None. -
-
- New Resources - None. -
-
- New Actions - None. -
-
- New Element -
- secretQA - - A secretQA element is added that - allows the management of a user's secret question and - answer. - - - secretQA XML - - - - secretQA JSON - - -
-
- -
- RAX-KSQA Extension API Operations - - - - - - - - - - - - - - - - - -
Authentication Header
Header TypeNameValue
HTTP/1.1 RequestX-Auth-Tokentxfa8426a08eaf
- - Following operations are the list of operations supported by Rackspace Secret Question and Answer Extension: -
- User Operations - - - - -
-
-
-
diff --git a/openstack-identity-api/src/docbkx/common/img/Check_mark_23x20_02.svg b/openstack-identity-api/src/docbkx/img/Check_mark_23x20_02.svg similarity index 100% rename from openstack-identity-api/src/docbkx/common/img/Check_mark_23x20_02.svg rename to openstack-identity-api/src/docbkx/img/Check_mark_23x20_02.svg diff --git a/openstack-identity-api/src/docbkx/common/js/shjs/sh_java.js b/openstack-identity-api/src/docbkx/js/shjs/sh_java.js similarity index 100% rename from openstack-identity-api/src/docbkx/common/js/shjs/sh_java.js rename to openstack-identity-api/src/docbkx/js/shjs/sh_java.js diff --git a/openstack-identity-api/src/docbkx/common/js/shjs/sh_javascript.js b/openstack-identity-api/src/docbkx/js/shjs/sh_javascript.js similarity index 100% rename from openstack-identity-api/src/docbkx/common/js/shjs/sh_javascript.js rename to openstack-identity-api/src/docbkx/js/shjs/sh_javascript.js diff --git a/openstack-identity-api/src/docbkx/common/js/shjs/sh_main.js b/openstack-identity-api/src/docbkx/js/shjs/sh_main.js similarity index 100% rename from openstack-identity-api/src/docbkx/common/js/shjs/sh_main.js rename to openstack-identity-api/src/docbkx/js/shjs/sh_main.js diff --git a/openstack-identity-api/src/docbkx/common/js/shjs/sh_xml.js b/openstack-identity-api/src/docbkx/js/shjs/sh_xml.js similarity index 100% rename from openstack-identity-api/src/docbkx/common/js/shjs/sh_xml.js rename to openstack-identity-api/src/docbkx/js/shjs/sh_xml.js diff --git a/openstack-identity-api/src/docbkx/common/js/trc/schema/controller.js b/openstack-identity-api/src/docbkx/js/trc/schema/controller.js similarity index 100% rename from openstack-identity-api/src/docbkx/common/js/trc/schema/controller.js rename to openstack-identity-api/src/docbkx/js/trc/schema/controller.js diff --git a/openstack-identity-api/src/docbkx/common/js/trc/schema/layoutManager.js b/openstack-identity-api/src/docbkx/js/trc/schema/layoutManager.js similarity index 100% rename from openstack-identity-api/src/docbkx/common/js/trc/schema/layoutManager.js rename to openstack-identity-api/src/docbkx/js/trc/schema/layoutManager.js diff --git a/openstack-identity-api/src/docbkx/common/js/trc/schema/sampleManager.js b/openstack-identity-api/src/docbkx/js/trc/schema/sampleManager.js similarity index 100% rename from openstack-identity-api/src/docbkx/common/js/trc/schema/sampleManager.js rename to openstack-identity-api/src/docbkx/js/trc/schema/sampleManager.js diff --git a/openstack-identity-api/src/docbkx/common/js/trc/util.js b/openstack-identity-api/src/docbkx/js/trc/util.js similarity index 100% rename from openstack-identity-api/src/docbkx/common/js/trc/util.js rename to openstack-identity-api/src/docbkx/js/trc/util.js diff --git a/openstack-identity-api/src/docbkx/common/samples/auth.json b/openstack-identity-api/src/docbkx/samples/auth.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/auth.json rename to openstack-identity-api/src/docbkx/samples/auth.json diff --git a/openstack-identity-api/src/docbkx/common/samples/auth.xml b/openstack-identity-api/src/docbkx/samples/auth.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/auth.xml rename to openstack-identity-api/src/docbkx/samples/auth.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/auth_credentials.json b/openstack-identity-api/src/docbkx/samples/auth_credentials.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/auth_credentials.json rename to openstack-identity-api/src/docbkx/samples/auth_credentials.json diff --git a/openstack-identity-api/src/docbkx/common/samples/auth_credentials.xml b/openstack-identity-api/src/docbkx/samples/auth_credentials.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/auth_credentials.xml rename to openstack-identity-api/src/docbkx/samples/auth_credentials.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/auth_with_token.json b/openstack-identity-api/src/docbkx/samples/auth_with_token.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/auth_with_token.json rename to openstack-identity-api/src/docbkx/samples/auth_with_token.json diff --git a/openstack-identity-api/src/docbkx/common/samples/auth_with_token.xml b/openstack-identity-api/src/docbkx/samples/auth_with_token.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/auth_with_token.xml rename to openstack-identity-api/src/docbkx/samples/auth_with_token.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/choices.json b/openstack-identity-api/src/docbkx/samples/choices.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/choices.json rename to openstack-identity-api/src/docbkx/samples/choices.json diff --git a/openstack-identity-api/src/docbkx/common/samples/choices.xml b/openstack-identity-api/src/docbkx/samples/choices.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/choices.xml rename to openstack-identity-api/src/docbkx/samples/choices.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/endpoints.json b/openstack-identity-api/src/docbkx/samples/endpoints.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/endpoints.json rename to openstack-identity-api/src/docbkx/samples/endpoints.json diff --git a/openstack-identity-api/src/docbkx/common/samples/endpoints.xml b/openstack-identity-api/src/docbkx/samples/endpoints.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/endpoints.xml rename to openstack-identity-api/src/docbkx/samples/endpoints.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/ext-getuser.json b/openstack-identity-api/src/docbkx/samples/ext-getuser.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/ext-getuser.json rename to openstack-identity-api/src/docbkx/samples/ext-getuser.json diff --git a/openstack-identity-api/src/docbkx/common/samples/ext-getuser.xml b/openstack-identity-api/src/docbkx/samples/ext-getuser.xml similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/ext-getuser.xml rename to openstack-identity-api/src/docbkx/samples/ext-getuser.xml diff --git a/openstack-identity-api/src/docbkx/common/samples/extension.json b/openstack-identity-api/src/docbkx/samples/extension.json similarity index 100% rename from openstack-identity-api/src/docbkx/common/samples/extension.json rename to openstack-identity-api/src/docbkx/samples/extension.json diff --git a/openstack-identity-api/src/docbkx/common/samples/extension.xml b/openstack-identity-api/src/docbkx/samples/extension.xml similarity index 92% rename from openstack-identity-api/src/docbkx/common/samples/extension.xml rename to openstack-identity-api/src/docbkx/samples/extension.xml index 97eac737..af2ed311 100644 --- a/openstack-identity-api/src/docbkx/common/samples/extension.xml +++ b/openstack-identity-api/src/docbkx/samples/extension.xml @@ -8,7 +8,7 @@ updated="2011-01-12T11:22:33-06:00"> - Allows associating arbritrary metadata with a user. + Allows associating arbitrary metadata with a user. - Allows associating arbritrary metadata with a user. + Allows associating arbitrary metadata with a user. + %common; ]> @@ -20,8 +20,8 @@ xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"> - - + + @@ -54,7 +54,7 @@

- Check that a token is valid and that it belongs to a supplied tenant + Checks that a token is valid and that it belongs to a supplied tenant and services and return the permissions relevant to a particular client.

@@ -89,12 +89,12 @@ - + - + @@ -104,7 +104,7 @@

- Check that a token is valid and that it belongs to a particular tenant and services + Checks that a token is valid and that it belongs to a particular tenant and services (For performance).

@@ -137,7 +137,7 @@

- Check the roles against the given service IDs. + Checks the roles against the given service IDs.

diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/OS-KSADM-admin.wadl b/openstack-identity-api/src/docbkx/wadl/OS-KSADM-admin.wadl similarity index 51% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/OS-KSADM-admin.wadl rename to openstack-identity-api/src/docbkx/wadl/OS-KSADM-admin.wadl index b8848c89..b04dce10 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/OS-KSADM-admin.wadl +++ b/openstack-identity-api/src/docbkx/wadl/OS-KSADM-admin.wadl @@ -1,5 +1,5 @@ - + @@ -8,27 +8,27 @@ + %common; ]> - - - + + + @@ -37,22 +37,27 @@ - + You need a valid admin token for access. - + - - - + + + @@ -64,11 +69,16 @@ - + - - + + @@ -81,24 +91,35 @@ - + - - - - - - - - + + + + + + + + - + @@ -108,7 +129,8 @@ - + @@ -118,7 +140,8 @@ - + @@ -135,649 +158,630 @@

- Creates a tenant. -

-

This call creates a tenant.

+ Creates a tenant.

+

Creates + a tenant.

- + - + - + - + - + - + - - &commonFaults; - &postPutFaults; -
+ &commonFaults; &postPutFaults;

- Updates a tenant. -

-

This call updates a tenant.

+ Updates a tenant.

+

Updates + a tenant.

- + - + - + - + - + - + - - &commonFaults; - &getFaults; - &postPutFaults; -
+ &commonFaults; &getFaults; &postPutFaults;

- Deletes a tenant. -

-

This call deletes a tenant.

+ Deletes a tenant.

+

Deletes + a tenant.

- - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults;
-

Lists all the users for a tenant.

-

Lists all the users for a tenant.

- +

Lists all the users for a tenant.

+

Lists all the + users for a tenant.

- - + + - + - + - + - - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults;
-

Adds a specific role to a user for a tenant.

+

Adds a specific + role to a user for a tenant.

- - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; + &getFaults;
-

Deletes a specific role from a user for a tenant.

+

Deletes a specified + role from a user for a tenant.

- - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults;
-

List users.

+

Lists users.

- + - + - + - - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults;

Adds a user.

- + - + - + - + - + - + - + - - &commonFaults; - &getFaults; - &postPutFaults; -
+ &commonFaults; &getFaults; &postPutFaults;
-

Update a user.

+

Updates a user.

- + - + - + - + - + - + - - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; &getFaults;
-

Delete a user.

+

Deletes a user.

- - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults;
-

Enable user.

+

Enables user.

- + - + - + + - + - + - + - + - - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; &getFaults;
-

List global roles for a user.

+

Lists global roles + for a user.

- + - + - + - + - - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults;
-

Adds a specific global role to a user.

+

Adds a specific + global role to a user.

- - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; + &getFaults;
-

Deletes a specific global role from a user.

+

Deletes a specific + global role from a user.

- - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults;
-

Adds a credential to a user.

+

Adds a credential + to a user.

- + - + - + - + - + - + - - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; &getFaults;
-

List credentials.

+

Lists + credentials.

- - + + - + - + - + - - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults;
-

Update credentials.

+

Updates + credentials.

- + - + - + - + - + - + - - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; &getFaults; -

Delete User credentials.

+

Deletes user + credentials.

- - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; + &getFaults; -

Get user credentials.

+

Gets user + credentials.

- + - + - + - - &commonFaults; - &getFaults; -
+
&commonFaults; &getFaults; -

List roles.

+

Lists roles.

- - - + + + - + - + - + - - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults; -

Add a Role.

+

Adds a role.

- + - + - + - + - + - + - + - + - - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; &getFaults; -

Get a role by name.

+

Gets a role by + name.

- + - + - + - + - + - + - - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; &getFaults; -

Get a role.

+

Gets a role.

- + - + - + - + - + - - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; &getFaults; -

Delete a role.

+

Deletes a role.

- - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults; -

List services.

+

Lists services.

- - + + - + - + - + - - &commonFaults; - &getFaults; -
+
&commonFaults; &getFaults; -

Get a service by name.

+

Gets a service by + name.

- + - + - + - + - - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults; -

Get a service.

+

Gets a service.

- + - + - + - - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults; -

Add a service.

+

Adds a service.

- + - + - + - + - + - + - + - + - - &commonFaults; - &postPutFaults; - &getFaults; -
+ &commonFaults; &postPutFaults; &getFaults; -

Delete a service.

+

Deletes a + service.

- - &commonFaults; - &getFaults; -
+ &commonFaults; &getFaults; diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/OS-KSCATALOG-admin.wadl b/openstack-identity-api/src/docbkx/wadl/OS-KSCATALOG-admin.wadl similarity index 83% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/OS-KSCATALOG-admin.wadl rename to openstack-identity-api/src/docbkx/wadl/OS-KSCATALOG-admin.wadl index cbf1c417..d5a4c3ea 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/OS-KSCATALOG-admin.wadl +++ b/openstack-identity-api/src/docbkx/wadl/OS-KSCATALOG-admin.wadl @@ -1,5 +1,5 @@ - + @@ -8,27 +8,27 @@ + %common; ]> - - - + + + @@ -89,12 +89,12 @@ - + - + @@ -109,12 +109,12 @@ - + - + @@ -129,25 +129,25 @@ - + - + - + - + @@ -164,24 +164,24 @@ - + - + - + - + @@ -206,27 +206,27 @@ - + - + - + - + @@ -243,12 +243,12 @@ - + - + @@ -263,12 +263,12 @@ - + - + diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-admin.wadl b/openstack-identity-api/src/docbkx/wadl/OS-KSEC2-admin.wadl similarity index 79% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-admin.wadl rename to openstack-identity-api/src/docbkx/wadl/OS-KSEC2-admin.wadl index b330159b..5b7e04bc 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/OS-KSEC2-admin.wadl +++ b/openstack-identity-api/src/docbkx/wadl/OS-KSEC2-admin.wadl @@ -1,5 +1,5 @@ - + @@ -8,27 +8,27 @@ + %common; ]> - - - + + + @@ -49,6 +49,7 @@ + @@ -72,24 +73,24 @@ - + - + - + - + @@ -100,7 +101,7 @@ -

List credentials.

+

Lists credentials.

@@ -109,12 +110,12 @@ - + - + @@ -124,7 +125,7 @@ -

List credentials by type.

+

Lists credentials by type.

@@ -148,29 +149,29 @@ -

Update credentials.

+

Updates credentials.

- + - + - + - + @@ -181,7 +182,7 @@ -

Delete User credentials.

+

Deletes user credentials.

&commonFaults; @@ -191,17 +192,17 @@ -

Get user credentials.

+

Gets user credentials.

- + - + diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/OS-KSS3-admin.wadl b/openstack-identity-api/src/docbkx/wadl/OS-KSS3-admin.wadl similarity index 78% rename from openstack-identity-api/src/docbkx/extensions/OS-KSS3/OS-KSS3-admin.wadl rename to openstack-identity-api/src/docbkx/wadl/OS-KSS3-admin.wadl index 08dc3953..477eee24 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/OS-KSS3-admin.wadl +++ b/openstack-identity-api/src/docbkx/wadl/OS-KSS3-admin.wadl @@ -1,5 +1,5 @@ - + @@ -8,27 +8,27 @@ + %common; ]> - - - + + + @@ -43,7 +43,7 @@ - + @@ -71,24 +71,24 @@ - + - + - + - + @@ -99,7 +99,7 @@ -

List credentials.

+

Lists credentials.

@@ -108,12 +108,12 @@ - + - + @@ -123,7 +123,7 @@ -

List credentials by type.

+

Lists credentials by type.

@@ -132,12 +132,12 @@ - + - + @@ -147,29 +147,29 @@ -

Update credentials.

+

Updates credentials.

- + - + - + - + @@ -180,7 +180,7 @@ -

Delete User credentials.

+

Deletes user credentials.

&commonFaults; @@ -190,17 +190,17 @@ -

Get user credentials.

+

Gets user credentials.

- + - + diff --git a/openstack-identity-api/src/docbkx/wadl/OS-KSVALIDATE-admin.wadl b/openstack-identity-api/src/docbkx/wadl/OS-KSVALIDATE-admin.wadl new file mode 100644 index 00000000..43d7deca --- /dev/null +++ b/openstack-identity-api/src/docbkx/wadl/OS-KSVALIDATE-admin.wadl @@ -0,0 +1,198 @@ + + + + + + + + + + %common; +]> + + + + + + + + + + + + + + + + + + + + You need a valid admin token for + access. + + + You need to supply a token to + validate. + + + + + + + + + + You need a valid admin token for + access. + + + You need to supply a token to + validate. + + + + + + + + + + + + + + + + +

+ Check that a token is valid and that it belongs to a + supplied tenant and services and return the + permissions relevant to a particular client.

+

Behavior is + similar to /tokens/{tokenId}. In other + words, a user should expect an itemNotFound + (404) fault for an invalid token.

+

'X-Subject-Token' + may be encrypted, but can still be used for caching. + This extension may decrypt this header and internally + call the Identity Service's normal validation, passing + along all headers and query parameters. It should + therefore support all existing calls on + /tokens/{tokenId}, including + extensions such as HP-IDM.

+
+ + + +

Validates + a token has the supplied tenant in scope.

+
+ + + +

If + provided, filters the roles to be returned by + the given service IDs.

+
+ +
+ + + + + + + + + + + + &commonFaults; &getFaults;
+ + +

+ Checks that a token is valid and that it belongs to a + particular tenant and services (For performance).

+

Behavior is + similar to /tokens/{tokenId}. A user + should expect an itemNotFound (404) fault + for an invalid token.

+

'X-Subject-Token' + may be encrypted, but can still be used for caching. + This extension may decrypt this header and internally + call the Identity Service's normal validation, passing + along all headers and query parameters. It should + therefore support all existing calls on + /tokens/{tokenId}, including + extensions such as HP-IDM.

+

No response body + is returned for this method.

+
+ + + +

Validates + a token has the supplied tenant in scope. (for + performance).

+
+ + + +

Checks + the roles against the given service IDs.

+
+ +
+ &commonFaults; &getFaults;
+ + +

Returns a list of + endpoints associated with a specific token.

+
+ + + + + + + + + + + + &commonFaults; &getFaults;
+ +
diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/RAX-GRPADM.wadl b/openstack-identity-api/src/docbkx/wadl/RAX-GRPADM.wadl similarity index 75% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/RAX-GRPADM.wadl rename to openstack-identity-api/src/docbkx/wadl/RAX-GRPADM.wadl index 34e1d8b9..d64f62c2 100644 --- a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/RAX-GRPADM.wadl +++ b/openstack-identity-api/src/docbkx/wadl/RAX-GRPADM.wadl @@ -7,7 +7,7 @@ + %common; ]> @@ -20,7 +20,7 @@ xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"> - + @@ -29,30 +29,31 @@ - +

A valid authentication token. - +

- +

A unique identifier for the group. - +

+ - +

A unique identifier for the user. - +

@@ -67,18 +68,18 @@ - +

A list of users. - +

- +

A list of groups. - +

@@ -86,14 +87,14 @@ - +

List of groups. - - +

+

Displays a list of available groups. You can use the - name to display only + name to display only those groups matching a particular name. - +

@@ -103,7 +104,7 @@ - + @@ -116,7 +117,7 @@ - + @@ -125,14 +126,14 @@
- - Add a new group. - +

+ Adds a group. +

- + - + @@ -148,21 +149,21 @@ - +

The full URL to the newly created group is - returned via the Loctaton + returned via the Loctaton header. - +

- + - +
@@ -172,19 +173,19 @@
- +

Get group by id. - +

- + - + @@ -194,14 +195,14 @@
- - Update a group. - +

+ Updates a group. +

- + - + - + - + @@ -231,9 +232,9 @@
- - Delete a group. - +

+ Deletes a group. +

@@ -242,12 +243,12 @@
- - List users for group. - - - A list of users belonging to a particular group. - +

+ Lists users for group. +

+

+ A list of users that belong to a specified group. +

@@ -256,7 +257,7 @@ - + @@ -269,7 +270,7 @@ - + @@ -278,9 +279,9 @@
- - Add a user to the group. - +

+ Adds a user to a group. +

@@ -289,9 +290,9 @@
- - Remove a user to the group. - +

+ Removes a user from a group. +

diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/RAX-KSGRP.wadl b/openstack-identity-api/src/docbkx/wadl/RAX-KSGRP.wadl similarity index 80% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/RAX-KSGRP.wadl rename to openstack-identity-api/src/docbkx/wadl/RAX-KSGRP.wadl index fe973ab1..b767c039 100644 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/RAX-KSGRP.wadl +++ b/openstack-identity-api/src/docbkx/wadl/RAX-KSGRP.wadl @@ -1,5 +1,5 @@ - + @@ -8,26 +8,26 @@ + %common; ]> - - - + + + @@ -58,12 +58,12 @@ - + - + diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-admin.wadl b/openstack-identity-api/src/docbkx/wadl/RAX-KSKEY-admin.wadl similarity index 77% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-admin.wadl rename to openstack-identity-api/src/docbkx/wadl/RAX-KSKEY-admin.wadl index 9be79a9b..0b57e7eb 100644 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/RAX-KSKEY-admin.wadl +++ b/openstack-identity-api/src/docbkx/wadl/RAX-KSKEY-admin.wadl @@ -1,5 +1,5 @@ - + @@ -8,27 +8,27 @@ + %common; ]> - - - + + + @@ -43,7 +43,7 @@ - + @@ -71,24 +71,24 @@ - + - + - + - + @@ -99,7 +99,7 @@ -

List credentials.

+

Lists credentials.

@@ -108,12 +108,12 @@ - + - + @@ -123,29 +123,29 @@ -

Update credentials.

+

Updates credentials.

- + - + - + - + @@ -156,7 +156,7 @@ -

Delete User credentials.

+

Deletes user credentials.

&commonFaults; @@ -166,17 +166,17 @@ -

Get user credentials.

+

Gets user credentials.

- + - + diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/RAX-KSQA-admin.wadl b/openstack-identity-api/src/docbkx/wadl/RAX-KSQA-admin.wadl similarity index 79% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSQA/RAX-KSQA-admin.wadl rename to openstack-identity-api/src/docbkx/wadl/RAX-KSQA-admin.wadl index 99b42b13..e2d90cc0 100644 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/RAX-KSQA-admin.wadl +++ b/openstack-identity-api/src/docbkx/wadl/RAX-KSQA-admin.wadl @@ -1,5 +1,5 @@ - + @@ -8,7 +8,7 @@ + %common; ]> - - - + + + @@ -60,12 +60,12 @@ - + - + @@ -79,24 +79,24 @@ - + - + - + - + diff --git a/openstack-identity-api/src/docbkx/common/common.ent b/openstack-identity-api/src/docbkx/wadl/common.ent similarity index 100% rename from openstack-identity-api/src/docbkx/common/common.ent rename to openstack-identity-api/src/docbkx/wadl/common.ent diff --git a/openstack-identity-api/src/docbkx/wadl/identity-admin.wadl b/openstack-identity-api/src/docbkx/wadl/identity-admin.wadl new file mode 100644 index 00000000..c5a9a5bc --- /dev/null +++ b/openstack-identity-api/src/docbkx/wadl/identity-admin.wadl @@ -0,0 +1,499 @@ + + + + + + + + + + %common; +]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + You need a valid admin token for + access. + + + + + + + + + + + + + + You need a valid admin token for + access. + + + + + + + + + + + + + + + +

You + need a valid admin token for access.

+
+ + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + + +

A list of + supported extensions.

+
+ +
+ + + + + + + + + +

Returns detailed + information about a specified version of the API.

+
+ + + + + + + + &commonFaults; &getFaults;
+ + + + + +

Lists supported + extensions.

+
+ + + + + + + + + + + &commonFaults;
+ + +

Gets details + about a specific extension.

+
+ + + + &commonFaults; &getFaults;
+ + + + + +

+ Authenticate to generate a token.

+

This call will + return a token if successful. Each REST request + against other services (or other calls on the Identity + Service such as the GET /tenants call) requires the + inclusion of a specific authorization token HTTP + x-header, defined as X-Auth-Token. Clients obtain this + token, along with the URL to other service APIs, by + first authenticating against the Identity Service and + supplying valid credentials.

+

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.

+

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.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + &commonFaults; &getFaults;
+ + +

+ Check that a token is valid and that it belongs to a + supplied tenant and return the permissions relevant to + a particular client.

+

Valid tokens will + exist in the /tokens/{tokenId} path and + invalid tokens will not. In other words, a user should + expect an itemNotFound (404) fault for an + invalid token.

+
+ + + +

Validates + a token has the supplied tenant in scope.

+
+ +
+ + + + + + + + + + + + &commonFaults; &getFaults;
+ + +

+ Check that a token is valid and that it belongs to a + particular tenant (For performance).

+
+ + + +

Validates + a token has the supplied tenant in scope. (for + performance).

+

Valid + tokens will exist in the + /tokens/{tokenId} path and + invalid tokens will not. In other words, a + user should expect an itemNotFound + (404) fault for an invalid + token.

+

If + `belongsTo` is provided, validates that a + token has a specific tenant in scope.

+

No + response body is returned for this method. +

+
+ +
+ &commonFaults; &getFaults;
+ + + + +

Returns detailed + information about a specific user, by user name.

+
+ + + + + + + + + + + + + + + &commonFaults; &getFaults;
+ + +

Returns detailed + information about a specific user, by user id.

+
+ + + + + + + + + + + + &commonFaults; &getFaults;
+ + +

+ Returns global roles for a specific user (excludes + tenant roles).

+

Returns a list of + global roles associated with a specific user (excludes + tenant roles).

+
+ + + + + + + + + + + + &commonFaults; &getFaults;
+ + + + + +

+ Gets a list of tenants.

+

Returns a list of + tenants to which the specified token has access. This + call must be authenticated, so a valid token must be + passed in as a header.

+ + + + + +
+ + + + + + + + + + + + + + + + &commonFaults; &getFaults;
+ + +

+ Returns detailed information about a tenant, by name. +

+
+ + + + + + + + + + + + + + + &commonFaults; &getFaults;
+ + +

+ Returns detailed information about a tenant, by ID. +

+
+ + + + + + + + + + + + &commonFaults; &getFaults;
+ + +

Returns a list of + endpoints associated with a specific token.

+
+ + + + + + + + + + + + &commonFaults; &getFaults;
+ + + +

Returns roles for + a specific user on a specific tenant (excludes global + roles).

+
+ + + + + + + + + + + + &commonFaults; &getFaults;
+
diff --git a/openstack-identity-api/src/docbkx/common/identity.wadl b/openstack-identity-api/src/docbkx/wadl/identity.wadl similarity index 52% rename from openstack-identity-api/src/docbkx/common/identity.wadl rename to openstack-identity-api/src/docbkx/wadl/identity.wadl index af91304a..1f775e02 100644 --- a/openstack-identity-api/src/docbkx/common/identity.wadl +++ b/openstack-identity-api/src/docbkx/wadl/identity.wadl @@ -1,5 +1,5 @@ - + @@ -13,20 +13,20 @@ ]> - - + + @@ -36,9 +36,11 @@ - + - + @@ -60,9 +62,8 @@ -

- A list of supported extensions. -

+

A list of + supported extensions.

@@ -75,108 +76,109 @@ -

- Returns detailed information about this specific version of the API. +

Returns detailed + information about this specific version of the API.

- - + + - - &commonFaults; - &getFaults; -
+
&commonFaults; &getFaults;
-

List all available extensions.

+

Lists + available extensions.

- - + + - - + + - - &commonFaults; - &getFaults; -
+
&commonFaults; &getFaults;
-

Get details about a specific extension.

+

Gets details about + a specified extension.

- + - - &commonFaults; - &getFaults; -
+
&commonFaults; &getFaults;
-

- 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. See supported credentials -

-

- Each ReST request against the Keystone system requires the inclusion of a - specific authorization token HTTP x-header, defined as X-Auth-Token. Clients obtain - this token, along with the URL to other service APIs, by first authenticating against the - Keystone Service and supplying valid credentials. -

-

- The Keystone Service is a ReSTful web service. It is the entry point to all service APIs. - To access the Keystone Service, you must know URL of the Keystone service. + xmlns="http://www.w3.org/1999/xhtml"> +

Client authentication is provided + through a ReST interface by using the POST method, + with v2.0/tokens supplied as the path. A payload of + credentials must be included in the body. See supported + credentials.

+

Each ReST request against the Identity Service + requires the inclusion of a specific authorization + token HTTP x-header, defined as X-Auth-Token. Clients + obtain this token, along with the URL to other service + APIs, by first authenticating against the Identity + Service and supplying valid credentials.

+

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.

- + - + - + - - &commonFaults; - &getFaults; -
+
&commonFaults; &getFaults; -

- Returns a list of tenants. -

+

Returns a list of tenants.

- - + + - + - - &commonFaults; - &getFaults; -
+
&commonFaults; &getFaults;
diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/xsd/OS-KSADM.xsd b/openstack-identity-api/src/docbkx/xsd/OS-KSADM.xsd similarity index 96% rename from openstack-identity-api/src/docbkx/extensions/OS-KSADM/xsd/OS-KSADM.xsd rename to openstack-identity-api/src/docbkx/xsd/OS-KSADM.xsd index bf2686c1..8ab48ee0 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSADM/xsd/OS-KSADM.xsd +++ b/openstack-identity-api/src/docbkx/xsd/OS-KSADM.xsd @@ -1,7 +1,7 @@ - + + schemaLocation="atom/atom.xsd" /> + schemaLocation="api.xsd" /> diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/xsd/OS-KSCATALOG.xsd b/openstack-identity-api/src/docbkx/xsd/OS-KSCATALOG.xsd similarity index 95% rename from openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/xsd/OS-KSCATALOG.xsd rename to openstack-identity-api/src/docbkx/xsd/OS-KSCATALOG.xsd index 12113a92..64af9ca0 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSCATALOG/xsd/OS-KSCATALOG.xsd +++ b/openstack-identity-api/src/docbkx/xsd/OS-KSCATALOG.xsd @@ -1,7 +1,7 @@ - + + schemaLocation="atom/atom.xsd" /> + schemaLocation="api.xsd" /> @@ -28,7 +28,7 @@ xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">

- A list of Endpoint Templates. + A list of endpoint templates.

@@ -40,7 +40,7 @@ xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">

- An Endpoint Template. + An endpoint template.

@@ -69,7 +69,7 @@ xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">

- An ID uniquely identifying the Endpoint Template. + An ID uniquely identifying the endpoint template.

diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/xsd/OS-KSEC2-credentials.xsd b/openstack-identity-api/src/docbkx/xsd/OS-KSEC2-credentials.xsd similarity index 95% rename from openstack-identity-api/src/docbkx/extensions/OS-KSEC2/xsd/OS-KSEC2-credentials.xsd rename to openstack-identity-api/src/docbkx/xsd/OS-KSEC2-credentials.xsd index cd1c4dc9..af3a3e64 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSEC2/xsd/OS-KSEC2-credentials.xsd +++ b/openstack-identity-api/src/docbkx/xsd/OS-KSEC2-credentials.xsd @@ -15,7 +15,7 @@ > + schemaLocation="credentials.xsd"/> diff --git a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/xsd/OS-KSS3-credentials.xsd b/openstack-identity-api/src/docbkx/xsd/OS-KSS3-credentials.xsd similarity index 95% rename from openstack-identity-api/src/docbkx/extensions/OS-KSS3/xsd/OS-KSS3-credentials.xsd rename to openstack-identity-api/src/docbkx/xsd/OS-KSS3-credentials.xsd index a000ca94..70071b72 100644 --- a/openstack-identity-api/src/docbkx/extensions/OS-KSS3/xsd/OS-KSS3-credentials.xsd +++ b/openstack-identity-api/src/docbkx/xsd/OS-KSS3-credentials.xsd @@ -15,7 +15,7 @@ > + schemaLocation="credentials.xsd"/> diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/xsd/RAX-GRPADM.xsd b/openstack-identity-api/src/docbkx/xsd/RAX-GRPADM.xsd similarity index 91% rename from openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/xsd/RAX-GRPADM.xsd rename to openstack-identity-api/src/docbkx/xsd/RAX-GRPADM.xsd index c43576cb..aadc0a29 100644 --- a/openstack-identity-api/src/docbkx/extensions/RAX-GRPADM/xsd/RAX-GRPADM.xsd +++ b/openstack-identity-api/src/docbkx/xsd/RAX-GRPADM.xsd @@ -10,13 +10,13 @@ xmlns:atom="http://www.w3.org/2005/Atom" targetNamespace="http://docs.rackspace.com/identity/api/ext/RAX-KSGRP/v1.0" > - + + schemaLocation="atom/atom.xsd"/> + schemaLocation="api.xsd"/> diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/xsd/RAX-KSGRP-groups.xsd b/openstack-identity-api/src/docbkx/xsd/RAX-KSGRP-groups.xsd similarity index 94% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/xsd/RAX-KSGRP-groups.xsd rename to openstack-identity-api/src/docbkx/xsd/RAX-KSGRP-groups.xsd index 3fda83b3..f1273386 100644 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSGRP/xsd/RAX-KSGRP-groups.xsd +++ b/openstack-identity-api/src/docbkx/xsd/RAX-KSGRP-groups.xsd @@ -15,10 +15,10 @@ > + schemaLocation="api.xsd"/> + schemaLocation="atom/atom.xsd"/> diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/xsd/RAX-KSKEY-credentials.xsd b/openstack-identity-api/src/docbkx/xsd/RAX-KSKEY-credentials.xsd similarity index 97% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/xsd/RAX-KSKEY-credentials.xsd rename to openstack-identity-api/src/docbkx/xsd/RAX-KSKEY-credentials.xsd index ed9dcb4d..13c83c33 100644 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSKEY/xsd/RAX-KSKEY-credentials.xsd +++ b/openstack-identity-api/src/docbkx/xsd/RAX-KSKEY-credentials.xsd @@ -15,7 +15,7 @@ > + schemaLocation="credentials.xsd"/> diff --git a/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/xsd/RAX-KSQA-secretQA.xsd b/openstack-identity-api/src/docbkx/xsd/RAX-KSQA-secretQA.xsd similarity index 97% rename from openstack-identity-api/src/docbkx/extensions/RAX-KSQA/xsd/RAX-KSQA-secretQA.xsd rename to openstack-identity-api/src/docbkx/xsd/RAX-KSQA-secretQA.xsd index 83e7b942..cc13a492 100644 --- a/openstack-identity-api/src/docbkx/extensions/RAX-KSQA/xsd/RAX-KSQA-secretQA.xsd +++ b/openstack-identity-api/src/docbkx/xsd/RAX-KSQA-secretQA.xsd @@ -10,7 +10,7 @@ + schemaLocation="credentials.xsd" /> - + - + - + - + targetNamespace="http://docs.openstack.org/identity/api/v2.0"> - + - + - -

- Base type for credential in Keystone. +

Base type for credential in the Identity Service.

- +
- -

- Both the tenantId and tenantName are optional, but should not be specified together. If both attributes are specified, the server SHOULD respond with a 400 Bad Request. -

+

Both the tenantId and tenantName are optional, but + should not be specified together. If both + attributes are specified, the server SHOULD + respond with a 400 Bad Request.

- - - - - - - + + + + + + + @@ -71,8 +73,10 @@ - - + + @@ -80,8 +84,10 @@ - - + + @@ -89,15 +95,18 @@ - - + + - + diff --git a/openstack-identity-api/src/docbkx/xsd/endpoints.xsd b/openstack-identity-api/src/docbkx/xsd/endpoints.xsd new file mode 100644 index 00000000..8041ec28 --- /dev/null +++ b/openstack-identity-api/src/docbkx/xsd/endpoints.xsd @@ -0,0 +1,133 @@ + + + + + + + + + +

An Endpoint.

+
+
+
+ + + +

A list of endpoints.

+
+
+
+ + + + + + +

Version details.

+
+
+
+ + +
+ + + +

An ID uniquely identifying the Endpoint.

+
+
+
+ + + +

The OpenStack-registered type (such as, 'compute', + 'object-store', and so on).

+
+
+
+ + + +

The commercial service name (such as, 'My Nova + Cloud Servers').

+
+
+
+ + + +

The region of endpoint template.

+
+
+
+ + + +

The public URL to access represented service. +

+
+
+
+ + + +

The internal version of the public URL.

+
+
+
+ + + +

The admin URL.

+
+
+
+ + + +

Tenant ID to which the endpoints belong.

+
+
+
+ +
+ + + + + + + + +
diff --git a/openstack-identity-api/src/docbkx/xsd/extensions.xsd b/openstack-identity-api/src/docbkx/xsd/extensions.xsd new file mode 100644 index 00000000..6e111228 --- /dev/null +++ b/openstack-identity-api/src/docbkx/xsd/extensions.xsd @@ -0,0 +1,183 @@ + + + + + + + + + + Extensions + + + +

This schema file defines types related to API + extensions.

+
+
+ + + + + + + +

A list of supported extensions.

+
+ + + + + + + + + + +
+
+ + + +

Details about a specific extension.

+
+ + + + + + + + + + +
+
+ + + + +

A list of extensions.

+
+
+ + + + + + +
+ + + + +

Details about a specific extension.

+
+
+ + + + +

A short description of what the extension + does.

+
+
+
+ + +
+ + + +

A human readable extension name.

+
+
+
+ + + +

Extension namespace used for XML + representations.

+
+
+
+ + + +

A vendor prefix alias used for non-XML + representations.

+
+
+
+ + + +

The time that the extension was added or + modified.

+
+
+
+ + + + +

There should be at least one atom link with a + describedby relation. This relation provides + developer info for the extension.

+
+
+
+
+ + + + +

Vendor aliases are used to differentiate + extensions in non-XML representations as well as + in HTTP headers and in the URL path. An alias is + made of a vendor prefix, followed be a dash (-) + followed be a short extension ID. For example: + RAX-PIE.

+
+
+ + + +
+
diff --git a/openstack-identity-api/src/docbkx/common/xsd/fault.xsd b/openstack-identity-api/src/docbkx/xsd/fault.xsd similarity index 100% rename from openstack-identity-api/src/docbkx/common/xsd/fault.xsd rename to openstack-identity-api/src/docbkx/xsd/fault.xsd diff --git a/openstack-identity-api/src/docbkx/common/xsd/roles.xsd b/openstack-identity-api/src/docbkx/xsd/roles.xsd similarity index 100% rename from openstack-identity-api/src/docbkx/common/xsd/roles.xsd rename to openstack-identity-api/src/docbkx/xsd/roles.xsd diff --git a/openstack-identity-api/src/docbkx/common/xsd/services.xsd b/openstack-identity-api/src/docbkx/xsd/services.xsd similarity index 59% rename from openstack-identity-api/src/docbkx/common/xsd/services.xsd rename to openstack-identity-api/src/docbkx/xsd/services.xsd index 26f8dfb6..afd42cd9 100644 --- a/openstack-identity-api/src/docbkx/common/xsd/services.xsd +++ b/openstack-identity-api/src/docbkx/xsd/services.xsd @@ -1,10 +1,9 @@ - + - + targetNamespace="http://docs.openstack.org/identity/api/v2.0"> - + - -

- An extensible service type allows all of the +

An extensible service type allows all of the strings defined in ServiceType or an - alias prefixed status. + ServiceType" + >ServiceType or an alias prefixed status.

- +
- -

- The type for an OpenStack Compute API 1.1 compatible service. -

+

The type for an OpenStack Compute API 1.1 + compatible service.

- -

- The type for a Swift-compatible service. +

The type for a Swift-compatible service.

- -

- The type for a Glance-compatible service +

The type for a Glance-compatible service

- -

- The type for a Keystone-compatible service. -

+

The type for an Identity + Service-compatible service.

- -

- The type for a Block-Storage-compatible service. -

+

The type for a Block-Storage-compatible + service.

- -

- The type for Amazon's EC2-compatible service. -

+

The type for an Amazon EC2-compatible + service.

@@ -110,12 +97,10 @@ - -

- A non-core service type which must contain an extension prefix. -

+

A non-core service type, which must contain an + extension prefix.

diff --git a/openstack-identity-api/src/docbkx/common/xsd/tenant.xsd b/openstack-identity-api/src/docbkx/xsd/tenant.xsd similarity index 100% rename from openstack-identity-api/src/docbkx/common/xsd/tenant.xsd rename to openstack-identity-api/src/docbkx/xsd/tenant.xsd diff --git a/openstack-identity-api/src/docbkx/xsd/token.xsd b/openstack-identity-api/src/docbkx/xsd/token.xsd new file mode 100644 index 00000000..5590b4cb --- /dev/null +++ b/openstack-identity-api/src/docbkx/xsd/token.xsd @@ -0,0 +1,280 @@ + + + + + + + + + + + + + + + + + + + + +

A token is an arbitrary bit of text that is used + to access resources. Each token has a scope which + describes which resources are accessible with it. + A token may be revoked at anytime and is valid for + a finite duration.

+

While the Identity Service supports token-based + authentication in this release, the intention is + for it to support additional protocols in the + future. The desire is for it to be an integration + service, and not a full-fledged identity store and + management solution.

+
+ + + + + + + + + + +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

The service catalog lists the services you have + access to

+
+

We optimized for future flexibility around the + hierarchy. So we left the design as a flat + list of endpoints with attributes and the + consumer can categorize as they need. This + results in potential duplication (such as with + the version/@list) but we acceopt that + normalization cost in order to not force an + artificial hierarchy (suchas on region, which + can be optional).

+
+
+ +                     +           +                   +               +           + +
+ + + + +

A list of services.

+
+
+
+ + +
+ +
+ + + + + + +

A list of endpoints.

+
+
+
+ + +
+ + + +

The OpenStack-registered type (e.g. 'compute', + 'object-store', etc).

+
+
+
+ + + +

The commercial service name (e.g. 'My Nova + Cloud Servers').

+
+
+
+ +
+ + + + + + + +

Version details.

+
+
+
+ + +
+ + + +

The name of the region where the endpoint + lives. Example: airport codes; LHR (UK), STL + (Saint Louis)

+
+
+
+ + + +

Tenant id to which the endpoints belong.

+
+
+
+ + + +

Public accessible service URL.

+
+
+
+ + + +

A service URL, accessible only locally within + that cloud (generally over a high bandwidth, + low latency, free of charge link).

+
+
+
+ + + +

An Admin URL (used for administration using + privileged calls). This may expose additional + functionality not found in the public and + internal URL.

+
+
+
+ +
+ + + + + + +

Id of the version.

+
+
+
+ + + +

URI to get the information specific to this + version.

+
+
+
+ + + +

URI to get the information about all versions. +

+
+
+
+ +
+
diff --git a/openstack-identity-api/src/docbkx/common/xsd/user.xsd b/openstack-identity-api/src/docbkx/xsd/user.xsd similarity index 51% rename from openstack-identity-api/src/docbkx/common/xsd/user.xsd rename to openstack-identity-api/src/docbkx/xsd/user.xsd index 76c47b6b..b03a950c 100644 --- a/openstack-identity-api/src/docbkx/common/xsd/user.xsd +++ b/openstack-identity-api/src/docbkx/xsd/user.xsd @@ -1,44 +1,37 @@ - + - + targetNamespace="http://docs.openstack.org/identity/api/v2.0"> - + - + - -

- A list of Users. -

+ +

A list of Users.

- -

- A Keystone User. -

+

An Identity Service user.

@@ -46,77 +39,68 @@ - + - -

- An automatically generated, unique, immutable (it will never change) identifier - for the user. This is generated by the backend this user is stored in. -

+

An automatically generated, unique, immutable + (it will never change) identifier for the + user. This is generated by the backend this + user is stored in.

- -

- A unique, mutable (it can change) user name that may be used by the user - an identifier when presenting credentials. -

+

A unique, mutable (it can change) user name + that may be used by the user an identifier + when presenting credentials.

- + - -

- A true/false value that determines if the user may authenticate or not. - If enabled is false, the user will not be able to authenticate. - How this value is stored or generated is dependent on the backend in use. -

+

A true/false value that determines if the user + may authenticate or not. If enabled is false, + the user will not be able to authenticate. How + this value is stored or generated is dependent + on the backend in use.

- + - -

- A human-readable, friendly name for use in user interfaces. -

+

A human-readable, friendly name for use in + user interfaces.

- -

- A time-stamp identifying the modification time of the - user. -

+

A time-stamp identifying the modification time + of the user.

- -

- A creation time-stamp for the user. -

+

A creation time-stamp for the user.

@@ -125,9 +109,12 @@ - - - + + + diff --git a/openstack-identity-api/src/docbkx/common/xsd/version.xsd b/openstack-identity-api/src/docbkx/xsd/version.xsd similarity index 100% rename from openstack-identity-api/src/docbkx/common/xsd/version.xsd rename to openstack-identity-api/src/docbkx/xsd/version.xsd diff --git a/openstack-identity-api/src/docbkx/common/xslt/schema.xslt b/openstack-identity-api/src/docbkx/xslt/schema.xslt similarity index 100% rename from openstack-identity-api/src/docbkx/common/xslt/schema.xslt rename to openstack-identity-api/src/docbkx/xslt/schema.xslt