Merge "Document v2 Revoked Token Route"

api-ref/source/v2/index.rst

@@ -10,3 +10,4 @@
 .. include:: identity-auth.inc
 .. include:: versions.inc
 .. include:: overview.inc
+.. include:: revocations.inc

api-ref/source/v2/parameters.yaml

@@ -146,6 +146,13 @@ serviceCatalog:
   in: body
   required: true
   type: array
+signed:
+  description: |
+    List of expired PKI tokens, signed by associated
+    cryptographic message syntax (CMS).
+  in: body
+  required: true
+  type: string
 tenant:
   description: |
     A ``tenant`` object.

api-ref/source/v2/revocations.inc

@@ -0,0 +1,32 @@
+.. -*- rst -*-
+
+=============
+ Revocations
+=============
+
+Allows the retrieval of revoked tokens.
+
+List Revoked Tokens (v2)
+========================
+
+.. rest_method:: GET /v2.0/tokens/revoked
+
+List the revoked tokens.
+
+Normal response codes: 200
+
+Error response codes: 400,401,403,404,405,413,503
+
+
+Response Parameters
+-------------------
+
+.. rest_parameters:: parameters.yaml
+
+    - signed: signed
+
+Response Example
+----------------
+
+.. literalinclude:: ./samples/admin/revoked-tokens-response.json
+   :language: javascript

api-ref/source/v2/samples/admin/revoked-tokens-response.json

@@ -0,0 +1,3 @@
+{
+  "signed": "-----BEGIN CMS-----\nMIICRAYJKoZIhvcNAQcCoIICNTCCAjECAQExDTALBglghkgBZQMEAgEwgZMGCSqG\nSIb3DQEHAaCBhQSBgnsicmV2b2tlZCI6IFt7ImV4cGlyZXMiOiAiMjAxNi0xMC0y\nNVQyMjoxNjowMloiLCAiaWQiOiAiN2UyMTE1NDQxZTIzNGJiYzhkYmU1ZGJmNTAz\nNjkxZWQiLCAiYXVkaXRfaWQiOiAicFlUY2hOOU9SdHl6VEo1ZHdmWWthZyJ9XX0x\nggGFMIIBgQIBATBcMFcxCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVVbnNldDEOMAwG\nA1UEBwwFVW5zZXQxDjAMBgNVBAoMBVVuc2V0MRgwFgYDVQQDDA93d3cuZXhhbXBs\nZS5jb20CAQEwCwYJYIZIAWUDBAIBMA0GCSqGSIb3DQEBAQUABIIBAGv3q67FaZrF\nN6XUDtWio/uxjwKX5GVs1yqd37Wd/vLmjjsyOiZuslzKZnrkoffeLcu74I2sJh4x\nFG8oQL99mck5Z9x8Uk8fLAInNwa/pZnqN9m7oh8+JYNiRwZVrZqO2fKEbH98JxB7\nuessJSUyHie3AUML5Zp/zhXg9Njf9sl3kTh+XIg0eBMTdamqvtimTrYMATIF+NF3\n950EOFKQU5gzG7K+7JyJPT+/uzgC/tSckHTAxnBlYqI74FHCkMSDCeJ5B7K+6yQ6\n3Eq4ugsxY5UKaYg3p/DXo4Muf7maMD+jhWL/mBqDAgPvmG50LSXLUB+/pyKXJULC\nSszEkgHpZpI=\n-----END CMS-----\n"
+}