ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
141 lines
2.3 KiB
ReStructuredText
141 lines
2.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=============================
|
|
OS-KSVALIDATE admin extension
|
|
=============================
|
|
|
|
|
|
|
|
|
|
List endpoints for token
|
|
========================
|
|
|
|
.. rest_method:: GET /v2.0/OS-KSVALIDATE/token/endpoints
|
|
|
|
Lists endpoints for a token.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/OS-KSVALIDATE/endpoints-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Validate token
|
|
==============
|
|
|
|
.. rest_method:: GET /v2.0/OS-KSVALIDATE/token/validate
|
|
|
|
Checks that a token is valid and that it belongs to the tenant and any service IDs. Returns the permissions for a particular client.
|
|
|
|
Behavior is similar to ``/tokens/{tokenId}``. If the token is not
|
|
valid, the call returns the ``itemNotFound (404)`` response code.
|
|
|
|
This extension might decrypt the ``X-Subject-Token`` header and
|
|
internally call and pass in all headers and query parameters to the
|
|
normal validation code for Identity. Consequently, this extension
|
|
must support all existing ``/tokens/{tokenId}`` calls including
|
|
extensions such as HP-IDM.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/OS-KSVALIDATE/token-validate-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Check token
|
|
===========
|
|
|
|
.. rest_method:: HEAD /v2.0/OS-KSVALIDATE/token/validate
|
|
|
|
Checks that a token is valid and that it belongs to the tenant and any service IDs, for performance.
|
|
|
|
Behavior is similar to ``/tokens/{tokenId}``. If the token is not
|
|
valid, the call returns the ``itemNotFound (404)`` response code.
|
|
|
|
This extension might decrypt the ``X-Subject-Token`` header and
|
|
internally call and pass in all headers and query parameters to the
|
|
normal validation code for Identity. Consequently, this extension
|
|
must support all existing ``/tokens/{tokenId}`` calls including
|
|
extensions such as HP-IDM.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude::
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|