Browse Source

Merge "Refactor Keystone admin-tokens and admin-users v2"

changes/33/383333/10
Jenkins 5 years ago
committed by Gerrit Code Review
parent
commit
309b1adbfe
  1. 38
      api-ref/source/v2-admin/admin-tokens.inc
  2. 78
      api-ref/source/v2-admin/admin-users.inc
  3. 189
      api-ref/source/v2-admin/parameters.yaml

38
api-ref/source/v2-admin/admin-tokens.inc

@ -20,7 +20,7 @@ Request
.. rest_parameters:: parameters.yaml
- tokenId: tokenId
- tokenId: token_id_path
Response Example
----------------
@ -76,25 +76,22 @@ 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
- access: access
- issued_at: token_issued_at
- expires: token_expires
- id: token_id
- tenant: tenant
- description: tenant_description
- serviceCatalog: serviceCatalog
- type: serviceCatalog_type
- endpoints_links: serviceCatalog_endpoints_links
- impersonation: impersonation
- endpoints: endpoints
- user: user
- roles: roles
- metadata: metadata
- trust: trust
Response Example
----------------
@ -126,7 +123,7 @@ Request
.. rest_parameters:: parameters.yaml
- tokenId: tokenId
- tokenId: token_id_path
- belongsTo: belongsTo
Response Example
@ -155,10 +152,9 @@ Request
.. rest_parameters:: parameters.yaml
- tokenId: tokenId
- tokenId: token_id_path
- belongsTo: belongsTo
Delete token
============
@ -174,4 +170,4 @@ Request
.. rest_parameters:: parameters.yaml
- tokenId: tokenId
- tokenId: token_id_path

78
api-ref/source/v2-admin/admin-users.inc

@ -20,18 +20,18 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- userId: user_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- roles_links: roles_links
- roles: roles
- description: description
- name: name
- id: id
- roles_links: roles_links
- description: role_description
- name: role_name
- id: role_id
Response Example
----------------
@ -55,12 +55,13 @@ Request
.. rest_parameters:: parameters.yaml
- tenantId: tenantId
- password: password
- enabled: enabled
- email: email
- name: name
- X-Auth-Token: X-Auth-Token
- user: user
- tenantId: tenant_id_path
- password: user_password
- enabled: user_enabled
- email: user_email
- name: user_name
- username: username_request
Request Example
---------------
@ -73,11 +74,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- user: user
- enabled: user_enabled
- email: user_email
- name: user_name
- username: username
- enabled: enabled
- email: email
- name: name
- id: id
- id: user_id
List users (admin endpoint)
@ -98,12 +100,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- username: username
- users: users
- enabled: enabled
- id: id
- email: email
- name: name
- enabled: user_enabled
- id: user_id
- email: user_email
- name: user_name
- username: username
Response Example
----------------
@ -127,12 +129,11 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- username: username
- enabled: enabled
- email: email
- name: name
- tenantId: tenantId
- userId: user_id_path
- user: user
- enabled: user_enabled
- email: user_email
- name: user_name
Request Example
---------------
@ -145,12 +146,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- users: users
- enabled: enabled
- email: email
- name: name
- id: id
- tenantId: tenantId
- user: user
- enabled: user_enabled
- email: user_email
- name: user_name
- username: username
- id: user_id
Response Example
----------------
@ -174,7 +175,7 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- userId: user_id_path
Show user details (admin endpoint)
@ -209,18 +210,19 @@ Request
.. rest_parameters:: parameters.yaml
- userId: userId
- userId: user_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- user: user
- enabled: user_enabled
- email: user_email
- name: user_name
- username: username
- enabled: enabled
- email: email
- name: name
- id: id
- id: user_id
Response Example
----------------

189
api-ref/source/v2-admin/parameters.yaml

@ -20,13 +20,7 @@ tenant_id_path:
in: path
required: true
type: string
tenantId:
description: |
The tenant ID.
in: path
required: false
type: string
tokenId:
token_id_path:
description: |
The authentication token for which to perform the
operation.
@ -39,12 +33,6 @@ user_id_path:
in: path
required: true
type: string
userId:
description: |
The user ID.
in: path
required: true
type: string
# variables in query
belongsTo:
@ -67,13 +55,6 @@ access:
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
email:
description: |
The user email.
@ -124,6 +105,12 @@ endpoint_internalurl_response:
in: body
required: true
type: string
endpoint_name:
description: |
Endpoint name.
in: body
required: true
type: string
endpoint_publicurl_request:
description: |
Public URL
@ -148,6 +135,12 @@ endpoint_region_response:
in: body
required: true
type: string
endpoint_type:
description: |
Endpoint type.
in: body
required: true
type: string
endpoints:
description: |
One or more ``endpoint`` objects. Each object
@ -156,62 +149,12 @@ endpoints:
in: body
required: true
type: array
endpoints_links:
description: |
Links for the endpoint.
in: body
required: true
type: string
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 ID of the trust.
in: body
required: false
type: string
impersonation:
description: |
The impersonation flag.
in: body
required: false
type: string
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
location:
format: uri
in: body
@ -223,24 +166,18 @@ metadata:
in: body
required: true
type: string
name:
metadata_is_admin:
description: |
Endpoint name.
Indicates whether the metadata is admin or not.
in: body
required: true
type: string
name_1:
type: boolean
metadata_roles:
description: |
The user name.
List of roles ID related to the metadata.
in: body
required: true
type: string
password:
description: |
The user password.
in: body
required: false
type: string
type: array
role_description:
description: |
The role description.
@ -283,6 +220,18 @@ serviceCatalog:
in: body
required: true
type: string
serviceCatalog_endpoints_links:
description: |
Links for the endpoint.
in: body
required: true
type: string
serviceCatalog_type:
description: |
The service catalog type.
in: body
required: true
type: string
tenant:
description: |
A ``tenant`` object.
@ -333,27 +282,77 @@ token:
in: body
required: true
type: string
token_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
token_id:
description: |
The token ID.
in: body
required: true
type: string
token_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
trust:
description: |
A ``trust`` object.
in: body
required: false
type: string
trustee_user_id:
trust_id:
description: |
The trustee user ID.
The ID of the trust.
in: body
required: false
required: true
type: string
trustor_user_id:
trust_impersonation:
description: |
The trustor user ID.
The impersonation flag.
in: body
required: false
type: string
type:
trust_trustee_user_id:
description: |
Endpoint type.
The trustee user ID.
in: body
required: true
type: string
trust_trustor_user_id:
description: |
The trustor user ID.
in: body
required: true
type: string
@ -389,12 +388,24 @@ user_name:
in: body
required: true
type: string
user_password:
description: |
The user password.
in: body
required: false
type: string
username:
description: |
The username of user.
in: body
required: true
type: string
username_request:
description: |
The username of user.
in: body
required: false
type: string
users:
description: |
One or more ``user`` objects.

Loading…
Cancel
Save