API v2.0
Copyright © 2010, 2011, 2012, 2013 OpenStack Foundation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
2014-04-26
Abstract
This document describes how to develop applications that use the OpenStack Identity API v2.0 for authentication. This document also describes how to integrate services with the OpenStack Identity API v2.0.
Contents
List of Tables
- 1.1. Identity Concepts
- 1.2. Response Types
- 1.3. Compression Headers
- 1.4. Fault Types
- 3.1. Authentication Header
- 6.1. Authentication Header
- 6.2. Authentication Header
- 6.3. Authentication Header
- 6.4. Authentication Header
List of Examples
- 1.1. JSON Request with Headers
- 1.2. XML Response with Headers
- 1.3. Tenant Collection, First Page: XML
- 1.4. Tenant Collection, First Page: JSON
- 1.5. Tenant Collection, Second Page: XML
- 1.6. Tenant Collection, Second Page: JSON
- 1.7. Tenant Collection, Last Page: XML
- 1.8. Tenant Collection, Last Page: JSON
- 1.9. Paginated Roles in a User: XML
- 1.10. Paginated Roles in an User: JSON
- 1.11. Request with MIME type versioning
- 1.12. Request with URI versioning
- 1.13. Multiple Choices Response: XML
- 1.14. Multiple Choices Response: JSON
- 1.15. Versions List Request
- 1.16. Versions List Response: XML
- 1.17. Versions List Response: Atom
- 1.18. Versions List Response: JSON
- 1.19. Version Details Request
- 1.20. Version Details Response: XML
- 1.21. Version Details Response: Atom
- 1.22. Version Details Response: JSON
- 1.23. Extensions Response: XML
- 1.24. Extensions Response: JSON
- 1.25. Extension Response: xml
- 1.26. Extensions Response: JSON
- 1.27. Extended User Response: XML
- 1.28. Extended User Response: JSON
- 1.29. XML Fault Response
- 1.30. JSON Fault Response
- 1.31. XML Not Found Fault
- 1.32. JSON Not Found Fault
- 2.1. List extensions: JSON response
- 2.2. List extensions: XML response
- 2.3. Authenticate with user name and password credentials: JSON request
- 2.4. Authenticate with user name and password credentials: XML request
- 2.5. Authenticate with user name and password credentials: JSON response
- 2.6. Authenticate with user name and password credentials: XML response
- 3.1. Authenticate with credentials: JSON request
- 3.2. Authenticate with credentials: XML request
- 3.3. Authenticate with credentials: JSON response
- 3.4. Authenticate with credentials: XML response
- 3.5. Validate token: JSON response
- 3.6. Validate token: XML response
- 3.7. List endpoints for token: JSON response
- 3.8. List endpoints for token: XML response
- 3.9. Get User Information by Name: XML response
- 3.10. Get User Information by Name: JSON response
- 3.11. Get User Information by ID: XML response
- 3.12. Get User Information by ID: JSON response
- 3.13. List user global roles: JSON response
- 3.14. List user global roles: XML response
- 3.15. Get tenants: JSON response
- 3.16. Get tenants: XML response
- 3.17. Get tenant by name: JSON response
- 3.18. Get tenant by name: XML response
- 3.19. Get tenant by ID: JSON response
- 3.20. Get tenant by ID: XML response
- 3.21. List roles for user: JSON response
- 3.22. List roles for user: XML response
- 4.1. List Users: XML response
- 4.2. List Users: JSON response
- 4.3. Add User: XML request
- 4.4. Add User: JSON request
- 4.5. Add User: XML response
- 4.6. Add User: JSON response
- 4.7. Update User: XML request
- 4.8. Update User: JSON request
- 4.9. Update User: XML response
- 4.10. Update User: JSON response
- 4.11. List global roles for user: JSON response
- 4.12. List global roles for user: XML response
- 4.13. Get role information by name: XML response
- 4.14. Get role information by name: JSON response
- 4.15. List Roles: XML response
- 4.16. List Roles: JSON response
- 4.17. Add Role: XML request
- 4.18. Add Role: JSON request
- 4.19. Add Role: XML response
- 4.20. Add Role: JSON response
- 4.21. Get role information: XML response
- 4.22. Get role information: JSON response
- 4.23. Add Tenant: XML request
- 4.24. Add Tenant: JSON request
- 4.25. Add Tenant: XML response
- 4.26. Add Tenant: JSON response
- 4.27. Update Tenant: XML request
- 4.28. Update Tenant: JSON request
- 4.29. Update Tenant: XML response
- 4.30. Update Tenant: JSON response
- 4.31. List Users for a Tenant: XML response
- 4.32. List Users for a Tenant: JSON response
- 4.33. List Services: XML response
- 4.34. List Services: JSON response
- 4.35. Add Service: XML request
- 4.36. Add Service: JSON request
- 4.37. Add Service: XML response
- 4.38. Add Service: JSON response
- 4.39. Get Service by Name: XML response
- 4.40. Get Service by Name: JSON response
- 4.41. Get Service: XML response
- 4.42. Get Service: JSON response
- 4.43. List Endpoint Templates: XML response
- 4.44. List Endpoint Templates: JSON response
- 4.45. Add Endpoint Template: XML request
- 4.46. Add Endpoint Template: JSON request
- 4.47. Add Endpoint Template: XML response
- 4.48. Add Endpoint Template: JSON response
- 4.49. Get Endpoint Template: XML response
- 4.50. Get Endpoint Template: JSON response
- 4.51. List Endpoints: XML response
- 4.52. List Endpoints: JSON response
- 4.53. Add Endpoint: XML request
- 4.54. Add Endpoint: JSON request
- 4.55. Add Endpoint: XML response
- 4.56. Add Endpoint: JSON response
- 4.57. Get Endpoint: XML response
- 4.58. Get Endpoint: JSON response
- 4.59. List Credentials: XML response
- 4.60. List Credentials: JSON response
- 4.61. Add User Credentials: XML request
- 4.62. Add User Credentials: JSON request
- 4.63. Add User Credentials: XML response
- 4.64. Add User Credentials: JSON response
- 4.65. Get User Credentials: XML response
- 4.66. Get User Credentials: JSON response
- 4.67. Update User Credentials: XML request
- 4.68. Update User Credentials: JSON request
- 4.69. Update User Credentials: XML response
- 4.70. Update User Credentials: JSON response
- 4.71. List Credentials: XML response
- 4.72. List Credentials: JSON response
- 4.73. Add User Credential.: XML request
- 4.74. Add User Credential.: JSON request
- 4.75. Add User Credential.: XML response
- 4.76. Add User Credential.: JSON response
- 4.77. Get User Credentials: XML response
- 4.78. Get User Credentials: JSON response
- 4.79. Update User Credentials: XML request
- 4.80. Update User Credentials: JSON request
- 4.81. Update User Credentials: XML response
- 4.82. Update User Credentials: JSON response
- 4.83. Validate Token: XML response
- 4.84. Validate Token: JSON response
- 4.85. List Endpoints for a Token: XML response
- 4.86. List Endpoints for a Token: JSON response
- 5.1. Validate Token: XML response
- 5.2. Validate Token: JSON response
- 6.1. Add a New Group: XML request
- 6.2. Add a New Group: JSON request
- 6.3. Add a New Group: XML response
- 6.4. Add a New Group: JSON response
- 6.5. Get Group: XML response
- 6.6. Get Group: JSON response
- 6.7. Update Group: XML request
- 6.8. Update Group: JSON request
- 6.9. Update Group: XML response
- 6.10. Update Group: JSON response
- 6.11. Get Users for Group Get Users for Group: XML response
- 6.12. Get Users for Group Get Users for Group: JSON response
- 6.13. Get Users for Group Get Users for Group: XML response
- 6.14. Get Users for Group Get Users for Group: JSON response
- 6.15. List Groups for a User: XML response
- 6.16. List Groups for a User: JSON response
- 6.17. Add user Credential: XML request
- 6.18. Add user Credential: JSON request
- 6.19. Add user Credential: XML response
- 6.20. Add user Credential: JSON response
- 6.21. List Credentials: XML response
- 6.22. List Credentials: JSON response
- 6.23. Update User Credentials: XML request
- 6.24. Update User Credentials: JSON request
- 6.25. Update User Credentials: XML response
- 6.26. Update User Credentials: JSON response
- 6.27. Get User Credentials: XML response
- 6.28. Get User Credentials: JSON response
- 6.29. Auth with apikeyCredentials: JSON Request
- 6.30. Auth with apikeyCredentials: XML Request
- 6.31. Auth with apikeyCredentials: JSON Response
- 6.32. Auth with apikeyCredentials: XML Response
- 6.33. Get User Secret Question and Answer: XML response
- 6.34. Get User Secret Question and Answer: JSON response
- 6.35. Update User Secret Question and Answer: XML request
- 6.36. Update User Secret Question and Answer: JSON request
- 6.37. Update User Secret Question and Answer: XML response
- 6.38. Update User Secret Question and Answer: JSON response