SSL Certificate Signing Requests¶
Overview¶
This document describes the API to retrieve information about SSL Certificate Signing Request objects.
REST Endpoint: /mgmt/cm/adc-core/working-config/sys/file/ssl-csr¶
Requests¶
GET /mgmt/cm/adc-core/working-config/sys/file/ssl-csr/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
adminEmail | string | The admin email address from the certificate signing request. Usually the certificate administrator or IT department. |
challengePassword | string | The challenge password from the certificate signing request, in an encrypted form. This is a password used to authenticate the owner/administrator for the certificate. |
csrText | string | The text of the certificate signing request, in PEM format. |
string | The email portion of the certificate signing request subject. | |
groupingKey | string | A token that identifies related objects of different types, for internal use. |
keyCurveName | string | For a certificate signing request using an eliptical curve key, this is the name of the curve. Possible values include “prime256v1”, “secp384r1”, “secp521r1”, or “none” if the key type is not eliptical curve. |
keySize | number | For a certificate siging request using a RSA or DSA key, this is the size of the key in bits. |
keyType | string | The type of the key for the certificate signing request. Possible values include “rsa-private”, “rsa-public”, “dsa-private”, “dsa-public”, “ec-private”, and “ec-public”. |
subject | string | The subject string from the certificate signing request. |
subjectAlternativeName | string | The subject alternative name from the certificate signing request. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | Yes |
Service_Catalog_Viewer | Yes |
ADC_Manager | Yes |
Service_Catalog_Editor | Yes |
ADC_Deployer | Yes |
Application_Viewer | Yes |
ADC_Editor | Yes |
Trust_Discovery_Import | Yes |
ADC_Viewer | Yes |
Application_Manager | Yes |
DELETE /mgmt/cm/adc-core/working-config/sys/file/ssl-csr/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
adminEmail | string | The admin email address from the certificate signing request. Usually the certificate administrator or IT department. |
challengePassword | string | The challenge password from the certificate signing request, in an encrypted form. This is a password used to authenticate the owner/administrator for the certificate. |
csrText | string | The text of the certificate signing request, in PEM format. |
string | The email portion of the certificate signing request subject. | |
groupingKey | string | A token that identifies related objects of different types, for internal use. |
keyCurveName | string | For a certificate signing request using an eliptical curve key, this is the name of the curve. Possible values include “prime256v1”, “secp384r1”, “secp521r1”, or “none” if the key type is not eliptical curve. |
keySize | number | For a certificate siging request using a RSA or DSA key, this is the size of the key in bits. |
keyType | string | The type of the key for the certificate signing request. Possible values include “rsa-private”, “rsa-public”, “dsa-private”, “dsa-public”, “ec-private”, and “ec-public”. |
subject | string | The subject string from the certificate signing request. |
subjectAlternativeName | string | The subject alternative name from the certificate signing request. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
Service_Catalog_Viewer | No |
ADC_Manager | Yes |
Service_Catalog_Editor | No |
ADC_Deployer | No |
Application_Viewer | No |
ADC_Editor | Yes |
Trust_Discovery_Import | No |
ADC_Viewer | No |
Application_Manager | No |
Examples¶
List a SSL Certificate Signing Request’s properties¶
GET /mgmt/cm/adc-core/working-config/sys/file/ssl-csr/<id>
Response¶
HTTP/1.1 200 OK
{
"adminEmail": "admin@example.com",
"challengePassword": "RzZNO4zK4emp/MAPz4LU+lmmLKA35mu61S8dpPQCDBU=",
"csrText": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDZzCCAk8CAQAwgawxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9u\nMRAwDgYDVQQHEwdTZWF0dGxlMR0wGwYDVQQKExRFeGFtcGxlIE9yZ2FuaXphdGlv\nbjEVMBMGA1UECxMMRXhhbXBsZSBVbml0MRQwEgYDVQQDEwtleGFtcGxlLmNvbTEq\nMCgGCSqGSIb3DQEJARYbZXhhbXBsZS1hZGRyZXNzQGV4YW1wbGUuY29tMIIBIjAN\nBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAluIEwU7xEo4wSOXLildtaOPqXY+e\nko8LxGOn+SwE08FPYL21NPNTFJCfQROx7Roo430FfYv84QkJ03hjvQgPxno+F2WM\n/PxheiNYWmQyTdAA6Wrbuk7Tv6Lazdjhg52e1pg30BAoShQYVlsFnIEZlt5f8gE0\n5hHo7FgjvZti7v7rnUL+IEi1yMPWdhC/w0LRN6g4oshpX4NdGwvDLNjAwNZOwYvN\nHx7/WnkTJ2mR4dR/MtCvXliPPdIxFIf2TYXR+GgBGG83vjWZ0NZknGfG4c57VEBD\nYOgtH1YeIAxVQiAYXqTLkBlUgcWh3m7H6qddrtuEpl6QNx0RxIVI/AuNqwIDAQAB\noHUwGAYJKoZIhvcNAQkHMQsTCWNoYWxsZW5nZTAgBgkqhkiG9w0BCQExExYRYWRt\naW5AZXhhbXBsZS5jb20wNwYJKoZIhvcNAQkOMSowKDAmBgNVHREEHzAdgRtleGFt\ncGxlLWFkZHJlc3NAZXhhbXBsZS5jb20wDQYJKoZIhvcNAQENBQADggEBAAs8eaAF\nLztvE0NwoDF9dPz5h1bdjt5aP4wHdqFsHgGvTfAAU1ux4yYJJladuQZhdvR1x+XF\nPuZRWPh18HqYweDYF64proMuMyQKREkJoopHTOyJfzt8rAiPzoyAsJvT8N1tzb8L\nh8NNqpMarboouWg5SYfwQR/S3irYl1Qc7nhJLC1Frf7hSsdlFhYGCT57YOyZtoge\nwkl2ANpSD8nYSbnPkhfs2OP7IMoj/vw18TIJ++75v6JxRK1XE2XOfxtqoE4GiJGq\nkRPl74sfA8yX0J0OeCbF9VlNmiCmuRbBD6p/kb496ZbQb/wzECuvX+WCZwJqPu9o\n3A9YPsw/xmRq0wM=\n-----END CERTIFICATE REQUEST-----\n",
"email": "example-address@example.com",
"generation": 1,
"groupingKey": "/Common/example.grouping-suffix-50453eb1-4c24-481f-b4eb-30ac613aace7",
"id": "5d928645-b81e-3c62-8d38-92ddfc9e9402",
"keySize": 2048,
"keyType": "rsa-public",
"kind": "cm:adc-core:working-config:sys:file:ssl-csr:adcsslcsrstate",
"lastUpdateMicros": 1527113415373577,
"name": "example.csr",
"partition": "Common",
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-csr/5d928645-b81e-3c62-8d38-92ddfc9e9402",
"subject": "E=example-address@example.com,CN=example.com,OU=Example Unit,O=Example Organization,L=Seattle,ST=Washington,C=US",
"subjectAlternativeName": ""
}
List all SSL Certificate Signing Requests’ properties¶
GET /mgmt/cm/adc-core/working-config/sys/file/ssl-csr
Response¶
HTTP/1.1 200 OK
{
"generation": 4,
"items": [
{
"adminEmail": "admin@example.com",
"challengePassword": "RzZNO4zK4emp/MAPz4LU+lmmLKA35mu61S8dpPQCDBU=",
"csrText": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDZzCCAk8CAQAwgawxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9u\nMRAwDgYDVQQHEwdTZWF0dGxlMR0wGwYDVQQKExRFeGFtcGxlIE9yZ2FuaXphdGlv\nbjEVMBMGA1UECxMMRXhhbXBsZSBVbml0MRQwEgYDVQQDEwtleGFtcGxlLmNvbTEq\nMCgGCSqGSIb3DQEJARYbZXhhbXBsZS1hZGRyZXNzQGV4YW1wbGUuY29tMIIBIjAN\nBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAluIEwU7xEo4wSOXLildtaOPqXY+e\nko8LxGOn+SwE08FPYL21NPNTFJCfQROx7Roo430FfYv84QkJ03hjvQgPxno+F2WM\n/PxheiNYWmQyTdAA6Wrbuk7Tv6Lazdjhg52e1pg30BAoShQYVlsFnIEZlt5f8gE0\n5hHo7FgjvZti7v7rnUL+IEi1yMPWdhC/w0LRN6g4oshpX4NdGwvDLNjAwNZOwYvN\nHx7/WnkTJ2mR4dR/MtCvXliPPdIxFIf2TYXR+GgBGG83vjWZ0NZknGfG4c57VEBD\nYOgtH1YeIAxVQiAYXqTLkBlUgcWh3m7H6qddrtuEpl6QNx0RxIVI/AuNqwIDAQAB\noHUwGAYJKoZIhvcNAQkHMQsTCWNoYWxsZW5nZTAgBgkqhkiG9w0BCQExExYRYWRt\naW5AZXhhbXBsZS5jb20wNwYJKoZIhvcNAQkOMSowKDAmBgNVHREEHzAdgRtleGFt\ncGxlLWFkZHJlc3NAZXhhbXBsZS5jb20wDQYJKoZIhvcNAQENBQADggEBAAs8eaAF\nLztvE0NwoDF9dPz5h1bdjt5aP4wHdqFsHgGvTfAAU1ux4yYJJladuQZhdvR1x+XF\nPuZRWPh18HqYweDYF64proMuMyQKREkJoopHTOyJfzt8rAiPzoyAsJvT8N1tzb8L\nh8NNqpMarboouWg5SYfwQR/S3irYl1Qc7nhJLC1Frf7hSsdlFhYGCT57YOyZtoge\nwkl2ANpSD8nYSbnPkhfs2OP7IMoj/vw18TIJ++75v6JxRK1XE2XOfxtqoE4GiJGq\nkRPl74sfA8yX0J0OeCbF9VlNmiCmuRbBD6p/kb496ZbQb/wzECuvX+WCZwJqPu9o\n3A9YPsw/xmRq0wM=\n-----END CERTIFICATE REQUEST-----\n",
"email": "example-address@example.com",
"generation": 1,
"groupingKey": "/Common/example.grouping-suffix-50453eb1-4c24-481f-b4eb-30ac613aace7",
"id": "5d928645-b81e-3c62-8d38-92ddfc9e9402",
"keySize": 2048,
"keyType": "rsa-public",
"kind": "cm:adc-core:working-config:sys:file:ssl-csr:adcsslcsrstate",
"lastUpdateMicros": 1527113415373577,
"name": "example.csr",
"partition": "Common",
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-csr/5d928645-b81e-3c62-8d38-92ddfc9e9402",
"subject": "E=example-address@example.com,CN=example.com,OU=Example Unit,O=Example Organization,L=Seattle,ST=Washington,C=US",
"subjectAlternativeName": ""
}
],
"kind": "cm:adc-core:working-config:sys:file:ssl-csr:adcsslcsrcollectionstate",
"lastUpdateMicros": 1527113415381048,
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-csr"
}
Delete a SSL Certificate Signing Request¶
DELETE /mgmt/cm/adc-core/working-config/sys/file/ssl-csr/<id>
Response¶
HTTP/1.1 200 OK
{
"adminEmail": "admin@example.com",
"challengePassword": "RzZNO4zK4emp/MAPz4LU+lmmLKA35mu61S8dpPQCDBU=",
"csrText": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDZzCCAk8CAQAwgawxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9u\nMRAwDgYDVQQHEwdTZWF0dGxlMR0wGwYDVQQKExRFeGFtcGxlIE9yZ2FuaXphdGlv\nbjEVMBMGA1UECxMMRXhhbXBsZSBVbml0MRQwEgYDVQQDEwtleGFtcGxlLmNvbTEq\nMCgGCSqGSIb3DQEJARYbZXhhbXBsZS1hZGRyZXNzQGV4YW1wbGUuY29tMIIBIjAN\nBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAluIEwU7xEo4wSOXLildtaOPqXY+e\nko8LxGOn+SwE08FPYL21NPNTFJCfQROx7Roo430FfYv84QkJ03hjvQgPxno+F2WM\n/PxheiNYWmQyTdAA6Wrbuk7Tv6Lazdjhg52e1pg30BAoShQYVlsFnIEZlt5f8gE0\n5hHo7FgjvZti7v7rnUL+IEi1yMPWdhC/w0LRN6g4oshpX4NdGwvDLNjAwNZOwYvN\nHx7/WnkTJ2mR4dR/MtCvXliPPdIxFIf2TYXR+GgBGG83vjWZ0NZknGfG4c57VEBD\nYOgtH1YeIAxVQiAYXqTLkBlUgcWh3m7H6qddrtuEpl6QNx0RxIVI/AuNqwIDAQAB\noHUwGAYJKoZIhvcNAQkHMQsTCWNoYWxsZW5nZTAgBgkqhkiG9w0BCQExExYRYWRt\naW5AZXhhbXBsZS5jb20wNwYJKoZIhvcNAQkOMSowKDAmBgNVHREEHzAdgRtleGFt\ncGxlLWFkZHJlc3NAZXhhbXBsZS5jb20wDQYJKoZIhvcNAQENBQADggEBAAs8eaAF\nLztvE0NwoDF9dPz5h1bdjt5aP4wHdqFsHgGvTfAAU1ux4yYJJladuQZhdvR1x+XF\nPuZRWPh18HqYweDYF64proMuMyQKREkJoopHTOyJfzt8rAiPzoyAsJvT8N1tzb8L\nh8NNqpMarboouWg5SYfwQR/S3irYl1Qc7nhJLC1Frf7hSsdlFhYGCT57YOyZtoge\nwkl2ANpSD8nYSbnPkhfs2OP7IMoj/vw18TIJ++75v6JxRK1XE2XOfxtqoE4GiJGq\nkRPl74sfA8yX0J0OeCbF9VlNmiCmuRbBD6p/kb496ZbQb/wzECuvX+WCZwJqPu9o\n3A9YPsw/xmRq0wM=\n-----END CERTIFICATE REQUEST-----\n",
"email": "example-address@example.com",
"generation": 1,
"groupingKey": "/Common/example.grouping-suffix-50453eb1-4c24-481f-b4eb-30ac613aace7",
"id": "5d928645-b81e-3c62-8d38-92ddfc9e9402",
"keySize": 2048,
"keyType": "rsa-public",
"kind": "cm:adc-core:working-config:sys:file:ssl-csr:adcsslcsrstate",
"lastUpdateMicros": 1527113522870841,
"name": "example.csr",
"partition": "Common",
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-csr/5d928645-b81e-3c62-8d38-92ddfc9e9402",
"subject": "E=example-address@example.com,CN=example.com,OU=Example Unit,O=Example Organization,L=Seattle,ST=Washington,C=US",
"subjectAlternativeName": ""
}