OpenStack Identity API v2.0 Reference

API v2.0 and extensions

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

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.



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.

List of Examples

1.1. JSON request with headers
1.2. XML response with headers
1.3. Tenant collection, first page: XML response
1.4. Tenant collection, first page: JSON response
1.5. Tenant collection, second page: XML response
1.6. Tenant collection, second page: JSON response
1.7. Tenant collection, last page: XML response
1.8. Tenant collection, last page: JSON response
1.9. Paginated roles in user: XML response
1.10. Paginated roles in user: JSON response
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. List versions: HTTP request
1.16. List versions: XML response
1.17. List versions: Atom response
1.18. List versions: JSON response
1.19. Get version details: HTTP request
1.20. Get version details: XML response
1.21. Get version details: Atom response
1.22. Get version details: JSON response
1.23. List extensions: XML
1.24. List extensions: JSON
1.25. List extensions: XML response
1.26. List extensions: JSON response
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 versions: JSON response
2.2. List versions: XML response
2.3. Get version information: JSON response
2.4. Get version information: XML response
2.5. List extensions: JSON response
2.6. List extensions: XML response
2.7. Get extension details: JSON response
2.8. Get extension details: XML response
2.9. Authenticate with user name and password credentials: JSON request
2.10. Authenticate with user name and password credentials: XML request
2.11. Authenticate with token: JSON request
2.12. Authenticate with token: XML request
2.13. Authenticate with user name and password credentials: JSON response
2.14. Authenticate with user name and password credentials: XML response
3.1. Get version information: JSON response
3.2. Get version information: XML response
3.3. List extensions: JSON response
3.4. List extensions: XML response
3.5. Get extension details: JSON response
3.6. Get extension details: XML response
3.7. Authenticate with credentials: JSON request
3.8. Authenticate with credentials: XML request
3.9. Authenticate with token: JSON request
3.10. Authenticate with token: XML request
3.11. Authenticate with credentials: JSON response
3.12. Authenticate with credentials: XML response
3.13. Validate token: JSON response
3.14. Validate token: XML response
3.15. Add user: JSON request
3.16. Add user: XML request
3.17. Add user: JSON response
3.18. Add user: XML response
3.19. Update user: JSON request
3.20. Update user: XML request
3.21. Update user: JSON response
3.22. Update user: XML response
3.23. Get user information by name: XML response
3.24. Get user information by name: JSON response
3.25. Get user information by ID: XML response
3.26. Get user information by ID: JSON response
3.27. List user global roles: JSON response
3.28. List user global roles: XML response
3.29. Get tenants: JSON response
3.30. Get tenants: XML response
3.31. Get tenant by name: JSON response
3.32. Get tenant by name: XML response
3.33. Get tenant by ID: JSON response
3.34. Get tenant by ID: XML response
3.35. List roles for user: JSON response
3.36. 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 endpoints: XML response
4.44. List endpoints: JSON response
4.45. Add endpoint: XML request
4.46. Add endpoint: JSON request
4.47. Add endpoint: XML response
4.48. Add endpoint: JSON response
4.49. Get endpoint: XML response
4.50. Get endpoint: JSON response
4.51. List endpoint templates: XML response
4.52. List endpoint templates: JSON response
4.53. Add endpoint template: XML request
4.54. Add endpoint template: JSON request
4.55. Add endpoint template: XML response
4.56. Add endpoint template: JSON response
4.57. Get endpoint template: XML response
4.58. Get endpoint template: JSON response
4.59. Update endpoint template: XML request
4.60. Update endpoint template: JSON request
4.61. Update endpoint template: XML response
4.62. Update endpoint template: JSON response
4.63. List Credentials: XML response
4.64. List Credentials: JSON response
4.65. Add User Credentials: XML request
4.66. Add User Credentials: JSON request
4.67. Add User Credentials: XML response
4.68. Add User Credentials: JSON response
4.69. Get User Credentials: XML response
4.70. Get User Credentials: JSON response
4.71. Update User Credentials: XML request
4.72. Update User Credentials: JSON request
4.73. Update User Credentials: XML response
4.74. Update User Credentials: JSON response
4.75. List Credentials by Type: XML response
4.76. List Credentials by Type: JSON response
4.77. List credentials: XML response
4.78. List credentials: JSON response
4.79. Add user credential: XML request
4.80. Add user credential: JSON request
4.81. Add user credential: XML response
4.82. Add user credential: JSON response
4.83. Get user credentials: XML response
4.84. Get user credentials: JSON response
4.85. Update user credentials: XML request
4.86. Update user credentials: JSON request
4.87. Update user credentials: XML response
4.88. Update user credentials: JSON response
4.89. List credentials by type: XML response
4.90. List credentials by type: JSON response
4.91. Validate token: XML response
4.92. Validate token: JSON response
4.93. List endpoints for a token: XML response
4.94. List endpoints for a token: JSON response
6.1. Authentication with apikeyCredentials: JSON request
6.2. Authentication with apikeyCredentials: XML request
6.3. Authentication with apikeyCredentials: JSON response
6.4. Authentication with apikeyCredentials: XML response
Questions? Discuss on
Found an error? Report a bug against this page

loading table of contents...