Migrate identity /v2 docs from api-ref repo
Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polishes the results from the conversion and migrates the v2 docs to our repository under 'api-ref/source' directory. Missing parameters definitions were added. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: Id21d94a73f601561cb5f3e00ae25f4a5e4087716
This commit is contained in:
Samuel de Medeiros Queiroz
Steve Martinelli
parent
0a6c2f7ffb
commit
3bfb08e4b1
@ -11,6 +11,10 @@ Contents:
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
v2/identity-api-extensions.inc
|
||||
v2/identity-auth.inc
|
||||
v2/versions.inc
|
||||
|
||||
v3/authenticate-v3.inc
|
||||
v3/credentials
|
||||
v3/domains
|
||||
|
||||
68
api-ref/source/v2/identity-api-extensions.inc
Normal file
68
api-ref/source/v2/identity-api-extensions.inc
Normal file
@ -0,0 +1,68 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
==========
|
||||
Extensions
|
||||
==========
|
||||
|
||||
|
||||
Show extension details
|
||||
======================
|
||||
|
||||
.. rest_method:: GET /v2.0/extensions/{alias}
|
||||
|
||||
Shows details for an extension, by alias.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:203,413,405,404,403,401,400,503,
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- alias: alias
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- x-openstack-request-id: x-openstack-request-id
|
||||
- alias: alias
|
||||
- updated: updated
|
||||
- description: description
|
||||
- name: name
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/admin/extension-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
List extensions
|
||||
===============
|
||||
|
||||
.. rest_method:: GET /v2.0/extensions
|
||||
|
||||
Lists available extensions.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:203,413,405,404,403,401,400,503,
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- x-openstack-request-id: x-openstack-request-id
|
||||
- alias: alias
|
||||
- updated: updated
|
||||
- description: description
|
||||
- name: name
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/admin/extensions-list-response.json
|
||||
:language: javascript
|
||||
120
api-ref/source/v2/identity-auth.inc
Normal file
120
api-ref/source/v2/identity-auth.inc
Normal file
@ -0,0 +1,120 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
==================
|
||||
Tokens and tenants
|
||||
==================
|
||||
|
||||
|
||||
List tenants
|
||||
============
|
||||
|
||||
.. rest_method:: GET /v2.0/tenants
|
||||
|
||||
Lists tenants to which the token has access.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:203,413,405,404,403,401,400,503,
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- description: description
|
||||
- tenants_links: tenants_links
|
||||
- enabled: enabled
|
||||
- tenants: tenants
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/admin/tenants-list-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Authenticate
|
||||
============
|
||||
|
||||
.. rest_method:: POST /v2.0/tokens
|
||||
|
||||
Authenticates and generates a token.
|
||||
|
||||
The Identity API is a RESTful web service. It is the entry point to
|
||||
all service APIs. To access the Identity API, you must know its
|
||||
URL.
|
||||
|
||||
Each REST request against Identity requires the X-Auth-Token
|
||||
header. Clients obtain this token, along with the URL to other
|
||||
service APIs, by first authenticating against Identity with valid
|
||||
credentials.
|
||||
|
||||
To authenticate, you must provide either a user ID and password or
|
||||
a token.
|
||||
|
||||
If the authentication token has expired, this call returns the HTTP
|
||||
``401`` status code.
|
||||
|
||||
If the token has expired, this call returns the HTTP ``404`` status
|
||||
code.
|
||||
|
||||
The Identity API treats expired tokens as no longer valid tokens.
|
||||
|
||||
The deployment determines how long expired tokens are stored.
|
||||
|
||||
To view the ``trust`` object, you need to set ``trust`` enable on
|
||||
the keystone configuration.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:203,413,405,404,403,401,400,503,
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- username: username
|
||||
- passwordCredentials: passwordCredentials
|
||||
- tenantId: tenantId
|
||||
- token: token
|
||||
- tenantName: tenantName
|
||||
- password: password
|
||||
- id: id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/admin/authenticate-token-request.json
|
||||
:language: javascript
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- impersonation: impersonation
|
||||
- endpoints_links: endpoints_links
|
||||
- serviceCatalog: serviceCatalog
|
||||
- description: description
|
||||
- type: type
|
||||
- expires: expires
|
||||
- enabled: enabled
|
||||
- name: name
|
||||
- access: access
|
||||
- trustee_user_id: trustee_user_id
|
||||
- token: token
|
||||
- user: user
|
||||
- issued_at: issued_at
|
||||
- trustor_user_id: trustor_user_id
|
||||
- endpoints: endpoints
|
||||
- trust: trust
|
||||
- id: id
|
||||
- tenant: tenant
|
||||
- metadata: metadata
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/client/authenticate-response.json
|
||||
:language: javascript
|
||||
270
api-ref/source/v2/parameters.yaml
Normal file
270
api-ref/source/v2/parameters.yaml
Normal file
@ -0,0 +1,270 @@
|
||||
# variables in header
|
||||
x-openstack-request-id:
|
||||
description: |
|
||||
A unique request ID that provides tracking for
|
||||
the request. Provider must configure middleware to return a
|
||||
request ID header in a response.
|
||||
in: header
|
||||
required: false
|
||||
type: string
|
||||
|
||||
# variables in path
|
||||
alias_1:
|
||||
description: |
|
||||
An alias for the extension name. For example,
|
||||
``os-server-external- events``.
|
||||
in: path
|
||||
required: false
|
||||
type: string
|
||||
|
||||
# variables in query
|
||||
|
||||
# variables in body
|
||||
access:
|
||||
description: |
|
||||
An ``access`` object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
alias:
|
||||
description: |
|
||||
The alias for the extension. For example,
|
||||
"FOXNSOX", "os- availability-zone", "os-extended-quotas", "os-
|
||||
share-unmanage" or "os-used-limits."
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
description:
|
||||
description: |
|
||||
The description of the tenant. If not set, this
|
||||
value is ``null``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
description_1:
|
||||
description: |
|
||||
The extension description.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
description_2:
|
||||
description: |
|
||||
Description about the tenant.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
enabled:
|
||||
description: |
|
||||
Indicates whether the tenant is enabled or
|
||||
disabled.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
endpoints:
|
||||
description: |
|
||||
One or more ``endpoints`` objects. Each object
|
||||
shows the ``adminURL``, ``region``, ``internalURL``, ``id``, and
|
||||
``publicURL`` for the endpoint.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
endpoints_links:
|
||||
description: |
|
||||
Links for the endpoint.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
expires:
|
||||
description: |
|
||||
The date and time when the token expires.
|
||||
|
||||
The date and time stamp format is `ISO 8601
|
||||
<https://en.wikipedia.org/wiki/ISO_8601>`_:
|
||||
|
||||
::
|
||||
|
||||
CCYY-MM-DDThh:mm:ss±hh:mm
|
||||
|
||||
For example, ``2015-08-27T09:49:58-05:00``.
|
||||
|
||||
The ``±hh:mm`` value, if included, is the time zone as an offset
|
||||
from UTC. In the previous example, the offset value is ``-05:00``.
|
||||
|
||||
A ``null`` value indicates that the token never expires.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
id:
|
||||
description: |
|
||||
The token ID. This field is required in the
|
||||
``token`` object.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
id_1:
|
||||
description: |
|
||||
The tenant ID.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
impersonation:
|
||||
description: |
|
||||
The impersonation flag.
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
issued_at:
|
||||
description: |
|
||||
The date and time when the token was issued.
|
||||
|
||||
The date and time stamp format is `ISO 8601
|
||||
<https://en.wikipedia.org/wiki/ISO_8601>`_:
|
||||
|
||||
::
|
||||
|
||||
CCYY-MM-DDThh:mm:ss±hh:mm
|
||||
|
||||
For example, ``2015-08-27T09:49:58-05:00``.
|
||||
|
||||
The ``±hh:mm`` value, if included, is the time zone as an offset
|
||||
from UTC. In the previous example, the offset value is ``-05:00``.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
metadata:
|
||||
description: |
|
||||
A ``metadata`` object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
name:
|
||||
description: |
|
||||
Endpoint name.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
name_1:
|
||||
description: |
|
||||
The name of the extension. For example, "Fox In
|
||||
Socks."
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
name_2:
|
||||
description: |
|
||||
The tenant name.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: |
|
||||
The password of the user. Required if you include
|
||||
the ``passwordCredentials`` object. Otherwise, you must provide a
|
||||
token.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
passwordCredentials:
|
||||
description: |
|
||||
A ``passwordCredentials`` object. To
|
||||
authenticate, you must provide either a user ID and password or a
|
||||
token.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
serviceCatalog:
|
||||
description: |
|
||||
List of ``serviceCatalog`` objects.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
tenant:
|
||||
description: |
|
||||
A ``tenant`` object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
tenantId:
|
||||
description: |
|
||||
The tenant ID. Both the ``tenantId`` and
|
||||
``tenantName`` attributes are optional and mutually exclusive. If
|
||||
you specify both attributes, the server returns the ``Bad Request
|
||||
(400)`` response code.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
tenantName:
|
||||
description: |
|
||||
The tenant name. Both the ``tenantId`` and
|
||||
``tenantName`` attributes are optional and mutually exclusive. If
|
||||
you specify both attributes, the server returns the ``Bad Request
|
||||
(400)`` response code.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
tenants:
|
||||
description: |
|
||||
One or more tenant Objects.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
tenants_links:
|
||||
description: |
|
||||
Links of the tenants.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
token:
|
||||
description: |
|
||||
A ``token`` object. Required if you do not
|
||||
provide a password credential.
|
||||
in: body
|
||||
required: false
|
||||
type: object
|
||||
trust:
|
||||
description: |
|
||||
A ``trust`` object.
|
||||
in: body
|
||||
required: false
|
||||
type: object
|
||||
trustee_user_id:
|
||||
description: |
|
||||
The trustee user ID.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
trustor_user_id:
|
||||
description: |
|
||||
The trustor user ID.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
type:
|
||||
description: |
|
||||
Endpoint type.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
updated:
|
||||
description: |
|
||||
The date and time stamp when the extension was
|
||||
last updated.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
user:
|
||||
description: |
|
||||
A ``user`` object, which shows the ``username``,
|
||||
``roles_links``, ``id``, ``roles``, and ``name``.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
username:
|
||||
description: |
|
||||
The user name. Required if you include the
|
||||
``passwordCredentials`` object. Otherwise, you must provide a
|
||||
token.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
|
||||
@ -0,0 +1,11 @@
|
||||
{
|
||||
"credentials": [
|
||||
{
|
||||
"passwordCredentials": {
|
||||
"username": "test_user",
|
||||
"password": "secretsecret"
|
||||
}
|
||||
}
|
||||
],
|
||||
"credentials_links": []
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"role": {
|
||||
"id": "123",
|
||||
"name": "Guest",
|
||||
"description": "Guest Access"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"role": {
|
||||
"id": "123",
|
||||
"name": "Guest",
|
||||
"description": "Guest Access"
|
||||
}
|
||||
}
|
||||
10
api-ref/source/v2/samples/OS-KSADM/roles-list-response.json
Normal file
10
api-ref/source/v2/samples/OS-KSADM/roles-list-response.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"roles": [
|
||||
{
|
||||
"id": "123",
|
||||
"name": "compute:admin",
|
||||
"description": "Nova Administrator"
|
||||
}
|
||||
],
|
||||
"roles_links": []
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"OS-KSADM:service": {
|
||||
"id": "123",
|
||||
"name": "nova",
|
||||
"type": "compute",
|
||||
"description": "OpenStack Compute Service"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"OS-KSADM:service": {
|
||||
"id": "123",
|
||||
"name": "nova",
|
||||
"type": "compute",
|
||||
"description": "OpenStack Compute Service"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,17 @@
|
||||
{
|
||||
"OS-KSADM:services": [
|
||||
{
|
||||
"id": "123",
|
||||
"name": "nova",
|
||||
"type": "compute",
|
||||
"description": "OpenStack Compute Service"
|
||||
},
|
||||
{
|
||||
"id": "234",
|
||||
"name": "glance",
|
||||
"type": "image",
|
||||
"description": "OpenStack Image Service"
|
||||
}
|
||||
],
|
||||
"OS-KSADM:services_links": []
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"tenant": {
|
||||
"id": "1234",
|
||||
"name": "ACME corp",
|
||||
"description": "A description ...",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"tenant": {
|
||||
"id": "1234",
|
||||
"name": "ACME corp",
|
||||
"description": "A description ...",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"tenant": {
|
||||
"name": "ACME corp",
|
||||
"description": "A description ...",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,12 @@
|
||||
{
|
||||
"roles": [
|
||||
{
|
||||
"id": "8341d3603a1d4d5985bff09f10704d4d",
|
||||
"name": "service"
|
||||
},
|
||||
{
|
||||
"id": "2e66d57df76946fdbe034bc4da6fdec0",
|
||||
"name": "admin"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"user": {
|
||||
"id": "u1000",
|
||||
"name": "jqsmith",
|
||||
"email": "john.smith@example.org",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"user": {
|
||||
"id": "u1000",
|
||||
"name": "jqsmith",
|
||||
"email": "john.smith@example.org",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
17
api-ref/source/v2/samples/OS-KSADM/users-list-response.json
Normal file
17
api-ref/source/v2/samples/OS-KSADM/users-list-response.json
Normal file
@ -0,0 +1,17 @@
|
||||
{
|
||||
"users": [
|
||||
{
|
||||
"id": "u1000",
|
||||
"name": "jqsmith",
|
||||
"email": "john.smith@example.org",
|
||||
"enabled": true
|
||||
},
|
||||
{
|
||||
"id": "u1001",
|
||||
"name": "jqsmith",
|
||||
"email": "john.smith@example.org",
|
||||
"enabled": true
|
||||
}
|
||||
],
|
||||
"users_links": []
|
||||
}
|
||||
@ -0,0 +1,5 @@
|
||||
{
|
||||
"user": {
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,5 @@
|
||||
{
|
||||
"user": {
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"user": {
|
||||
"name": "jqsmith",
|
||||
"email": "john.smith@example.org",
|
||||
"enabled": true,
|
||||
"OS-KSADM:password": "secretsecret"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,11 @@
|
||||
{
|
||||
"endpoint": {
|
||||
"id": 1,
|
||||
"tenantId": 1,
|
||||
"region": "North",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,14 @@
|
||||
{
|
||||
"OS-KSCATALOG:endpointTemplate": {
|
||||
"id": 1,
|
||||
"region": "North",
|
||||
"global": true,
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"versionId": "1",
|
||||
"versionInfo": "https://compute.north.public.com/v1/",
|
||||
"versionList": "https://compute.north.public.com/",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,11 @@
|
||||
{
|
||||
"OS-KSCATALOG:endpointTemplate": {
|
||||
"id": 1,
|
||||
"region": "North",
|
||||
"global": true,
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,5 @@
|
||||
{
|
||||
"OS-KSCATALOG:endpointTemplate": {
|
||||
"id": 1
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,44 @@
|
||||
{
|
||||
"OS-KSCATALOG:endpointsTemplates": [
|
||||
{
|
||||
"id": 1,
|
||||
"region": "North",
|
||||
"global": true,
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"enabled": true
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"region": "South",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.south.public.com/v1",
|
||||
"internalURL": "https://compute.south.internal.com/v1",
|
||||
"enabled": false
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"region": "North",
|
||||
"global": true,
|
||||
"type": "object-store",
|
||||
"publicURL": "https://object-store.north.public.com/v1.0",
|
||||
"enabled": true
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"region": "South",
|
||||
"type": "object-store",
|
||||
"publicURL": "https://object-store.south.public.com/v2",
|
||||
"enabled": true
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"global": true,
|
||||
"type": "OS-DNS:DNS",
|
||||
"publicURL": "https://dns.public.com/v3.2",
|
||||
"enabled": true
|
||||
}
|
||||
],
|
||||
"OS-KSCATALOG:endpointsTemplates_links": []
|
||||
}
|
||||
@ -0,0 +1,50 @@
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"id": 1,
|
||||
"tenantId": "1",
|
||||
"region": "North",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"tenantId": "1",
|
||||
"region": "South",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"tenantId": "1",
|
||||
"region": "East",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"tenantId": "1",
|
||||
"region": "West",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"tenantId": "1",
|
||||
"region": "Global",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
}
|
||||
],
|
||||
"endpoints_links": []
|
||||
}
|
||||
@ -0,0 +1,18 @@
|
||||
{
|
||||
"credentials": [
|
||||
{
|
||||
"passwordCredentials": {
|
||||
"username": "test_user",
|
||||
"password": "secretsecret"
|
||||
}
|
||||
},
|
||||
{
|
||||
"OS-KSEC2-ec2Credentials": {
|
||||
"username": "test_user",
|
||||
"secret": "secretsecret",
|
||||
"signature": "bbb"
|
||||
}
|
||||
}
|
||||
],
|
||||
"credentials_links": []
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"OS-KSEC2-ec2Credentials": {
|
||||
"username": "test_user",
|
||||
"secret": "secretsecret",
|
||||
"signature": "bbb"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"OS-KSEC2-ec2Credentials": {
|
||||
"username": "test_user",
|
||||
"secret": "secretsecret",
|
||||
"signature": "bbb"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,18 @@
|
||||
{
|
||||
"credentials": [
|
||||
{
|
||||
"passwordCredentials": {
|
||||
"username": "test_user",
|
||||
"password": "secretsecret"
|
||||
}
|
||||
},
|
||||
{
|
||||
"OS-KSS3:s3Credentials": {
|
||||
"username": "test_user",
|
||||
"secret": "secretsecret",
|
||||
"signature": "bbb"
|
||||
}
|
||||
}
|
||||
],
|
||||
"credentials_links": []
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"OS-KSS3:s3Credentials": {
|
||||
"username": "test_user",
|
||||
"secret": "secretsecret",
|
||||
"signature": "bbb"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"OS-KSS3:s3Credentials": {
|
||||
"username": "test_user",
|
||||
"secret": "secretsecret",
|
||||
"signature": "bbb"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,50 @@
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"id": 1,
|
||||
"tenantId": "1",
|
||||
"region": "North",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"tenantId": "1",
|
||||
"region": "South",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"tenantId": "1",
|
||||
"region": "East",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"tenantId": "1",
|
||||
"region": "West",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"tenantId": "1",
|
||||
"region": "Global",
|
||||
"type": "compute",
|
||||
"publicURL": "https://compute.north.public.com/v1",
|
||||
"internalURL": "https://compute.north.internal.com/v1",
|
||||
"adminURL": "https://compute.north.internal.com/v1"
|
||||
}
|
||||
],
|
||||
"endpoints_links": []
|
||||
}
|
||||
@ -0,0 +1,28 @@
|
||||
{
|
||||
"access": {
|
||||
"token": {
|
||||
"id": "ab48a9efdfedb23ty3494",
|
||||
"expires": "2010-11-01T03:32:15-05:00",
|
||||
"tenant": {
|
||||
"id": "345",
|
||||
"name": "My Project"
|
||||
}
|
||||
},
|
||||
"user": {
|
||||
"id": "123",
|
||||
"name": "jqsmith",
|
||||
"roles": [
|
||||
{
|
||||
"id": "234",
|
||||
"name": "compute:admin"
|
||||
},
|
||||
{
|
||||
"id": "234",
|
||||
"name": "object-store:admin",
|
||||
"tenantId": "1"
|
||||
}
|
||||
],
|
||||
"roles_links": []
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,6 @@
|
||||
{
|
||||
"user": {
|
||||
"password": "old_secretsecret",
|
||||
"original_password": "secretsecret"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,9 @@
|
||||
{
|
||||
"auth": {
|
||||
"tenantName": "admin",
|
||||
"passwordCredentials": {
|
||||
"username": "admin",
|
||||
"password": "secretsecret"
|
||||
}
|
||||
}
|
||||
}
|
||||
184
api-ref/source/v2/samples/admin/authenticate-response.json
Normal file
184
api-ref/source/v2/samples/admin/authenticate-response.json
Normal file
@ -0,0 +1,184 @@
|
||||
{
|
||||
"access": {
|
||||
"token": {
|
||||
"issued_at": "2014-01-30T17:09:57.647795",
|
||||
"expires": "2014-01-31T17:09:57Z",
|
||||
"id": "admin_id",
|
||||
"tenant": {
|
||||
"description": null,
|
||||
"enabled": true,
|
||||
"id": "73f0aa26640f4971864919d0eb0f0880",
|
||||
"name": "admin"
|
||||
}
|
||||
},
|
||||
"serviceCatalog": [
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8774/v2/73f0aa26640f4971864919d0eb0f0880",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8774/v2/73f0aa26640f4971864919d0eb0f0880",
|
||||
"id": "2dad48f09e2a447a9bf852bcd93548ef",
|
||||
"publicURL": "http://23.253.72.207:8774/v2/73f0aa26640f4971864919d0eb0f0880"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "compute",
|
||||
"name": "nova"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:9696/",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:9696/",
|
||||
"id": "97c526db8d7a4c88bbb8d68db1bdcdb8",
|
||||
"publicURL": "http://23.253.72.207:9696/"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "network",
|
||||
"name": "neutron"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8776/v2/73f0aa26640f4971864919d0eb0f0880",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8776/v2/73f0aa26640f4971864919d0eb0f0880",
|
||||
"id": "93f86dfcbba143a39a33d0c2cd424870",
|
||||
"publicURL": "http://23.253.72.207:8776/v2/73f0aa26640f4971864919d0eb0f0880"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "volumev2",
|
||||
"name": "cinder"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8774/v3",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8774/v3",
|
||||
"id": "3eb274b12b1d47b2abc536038d87339e",
|
||||
"publicURL": "http://23.253.72.207:8774/v3"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "computev3",
|
||||
"name": "nova"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:3333",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:3333",
|
||||
"id": "957f1e54afc64d33a62099faa5e980a2",
|
||||
"publicURL": "http://23.253.72.207:3333"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "s3",
|
||||
"name": "s3"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:9292",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:9292",
|
||||
"id": "27d5749f36864c7d96bebf84a5ec9767",
|
||||
"publicURL": "http://23.253.72.207:9292"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "image",
|
||||
"name": "glance"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8776/v1/73f0aa26640f4971864919d0eb0f0880",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8776/v1/73f0aa26640f4971864919d0eb0f0880",
|
||||
"id": "37c83a2157f944f1972e74658aa0b139",
|
||||
"publicURL": "http://23.253.72.207:8776/v1/73f0aa26640f4971864919d0eb0f0880"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "volume",
|
||||
"name": "cinder"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8773/services/Admin",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8773/services/Cloud",
|
||||
"id": "289b59289d6048e2912b327e5d3240ca",
|
||||
"publicURL": "http://23.253.72.207:8773/services/Cloud"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "ec2",
|
||||
"name": "ec2"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8080",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8080/v1/AUTH_73f0aa26640f4971864919d0eb0f0880",
|
||||
"id": "16b76b5e5b7d48039a6e4cc3129545f3",
|
||||
"publicURL": "http://23.253.72.207:8080/v1/AUTH_73f0aa26640f4971864919d0eb0f0880"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "object-store",
|
||||
"name": "swift"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:35357/v2.0",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:5000/v2.0",
|
||||
"id": "26af053673df4ef3a2340c4239e21ea2",
|
||||
"publicURL": "http://23.253.72.207:5000/v2.0"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "identity",
|
||||
"name": "keystone"
|
||||
}
|
||||
],
|
||||
"user": {
|
||||
"username": "admin",
|
||||
"roles_links": [],
|
||||
"id": "1f568815cb8148688e6ee9b2f7527dcc",
|
||||
"roles": [
|
||||
{
|
||||
"name": "service"
|
||||
},
|
||||
{
|
||||
"name": "admin"
|
||||
}
|
||||
],
|
||||
"name": "admin"
|
||||
},
|
||||
"metadata": {
|
||||
"is_admin": 0,
|
||||
"roles": [
|
||||
"8341d3603a1d4d5985bff09f10704d4d",
|
||||
"2e66d57df76946fdbe034bc4da6fdec0"
|
||||
]
|
||||
},
|
||||
"trust": {
|
||||
"id": "394998fa61f14736b1f0c1f322882949",
|
||||
"trustee_user_id": "269348fdd9374b8885da1418e0730af1",
|
||||
"trustor_user_id": "3ec3164f750146be97f21559ee4d9c51",
|
||||
"impersonation": false
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"auth": {
|
||||
"tenantName": "demo",
|
||||
"token": {
|
||||
"id": "cbc36478b0bd8e67e89469c7749d4127"
|
||||
}
|
||||
}
|
||||
}
|
||||
122
api-ref/source/v2/samples/admin/endpoints-list-response.json
Normal file
122
api-ref/source/v2/samples/admin/endpoints-list-response.json
Normal file
@ -0,0 +1,122 @@
|
||||
{
|
||||
"endpoints_links": [],
|
||||
"endpoints": [
|
||||
{
|
||||
"name": "nova",
|
||||
"adminURL": "https://nova.region-one.internal.com/v2/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://nova.region-one.internal.com/v2/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"type": "compute",
|
||||
"id": "11b41ee1b00841128b7333d4bf1a6140",
|
||||
"publicURL": "https://nova.region-one.public.com/v2/be1319401cfa4a0aa590b97cc7b64d8d"
|
||||
},
|
||||
{
|
||||
"name": "neutron",
|
||||
"adminURL": "https://neutron.region-one.internal.com/",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://neutron.region-one.internal.com/",
|
||||
"type": "network",
|
||||
"id": "cdbfa3c416d741a9b5c968f2dc628acb",
|
||||
"publicURL": "https://neutron.region-one.public.com/"
|
||||
},
|
||||
{
|
||||
"name": "cinderv2",
|
||||
"adminURL": "https://cinderv2.region-one.internal.com/v2/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://cinderv2.region-one.internal.com/v2/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"type": "cinderv2v2",
|
||||
"id": "6de282e4132747ecb48f6fd8c525c6f6",
|
||||
"publicURL": "https://cinderv2.region-one.public.com/v2/be1319401cfa4a0aa590b97cc7b64d8d"
|
||||
},
|
||||
{
|
||||
"name": "trove",
|
||||
"adminURL": "https://trove.region-one.internal.com/v1.0/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://trove.region-one.internal.com/v1.0/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"type": "database",
|
||||
"id": "4bfad53a0c684bd981d093099eb7799b",
|
||||
"publicURL": "https://trove.region-one.public.com/v1.0/be1319401cfa4a0aa590b97cc7b64d8d"
|
||||
},
|
||||
{
|
||||
"name": "s3",
|
||||
"adminURL": "https://s3.region-one.internal.com",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://s3.region-one.internal.com",
|
||||
"type": "s3",
|
||||
"id": "50fb6b43cde44bb6b0e471a682dc42dd",
|
||||
"publicURL": "https://s3.region-one.public.com"
|
||||
},
|
||||
{
|
||||
"name": "glance",
|
||||
"adminURL": "https://glance.region-one.internal.com",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://glance.region-one.internal.com",
|
||||
"type": "glance",
|
||||
"id": "838a338171164c3c8f56e6b5882267ff",
|
||||
"publicURL": "https://glance.region-one.public.com"
|
||||
},
|
||||
{
|
||||
"name": "novav3",
|
||||
"adminURL": "https://novav3.region-one.internal.com/v3",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://novav3.region-one.internal.com/v3",
|
||||
"type": "computev3",
|
||||
"id": "b437edd03d244bf4be605b9b8c8689e0",
|
||||
"publicURL": "https://novav3.region-one.public.com/v3"
|
||||
},
|
||||
{
|
||||
"name": "heat",
|
||||
"adminURL": "https://heat.region-one.internal.comv1",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://heat.region-one.internal.comv1",
|
||||
"type": "cloudformation",
|
||||
"id": "7a0f6f37344d488fa596a1325e0fcf10",
|
||||
"publicURL": "https://heat.region-one.public.comv1"
|
||||
},
|
||||
{
|
||||
"name": "cinder",
|
||||
"adminURL": "https://cinder.region-one.internal.com/v1/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://cinder.region-one.internal.com/v1/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"type": "cinderv2",
|
||||
"id": "d4f251065dce4ce3946d3c1b87e167f2",
|
||||
"publicURL": "https://cinder.region-one.public.com/v1/be1319401cfa4a0aa590b97cc7b64d8d"
|
||||
},
|
||||
{
|
||||
"name": "ec2",
|
||||
"adminURL": "https://ec2.region-one.internal.com/services/Admin",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://ec2.region-one.internal.com/services/Cloud",
|
||||
"type": "ec2",
|
||||
"id": "44c6bf28d9bd4d63bfb00d66f22439a8",
|
||||
"publicURL": "https://ec2.region-one.public.com/services/Cloud"
|
||||
},
|
||||
{
|
||||
"name": "heat",
|
||||
"adminURL": "https://heat.region-one.internal.com/v1/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://heat.region-one.internal.com/v1/be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"type": "orchestration",
|
||||
"id": "21aaace3f33c46b8aaea2b17d41ffd54",
|
||||
"publicURL": "https://heat.region-one.public.com/v1/be1319401cfa4a0aa590b97cc7b64d8d"
|
||||
},
|
||||
{
|
||||
"name": "swift",
|
||||
"adminURL": "https://swift.region-one.internal.com",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://swift.region-one.internal.com/v1/AUTH_be1319401cfa4a0aa590b97cc7b64d8d",
|
||||
"type": "object-store",
|
||||
"id": "35f7aca3be384580a3b1df43a97c2eb2",
|
||||
"publicURL": "https://swift.region-one.public.com/v1/AUTH_be1319401cfa4a0aa590b97cc7b64d8d"
|
||||
},
|
||||
{
|
||||
"name": "keystone",
|
||||
"adminURL": "https://keystone.region-one.internal.com/v2.0",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "https://keystone.region-one.internal.com/v2.0",
|
||||
"type": "identity",
|
||||
"id": "48da758fb58c47dcaf02000a4409a265",
|
||||
"publicURL": "https://keystone.region-one.public.com/v2.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
16
api-ref/source/v2/samples/admin/extension-show-response.json
Normal file
16
api-ref/source/v2/samples/admin/extension-show-response.json
Normal file
@ -0,0 +1,16 @@
|
||||
{
|
||||
"extension": {
|
||||
"updated": "2013-07-07T12:00:0-00:00",
|
||||
"name": "OpenStack OAUTH1 API",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/OS-OAUTH1/v1.0",
|
||||
"alias": "OS-OAUTH1",
|
||||
"description": "OpenStack OAuth 1.0a Delegated Auth Mechanism."
|
||||
}
|
||||
}
|
||||
118
api-ref/source/v2/samples/admin/extensions-list-response.json
Normal file
118
api-ref/source/v2/samples/admin/extensions-list-response.json
Normal file
@ -0,0 +1,118 @@
|
||||
{
|
||||
"extensions": {
|
||||
"values": [
|
||||
{
|
||||
"updated": "2013-07-07T12:00:0-00:00",
|
||||
"name": "OpenStack S3 API",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/s3tokens/v1.0",
|
||||
"alias": "s3tokens",
|
||||
"description": "OpenStack S3 API."
|
||||
},
|
||||
{
|
||||
"updated": "2013-07-23T12:00:0-00:00",
|
||||
"name": "OpenStack Keystone Endpoint Filter API",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api/blob/master/openstack-identity-api/v3/src/markdown/identity-api-v3-os-ep-filter-ext.md",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/OS-EP-FILTER/v1.0",
|
||||
"alias": "OS-EP-FILTER",
|
||||
"description": "OpenStack Keystone Endpoint Filter API."
|
||||
},
|
||||
{
|
||||
"updated": "2014-02-24T20:51:0-00:00",
|
||||
"name": "OpenStack Revoke API",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api/blob/master/openstack-identity-api/v3/src/markdown/identity-api-v3-os-revoke-ext.md",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/OS-REVOKE/v1.0",
|
||||
"alias": "OS-REVOKE",
|
||||
"description": "OpenStack revoked token reporting mechanism."
|
||||
},
|
||||
{
|
||||
"updated": "2013-12-17T12:00:0-00:00",
|
||||
"name": "OpenStack Federation APIs",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/OS-FEDERATION/v1.0",
|
||||
"alias": "OS-FEDERATION",
|
||||
"description": "OpenStack Identity Providers Mechanism."
|
||||
},
|
||||
{
|
||||
"updated": "2013-07-11T17:14:00-00:00",
|
||||
"name": "OpenStack Keystone Admin",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/OS-KSADM/v1.0",
|
||||
"alias": "OS-KSADM",
|
||||
"description": "OpenStack extensions to Keystone v2.0 API enabling Administrative Operations."
|
||||
},
|
||||
{
|
||||
"updated": "2014-01-20T12:00:0-00:00",
|
||||
"name": "OpenStack Simple Certificate API",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/OS-SIMPLE-CERT/v1.0",
|
||||
"alias": "OS-SIMPLE-CERT",
|
||||
"description": "OpenStack simple certificate retrieval extension"
|
||||
},
|
||||
{
|
||||
"updated": "2013-07-07T12:00:0-00:00",
|
||||
"name": "OpenStack OAUTH1 API",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/OS-OAUTH1/v1.0",
|
||||
"alias": "OS-OAUTH1",
|
||||
"description": "OpenStack OAuth 1.0a Delegated Auth Mechanism."
|
||||
},
|
||||
{
|
||||
"updated": "2013-07-07T12:00:0-00:00",
|
||||
"name": "OpenStack EC2 API",
|
||||
"links": [
|
||||
{
|
||||
"href": "https://github.com/openstack/identity-api",
|
||||
"type": "text/html",
|
||||
"rel": "describedby"
|
||||
}
|
||||
],
|
||||
"namespace": "http://docs.openstack.org/identity/api/ext/OS-EC2/v1.0",
|
||||
"alias": "OS-EC2",
|
||||
"description": "OpenStack EC2 Credentials backend."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
10
api-ref/source/v2/samples/admin/roles-list-response.json
Normal file
10
api-ref/source/v2/samples/admin/roles-list-response.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"roles": [
|
||||
{
|
||||
"id": "123",
|
||||
"name": "compute:admin",
|
||||
"description": "Nova Administrator"
|
||||
}
|
||||
],
|
||||
"roles_links": []
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
{
|
||||
"tenant": {
|
||||
"id": "1234",
|
||||
"name": "ACME corp",
|
||||
"description": "A description ...",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,5 @@
|
||||
GET /v2.0/tenants HTTP/1.1
|
||||
Host: identity.api.openstack.org
|
||||
Content-Type: application/json
|
||||
X-Auth-Token: fa8426a0-8eaf-4d22-8e13-7c1b16a9370c
|
||||
Accept: application/json
|
||||
17
api-ref/source/v2/samples/admin/tenants-list-response.json
Normal file
17
api-ref/source/v2/samples/admin/tenants-list-response.json
Normal file
@ -0,0 +1,17 @@
|
||||
{
|
||||
"tenants": [
|
||||
{
|
||||
"id": "1234",
|
||||
"name": "ACME Corp",
|
||||
"description": "A description ...",
|
||||
"enabled": true
|
||||
},
|
||||
{
|
||||
"id": "3456",
|
||||
"name": "Iron Works",
|
||||
"description": "A description ...",
|
||||
"enabled": true
|
||||
}
|
||||
],
|
||||
"tenants_links": []
|
||||
}
|
||||
28
api-ref/source/v2/samples/admin/token-validate-response.json
Normal file
28
api-ref/source/v2/samples/admin/token-validate-response.json
Normal file
@ -0,0 +1,28 @@
|
||||
{
|
||||
"access": {
|
||||
"token": {
|
||||
"id": "ab48a9efdfedb23ty3494",
|
||||
"expires": "2010-11-01T03:32:15-05:00",
|
||||
"tenant": {
|
||||
"id": "345",
|
||||
"name": "My Project"
|
||||
}
|
||||
},
|
||||
"user": {
|
||||
"id": "123",
|
||||
"name": "jqsmith",
|
||||
"roles": [
|
||||
{
|
||||
"id": "234",
|
||||
"name": "compute:admin"
|
||||
},
|
||||
{
|
||||
"id": "234",
|
||||
"name": "object-store:admin",
|
||||
"tenantId": "1"
|
||||
}
|
||||
],
|
||||
"roles_links": []
|
||||
}
|
||||
}
|
||||
}
|
||||
9
api-ref/source/v2/samples/admin/user-create-request.json
Normal file
9
api-ref/source/v2/samples/admin/user-create-request.json
Normal file
@ -0,0 +1,9 @@
|
||||
{
|
||||
"user": {
|
||||
"email": "new-user@example.com",
|
||||
"password": null,
|
||||
"enabled": true,
|
||||
"name": "new-user",
|
||||
"tenantId": "40429f980fac419bbfec372a5607c154"
|
||||
}
|
||||
}
|
||||
10
api-ref/source/v2/samples/admin/user-create-response.json
Normal file
10
api-ref/source/v2/samples/admin/user-create-response.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"user": {
|
||||
"username": "new-user",
|
||||
"name": "new-user",
|
||||
"id": "71767c619a90479ab21626abf76aa46c",
|
||||
"enabled": true,
|
||||
"email": "new-user@example.com",
|
||||
"tenantId": "40429f980fac419bbfec372a5607c154"
|
||||
}
|
||||
}
|
||||
9
api-ref/source/v2/samples/admin/user-show-response.json
Normal file
9
api-ref/source/v2/samples/admin/user-show-response.json
Normal file
@ -0,0 +1,9 @@
|
||||
{
|
||||
"user": {
|
||||
"username": "nova",
|
||||
"name": "nova",
|
||||
"enabled": true,
|
||||
"email": null,
|
||||
"id": "405ecdef1a434c70bb1e441cd295245d"
|
||||
}
|
||||
}
|
||||
8
api-ref/source/v2/samples/admin/user-update-request.json
Normal file
8
api-ref/source/v2/samples/admin/user-update-request.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"user": {
|
||||
"username": "nova",
|
||||
"name": "nova",
|
||||
"enabled": false,
|
||||
"email": null
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,9 @@
|
||||
{
|
||||
"user": {
|
||||
"username": "nova",
|
||||
"name": "nova",
|
||||
"enabled": false,
|
||||
"email": null,
|
||||
"id": "71767c619a90479ab21626abf76aa46c"
|
||||
}
|
||||
}
|
||||
88
api-ref/source/v2/samples/admin/users-list-response.json
Normal file
88
api-ref/source/v2/samples/admin/users-list-response.json
Normal file
@ -0,0 +1,88 @@
|
||||
{
|
||||
"users": [
|
||||
{
|
||||
"username": "admin",
|
||||
"name": "admin",
|
||||
"enabled": true,
|
||||
"email": null,
|
||||
"id": "19dec86542d54bc791288b83d05c57a6"
|
||||
},
|
||||
{
|
||||
"username": "swift",
|
||||
"name": "swift",
|
||||
"enabled": true,
|
||||
"email": null,
|
||||
"id": "2109a7e134244071ac5b6ce31d8fe5b6"
|
||||
},
|
||||
{
|
||||
"username": "swiftusertest1",
|
||||
"name": "swiftusertest1",
|
||||
"enabled": true,
|
||||
"email": "test@example.com",
|
||||
"id": "3b59634090f84745bcd24bc28e564aff"
|
||||
},
|
||||
{
|
||||
"username": "alt_demo",
|
||||
"name": "alt_demo",
|
||||
"enabled": true,
|
||||
"email": "alt_demo@example.com",
|
||||
"id": "3f957317491c478daaee50992e5d2d3b"
|
||||
},
|
||||
{
|
||||
"username": "nova",
|
||||
"name": "nova",
|
||||
"enabled": true,
|
||||
"email": null,
|
||||
"id": "405ecdef1a434c70bb1e441cd295245d"
|
||||
},
|
||||
{
|
||||
"username": "swiftusertest3",
|
||||
"name": "swiftusertest3",
|
||||
"enabled": true,
|
||||
"email": "test3@example.com",
|
||||
"id": "5f58db25affc44c28d678279981c946f"
|
||||
},
|
||||
{
|
||||
"username": "swiftusertest2",
|
||||
"name": "swiftusertest2",
|
||||
"enabled": true,
|
||||
"email": "test2@example.com",
|
||||
"id": "9e4a840d8f5a45cdaa589febffcedb01"
|
||||
},
|
||||
{
|
||||
"username": "glance",
|
||||
"name": "glance",
|
||||
"enabled": true,
|
||||
"email": null,
|
||||
"id": "9f7df42d30264a0eb5f4e0d01486260d"
|
||||
},
|
||||
{
|
||||
"username": "demo",
|
||||
"name": "demo",
|
||||
"enabled": true,
|
||||
"email": "demo@example.com",
|
||||
"id": "a27a3939ad964215ad60315e8b2a3791"
|
||||
},
|
||||
{
|
||||
"username": "glance-swift",
|
||||
"name": "glance-swift",
|
||||
"enabled": true,
|
||||
"email": "glance-swift@example.com",
|
||||
"id": "bbe7ee42ffc345c18430599f74af9fa3"
|
||||
},
|
||||
{
|
||||
"username": "neutron",
|
||||
"name": "neutron",
|
||||
"enabled": true,
|
||||
"email": null,
|
||||
"id": "cf16ee300c2c412f81474ae452eda38d"
|
||||
},
|
||||
{
|
||||
"username": "cinder",
|
||||
"name": "cinder",
|
||||
"enabled": true,
|
||||
"email": null,
|
||||
"id": "f570fcf1692241978015cdb49242e383"
|
||||
}
|
||||
]
|
||||
}
|
||||
24
api-ref/source/v2/samples/admin/version-show-response.json
Normal file
24
api-ref/source/v2/samples/admin/version-show-response.json
Normal file
@ -0,0 +1,24 @@
|
||||
{
|
||||
"version": {
|
||||
"status": "stable",
|
||||
"updated": "2014-04-17T00:00:00Z",
|
||||
"media-types": [
|
||||
{
|
||||
"base": "application/json",
|
||||
"type": "application/vnd.openstack.identity-v2.0+json"
|
||||
}
|
||||
],
|
||||
"id": "v2.0",
|
||||
"links": [
|
||||
{
|
||||
"href": "http://localhost:5000/v2.0/",
|
||||
"rel": "self"
|
||||
},
|
||||
{
|
||||
"href": "http://docs.openstack.org/",
|
||||
"rel": "describedby",
|
||||
"type": "text/html"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
45
api-ref/source/v2/samples/admin/versions-list-response.json
Normal file
45
api-ref/source/v2/samples/admin/versions-list-response.json
Normal file
@ -0,0 +1,45 @@
|
||||
{
|
||||
"versions": {
|
||||
"values": [
|
||||
{
|
||||
"id": "v3.4",
|
||||
"links": [
|
||||
{
|
||||
"href": "http://localhost:35357/v3/",
|
||||
"rel": "self"
|
||||
}
|
||||
],
|
||||
"media-types": [
|
||||
{
|
||||
"base": "application/json",
|
||||
"type": "application/vnd.openstack.identity-v3+json"
|
||||
}
|
||||
],
|
||||
"status": "stable",
|
||||
"updated": "2015-03-30T00:00:00Z"
|
||||
},
|
||||
{
|
||||
"id": "v2.0",
|
||||
"links": [
|
||||
{
|
||||
"href": "http://localhost:35357/v2.0/",
|
||||
"rel": "self"
|
||||
},
|
||||
{
|
||||
"href": "http://docs.openstack.org/",
|
||||
"rel": "describedby",
|
||||
"type": "text/html"
|
||||
}
|
||||
],
|
||||
"media-types": [
|
||||
{
|
||||
"base": "application/json",
|
||||
"type": "application/vnd.openstack.identity-v2.0+json"
|
||||
}
|
||||
],
|
||||
"status": "stable",
|
||||
"updated": "2014-04-17T00:00:00Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,9 @@
|
||||
{
|
||||
"auth": {
|
||||
"tenantName": "demo",
|
||||
"passwordCredentials": {
|
||||
"username": "demo",
|
||||
"password": "secretsecret"
|
||||
}
|
||||
}
|
||||
}
|
||||
184
api-ref/source/v2/samples/client/authenticate-response.json
Normal file
184
api-ref/source/v2/samples/client/authenticate-response.json
Normal file
@ -0,0 +1,184 @@
|
||||
{
|
||||
"access": {
|
||||
"token": {
|
||||
"issued_at": "2014-01-30T15:30:58.819584",
|
||||
"expires": "2014-01-31T15:30:58Z",
|
||||
"id": "aaaaa-bbbbb-ccccc-dddd",
|
||||
"tenant": {
|
||||
"description": null,
|
||||
"enabled": true,
|
||||
"id": "fc394f2ab2df4114bde39905f800dc57",
|
||||
"name": "demo"
|
||||
}
|
||||
},
|
||||
"serviceCatalog": [
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8774/v2/fc394f2ab2df4114bde39905f800dc57",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8774/v2/fc394f2ab2df4114bde39905f800dc57",
|
||||
"id": "2dad48f09e2a447a9bf852bcd93548ef",
|
||||
"publicURL": "http://23.253.72.207:8774/v2/fc394f2ab2df4114bde39905f800dc57"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "compute",
|
||||
"name": "nova"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:9696/",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:9696/",
|
||||
"id": "97c526db8d7a4c88bbb8d68db1bdcdb8",
|
||||
"publicURL": "http://23.253.72.207:9696/"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "network",
|
||||
"name": "neutron"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8776/v2/fc394f2ab2df4114bde39905f800dc57",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8776/v2/fc394f2ab2df4114bde39905f800dc57",
|
||||
"id": "93f86dfcbba143a39a33d0c2cd424870",
|
||||
"publicURL": "http://23.253.72.207:8776/v2/fc394f2ab2df4114bde39905f800dc57"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "volumev2",
|
||||
"name": "cinder"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8774/v3",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8774/v3",
|
||||
"id": "3eb274b12b1d47b2abc536038d87339e",
|
||||
"publicURL": "http://23.253.72.207:8774/v3"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "computev3",
|
||||
"name": "nova"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:3333",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:3333",
|
||||
"id": "957f1e54afc64d33a62099faa5e980a2",
|
||||
"publicURL": "http://23.253.72.207:3333"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "s3",
|
||||
"name": "s3"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:9292",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:9292",
|
||||
"id": "27d5749f36864c7d96bebf84a5ec9767",
|
||||
"publicURL": "http://23.253.72.207:9292"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "image",
|
||||
"name": "glance"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8776/v1/fc394f2ab2df4114bde39905f800dc57",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8776/v1/fc394f2ab2df4114bde39905f800dc57",
|
||||
"id": "37c83a2157f944f1972e74658aa0b139",
|
||||
"publicURL": "http://23.253.72.207:8776/v1/fc394f2ab2df4114bde39905f800dc57"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "volume",
|
||||
"name": "cinder"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8773/services/Admin",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8773/services/Cloud",
|
||||
"id": "289b59289d6048e2912b327e5d3240ca",
|
||||
"publicURL": "http://23.253.72.207:8773/services/Cloud"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "ec2",
|
||||
"name": "ec2"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:8080",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:8080/v1/AUTH_fc394f2ab2df4114bde39905f800dc57",
|
||||
"id": "16b76b5e5b7d48039a6e4cc3129545f3",
|
||||
"publicURL": "http://23.253.72.207:8080/v1/AUTH_fc394f2ab2df4114bde39905f800dc57"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "object-store",
|
||||
"name": "swift"
|
||||
},
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"adminURL": "http://23.253.72.207:35357/v2.0",
|
||||
"region": "RegionOne",
|
||||
"internalURL": "http://23.253.72.207:5000/v2.0",
|
||||
"id": "26af053673df4ef3a2340c4239e21ea2",
|
||||
"publicURL": "http://23.253.72.207:5000/v2.0"
|
||||
}
|
||||
],
|
||||
"endpoints_links": [],
|
||||
"type": "identity",
|
||||
"name": "keystone"
|
||||
}
|
||||
],
|
||||
"user": {
|
||||
"username": "demo",
|
||||
"roles_links": [],
|
||||
"id": "9a6590b2ab024747bc2167c4e064d00d",
|
||||
"roles": [
|
||||
{
|
||||
"name": "Member"
|
||||
},
|
||||
{
|
||||
"name": "anotherrole"
|
||||
}
|
||||
],
|
||||
"name": "demo"
|
||||
},
|
||||
"metadata": {
|
||||
"is_admin": 0,
|
||||
"roles": [
|
||||
"7598ac3c634d4c3da4b9126a5f67ca2b",
|
||||
"f95c0ab82d6045d9805033ee1fbc80d4"
|
||||
]
|
||||
},
|
||||
"trust": {
|
||||
"id": "394998fa61f14736b1f0c1f322882949",
|
||||
"trustee_user_id": "269348fdd9374b8885da1418e0730af1",
|
||||
"trustor_user_id": "3ec3164f750146be97f21559ee4d9c51",
|
||||
"impersonation": false
|
||||
}
|
||||
}
|
||||
}
|
||||
39
api-ref/source/v2/versions.inc
Normal file
39
api-ref/source/v2/versions.inc
Normal file
@ -0,0 +1,39 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
============
|
||||
API versions
|
||||
============
|
||||
|
||||
|
||||
Show version details
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v2.0
|
||||
|
||||
Shows details for the Identity API v2.0.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:203,413,405,404,403,401,400,503,
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/admin/version-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
List versions
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /
|
||||
|
||||
Lists information about all Identity API versions.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:300,413,405,404,403,401,400,503,
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/admin/versions-list-response.json
|
||||
:language: javascript
|
||||
Loading…
Reference in New Issue
Block a user