From 2e70ecd8ce78f88048c77c4bb3e8455a5a437dd1 Mon Sep 17 00:00:00 2001 From: Samuel Pilla Date: Wed, 19 Oct 2016 10:44:29 -0500 Subject: [PATCH] Document OS-SIMPLE-CERT Routes Document certificates and OS-SIMPLE-CERT routes. Change-Id: I528c3eb27a5226a4da17a3c3aa2ca3ccc65a5a39 Closes-Bug: #1626779 --- .../source/v2-admin/admin-certificates.inc | 41 ++++++++++++++++++ api-ref/source/v2-admin/index.rst | 1 + .../admin/show-ca-certificate-v2-response.txt | 19 +++++++++ .../show-signing-certificate-v2-response.txt | 19 +++++++++ api-ref/source/v3-ext/index.rst | 2 + .../show-ca-certificate-response.txt | 19 +++++++++ .../show-signing-certificate-response.txt | 19 +++++++++ api-ref/source/v3-ext/simple-cert.inc | 42 +++++++++++++++++++ 8 files changed, 162 insertions(+) create mode 100644 api-ref/source/v2-admin/admin-certificates.inc create mode 100644 api-ref/source/v2-admin/samples/admin/show-ca-certificate-v2-response.txt create mode 100644 api-ref/source/v2-admin/samples/admin/show-signing-certificate-v2-response.txt create mode 100644 api-ref/source/v3-ext/samples/OS-SIMPLE-CERT/show-ca-certificate-response.txt create mode 100644 api-ref/source/v3-ext/samples/OS-SIMPLE-CERT/show-signing-certificate-response.txt create mode 100644 api-ref/source/v3-ext/simple-cert.inc diff --git a/api-ref/source/v2-admin/admin-certificates.inc b/api-ref/source/v2-admin/admin-certificates.inc new file mode 100644 index 0000000000..e010e050f8 --- /dev/null +++ b/api-ref/source/v2-admin/admin-certificates.inc @@ -0,0 +1,41 @@ +.. -*- rst -*- + +============ +Certificates +============ + +Allows the retrieval of information for Certificate Authorities and certificates. + +Show CA Certificate (v2) +======================== + +.. rest_method:: GET /v2.0/certificates/ca + +Show the available CA certificate. + +Normal response codes: 200 + +Error response codes: 401, 500 + +Response Example +---------------- + +.. literalinclude:: ./samples/admin/show-ca-certificate-v2-response.txt + :language: text + +Show Signing Certificate (v2) +============================= + +.. rest_method:: GET /v2.0/certificates/signing + +Show the available signing certificate. + +Normal response codes: 200 + +Error response codes: 401, 500 + +Response Example +---------------- + +.. literalinclude:: ./samples/admin/show-signing-certificate-v2-response.txt + :language: text diff --git a/api-ref/source/v2-admin/index.rst b/api-ref/source/v2-admin/index.rst index 5039597af5..5aa7e4c39b 100644 --- a/api-ref/source/v2-admin/index.rst +++ b/api-ref/source/v2-admin/index.rst @@ -11,3 +11,4 @@ .. include:: admin-users.inc .. include:: admin-endpoints.inc .. include:: admin-versions.inc +.. include:: admin-certificates.inc diff --git a/api-ref/source/v2-admin/samples/admin/show-ca-certificate-v2-response.txt b/api-ref/source/v2-admin/samples/admin/show-ca-certificate-v2-response.txt new file mode 100644 index 0000000000..8a9e3c3653 --- /dev/null +++ b/api-ref/source/v2-admin/samples/admin/show-ca-certificate-v2-response.txt @@ -0,0 +1,19 @@ +MIIDgTCCAmmgAwIBAgIJAIr3n9+0RSC7MA0GCSqGSIb3DQEBCwUAMFcxCzAJBgNV +BAYTAlVTMQ4wDAYDVQQIDAVVbnNldDEOMAwGA1UEBwwFVW5zZXQxDjAMBgNVBAoM +BVVuc2V0MRgwFgYDVQQDDA93d3cuZXhhbXBsZS5jb20wHhcNMTYxMDIwMTMwMjE4 +WhcNMjYxMDE4MTMwMjE4WjBXMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVW5zZXQx +DjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEYMBYGA1UEAwwPd3d3LmV4 +YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwoJkYpfJ +Bvqfq0eAuqTIziiunNQdnSUX/aMS5UuI6tjzSkYnR5FCdf9UP8OrpA37gthvz3KK +XhNLqnnV8MLzEo3+lN5IAr+TE1foXnqGs6vNvj5Jn1lViXXpIeaHxMwkJpJjPwxJ +nFLtxL1m9hIx5anV5ZyJWV8RIaMqnzOJ7QYiX07aouRvmtT5O1LQzr2ht2l4EzPY +YDt9UV/daSikrmroBnwgWMecaFJOC1pxSyvO2PAnw+yhX6NHgGPJmOu0TSN2IK1p +o07ZVM3QJLLbEZFjcUK7FXNRk5ZfzjkCrJA1l0Ys3ByHTb2offffIyTYPuatQtfF +0XvTIwMN5eIAswIDAQABo1AwTjAMBgNVHRMEBTADAQH/MB0GA1UdDgQWBBTZ4Nls +7DRmUBcrYhYDLSsDM0BCWzAfBgNVHSMEGDAWgBTZ4Nls7DRmUBcrYhYDLSsDM0BC +WzANBgkqhkiG9w0BAQsFAAOCAQEALil6WvVii6yNVwu0zgt2iDYqHvnnHWnSVhEJ +eKeBFRxpuwiH+UOeygFB0/6lD2r11cD0SdgaMfLAKkKspQucJIsp3BYLwBJ25oxn +NL2yB3HLZeEebAQzXQwnRbWUbIpcp/XPlKjybiA3unqE+X/qdQZgxJ2Xgtp7bHhN +yzDCSOUZlHrkKNXtFNvqRtoCeMBs2+jfqx2ap64ORSnLihEi57lOcUn2DbAR45OI ++wppD5CcUTDsE0r+XbBK3Cm3dn6pVyVcawv5qDidRB7JdsDbx6VC7gcBbdgdbLWz +Xf4KS8N77jeGjqKJ7QY5jkHdXhY+gGbeponch4y2VqLgMI0VGQ== diff --git a/api-ref/source/v2-admin/samples/admin/show-signing-certificate-v2-response.txt b/api-ref/source/v2-admin/samples/admin/show-signing-certificate-v2-response.txt new file mode 100644 index 0000000000..9d6050cdb7 --- /dev/null +++ b/api-ref/source/v2-admin/samples/admin/show-signing-certificate-v2-response.txt @@ -0,0 +1,19 @@ +MIIDZjCCAk6gAwIBAgIBATANBgkqhkiG9w0BAQsFADBXMQswCQYDVQQGEwJVUzEO +MAwGA1UECAwFVW5zZXQxDjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEY +MBYGA1UEAwwPd3d3LmV4YW1wbGUuY29tMB4XDTE2MTAyMDEzMDIxOFoXDTI2MTAx +ODEzMDIxOFowRzELMAkGA1UEBhMCVVMxDjAMBgNVBAgMBVVuc2V0MQ4wDAYDVQQK +DAVVbnNldDEYMBYGA1UEAwwPd3d3LmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0B +AQEFAAOCAQ8AMIIBCgKCAQEAua3cVYSD9KY31+wNXZv3HBS5MyzTfoY+nh4nJ2x8 +Ram6liu4gkHYRonTUriIrgDLyo+2fuXrmyFcq1+8ke4KD3n24i8pzcrt6BOGAVYP +KdPyXU0EkZECNmH/tKjvVqMLHcq2apsZdZ5ujBtE5G4zbTjVIEzz90AbAmRVJy7S +seluCxBKtg3IGa1WwqgU4B5pgog+VDpT8XPKFvHi1cVaX76qS6MOUxXA7kuOQUct +JxcyITS26Mxym7wOTI+7JV5A9Ow/dUN6CrGMrfHB59Psx3os/BfoopFmIbbnHdOO +ETOeifelkhwLWLfmmOHxWgYYX/aEyW3L/xCU5QDCz9B0wQIDAQABo00wSzAJBgNV +HRMEAjAAMB0GA1UdDgQWBBQeoHzsYSUSfGymk6kem/lpGVJS9DAfBgNVHSMEGDAW +gBTZ4Nls7DRmUBcrYhYDLSsDM0BCWzANBgkqhkiG9w0BAQsFAAOCAQEAfsH6AN7p +XWBg062LUtpfDsRyXqOLYofR4Y0Mzo1rH0jaozJsnOxsj42BdP+hBGjtZB9eUwgP +gx+MJQC4pz+Wuc/xMysDT6f0hyjZmsakXM92lsztlW7+Y7u9ATa2lDTER1Fv7X6D +I+kN+dhphq0lrIRWZvAf3TlZpEUG38cTxLD8OsdOlq4BxSzmvKFQf4mcbu39OX7i +0fGih0SxSa03idx9NWEOEp9IaGLo/mfL84nb4YjgV9yJj+3CkxYvqPlpiM2rHD/C +hMgz/UB52OxbjYjbWoyStZwvlSwKWY75C9iYA04TZrhs5UWvAT+I2Y2UY/krrZ2a +Rke2Bj7NAvXPHw== diff --git a/api-ref/source/v3-ext/index.rst b/api-ref/source/v3-ext/index.rst index 5cfd4b3157..39e19f7165 100644 --- a/api-ref/source/v3-ext/index.rst +++ b/api-ref/source/v3-ext/index.rst @@ -12,6 +12,7 @@ This page describes these Identity API v3 extensions: * `OS-REVOKE API`_ * `OS-EP-FILTER API`_ * `OS-FEDERATION API`_ +* `OS-SIMPLE-CERT API`_ .. rest_expand_all:: @@ -21,3 +22,4 @@ This page describes these Identity API v3 extensions: .. include:: revoke.inc .. include:: ep-filter.inc .. include:: federation.inc +.. include:: simple-cert.inc diff --git a/api-ref/source/v3-ext/samples/OS-SIMPLE-CERT/show-ca-certificate-response.txt b/api-ref/source/v3-ext/samples/OS-SIMPLE-CERT/show-ca-certificate-response.txt new file mode 100644 index 0000000000..8a9e3c3653 --- /dev/null +++ b/api-ref/source/v3-ext/samples/OS-SIMPLE-CERT/show-ca-certificate-response.txt @@ -0,0 +1,19 @@ +MIIDgTCCAmmgAwIBAgIJAIr3n9+0RSC7MA0GCSqGSIb3DQEBCwUAMFcxCzAJBgNV +BAYTAlVTMQ4wDAYDVQQIDAVVbnNldDEOMAwGA1UEBwwFVW5zZXQxDjAMBgNVBAoM +BVVuc2V0MRgwFgYDVQQDDA93d3cuZXhhbXBsZS5jb20wHhcNMTYxMDIwMTMwMjE4 +WhcNMjYxMDE4MTMwMjE4WjBXMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVW5zZXQx +DjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEYMBYGA1UEAwwPd3d3LmV4 +YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwoJkYpfJ +Bvqfq0eAuqTIziiunNQdnSUX/aMS5UuI6tjzSkYnR5FCdf9UP8OrpA37gthvz3KK +XhNLqnnV8MLzEo3+lN5IAr+TE1foXnqGs6vNvj5Jn1lViXXpIeaHxMwkJpJjPwxJ +nFLtxL1m9hIx5anV5ZyJWV8RIaMqnzOJ7QYiX07aouRvmtT5O1LQzr2ht2l4EzPY +YDt9UV/daSikrmroBnwgWMecaFJOC1pxSyvO2PAnw+yhX6NHgGPJmOu0TSN2IK1p +o07ZVM3QJLLbEZFjcUK7FXNRk5ZfzjkCrJA1l0Ys3ByHTb2offffIyTYPuatQtfF +0XvTIwMN5eIAswIDAQABo1AwTjAMBgNVHRMEBTADAQH/MB0GA1UdDgQWBBTZ4Nls +7DRmUBcrYhYDLSsDM0BCWzAfBgNVHSMEGDAWgBTZ4Nls7DRmUBcrYhYDLSsDM0BC +WzANBgkqhkiG9w0BAQsFAAOCAQEALil6WvVii6yNVwu0zgt2iDYqHvnnHWnSVhEJ +eKeBFRxpuwiH+UOeygFB0/6lD2r11cD0SdgaMfLAKkKspQucJIsp3BYLwBJ25oxn +NL2yB3HLZeEebAQzXQwnRbWUbIpcp/XPlKjybiA3unqE+X/qdQZgxJ2Xgtp7bHhN +yzDCSOUZlHrkKNXtFNvqRtoCeMBs2+jfqx2ap64ORSnLihEi57lOcUn2DbAR45OI ++wppD5CcUTDsE0r+XbBK3Cm3dn6pVyVcawv5qDidRB7JdsDbx6VC7gcBbdgdbLWz +Xf4KS8N77jeGjqKJ7QY5jkHdXhY+gGbeponch4y2VqLgMI0VGQ== diff --git a/api-ref/source/v3-ext/samples/OS-SIMPLE-CERT/show-signing-certificate-response.txt b/api-ref/source/v3-ext/samples/OS-SIMPLE-CERT/show-signing-certificate-response.txt new file mode 100644 index 0000000000..9d6050cdb7 --- /dev/null +++ b/api-ref/source/v3-ext/samples/OS-SIMPLE-CERT/show-signing-certificate-response.txt @@ -0,0 +1,19 @@ +MIIDZjCCAk6gAwIBAgIBATANBgkqhkiG9w0BAQsFADBXMQswCQYDVQQGEwJVUzEO +MAwGA1UECAwFVW5zZXQxDjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEY +MBYGA1UEAwwPd3d3LmV4YW1wbGUuY29tMB4XDTE2MTAyMDEzMDIxOFoXDTI2MTAx +ODEzMDIxOFowRzELMAkGA1UEBhMCVVMxDjAMBgNVBAgMBVVuc2V0MQ4wDAYDVQQK +DAVVbnNldDEYMBYGA1UEAwwPd3d3LmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0B +AQEFAAOCAQ8AMIIBCgKCAQEAua3cVYSD9KY31+wNXZv3HBS5MyzTfoY+nh4nJ2x8 +Ram6liu4gkHYRonTUriIrgDLyo+2fuXrmyFcq1+8ke4KD3n24i8pzcrt6BOGAVYP +KdPyXU0EkZECNmH/tKjvVqMLHcq2apsZdZ5ujBtE5G4zbTjVIEzz90AbAmRVJy7S +seluCxBKtg3IGa1WwqgU4B5pgog+VDpT8XPKFvHi1cVaX76qS6MOUxXA7kuOQUct +JxcyITS26Mxym7wOTI+7JV5A9Ow/dUN6CrGMrfHB59Psx3os/BfoopFmIbbnHdOO +ETOeifelkhwLWLfmmOHxWgYYX/aEyW3L/xCU5QDCz9B0wQIDAQABo00wSzAJBgNV +HRMEAjAAMB0GA1UdDgQWBBQeoHzsYSUSfGymk6kem/lpGVJS9DAfBgNVHSMEGDAW +gBTZ4Nls7DRmUBcrYhYDLSsDM0BCWzANBgkqhkiG9w0BAQsFAAOCAQEAfsH6AN7p +XWBg062LUtpfDsRyXqOLYofR4Y0Mzo1rH0jaozJsnOxsj42BdP+hBGjtZB9eUwgP +gx+MJQC4pz+Wuc/xMysDT6f0hyjZmsakXM92lsztlW7+Y7u9ATa2lDTER1Fv7X6D +I+kN+dhphq0lrIRWZvAf3TlZpEUG38cTxLD8OsdOlq4BxSzmvKFQf4mcbu39OX7i +0fGih0SxSa03idx9NWEOEp9IaGLo/mfL84nb4YjgV9yJj+3CkxYvqPlpiM2rHD/C +hMgz/UB52OxbjYjbWoyStZwvlSwKWY75C9iYA04TZrhs5UWvAT+I2Y2UY/krrZ2a +Rke2Bj7NAvXPHw== diff --git a/api-ref/source/v3-ext/simple-cert.inc b/api-ref/source/v3-ext/simple-cert.inc new file mode 100644 index 0000000000..2ed273d1c7 --- /dev/null +++ b/api-ref/source/v3-ext/simple-cert.inc @@ -0,0 +1,42 @@ +.. -*- rst -*- + +==================== + OS-SIMPLE-CERT API +==================== + +Allows the retrieval of information for Certificate Authorities and certificates. +Requires v3.0+ of the Identity API. + +Show CA Certificate +=================== + +.. rest_method:: GET /v3/OS-SIMPLE-CERT/ca + +Show the availbable CA certificate. + +Normal response codes: 200 + +Error response codes: 401, 500 + +Response Example +---------------- + +.. literalinclude:: ./samples/OS-SIMPLE-CERT/show-ca-certificate-response.txt + :language: text + +Show Signing Certificate +======================== + +.. rest_method:: GET /v3/OS-SIMPLE-CERT/certificates + +Show the available signing certificate. + +Normal response codes: 200 + +Error response codes: 401, 500 + +Response Example +---------------- + +.. literalinclude:: ./samples/OS-SIMPLE-CERT/show-signing-certificate-response.txt + :language: text