openapi: 3.2.0 info: description: 'Endpoint Certificate API allows the client to create endpoint certificates signed by the Cisco ISE Internal CA. This API can takes in certificate request details, create a RSA key pair, create a certificate and return the resulting key pair and certificate as a ZIP file. ZIP files are returned as an octet stream.
| Revision # | Resource Version | Cisco ISE Version | Description |
| 0 | 1.0 | 2.0 | Initial Cisco ISE Version |
| Attribute | Type | Required | Description | Example Values |
| name | String | Yes | Resource Name | |
| id | String | No | Resource UUID, mandatory for update | |
| description | String | No | Resource Description | |
| certTemplateName | String | Yes | Name of an Internal CA template | Certificate_Template_Name |
| format | Enum | Yes | Allowed values: - PKCS12, - PKCS12_CHAIN, - PKCS8, - PKCS8_CHAIN | PKCS8 |
| password | String | Yes | Protects the private key. Must have more than 8 characters, less than 15 characters, at least one upper case letter, at least one lower case letter, at least one digit, and can only contain [A-Z][a-z][0-9]_# | Password_123 |
| certificateRequest | Map | Yes | Key value map. Must have CN and SAN entries | |
| - CN | String | Yes | Matches the requester''s User Name, unless the Requester is an ERS Admin. ERS Admins are allowed to create requests for any CN | userName [or] machineName |
| - SAN | String | Yes | Valid MAC Address, delimited by ''-'' | 11-22-33-44-55-66 |
This API allows the client to create an endpoint certificate.
parameters: - in: header name: HTTP ERS-Media-Type Header description: Example:- ca.endpointcert.1.0 required: false schema: type: string - in: header name: HTTP X-CSRF-TOKEN Header description: Required Only if Enabled from GUI Example:- fetch schema: type: string - in: header name: Additional Information description:| CertTemplateName | (Required) | Must be the name of an Internal CA template |
| CertificateRequest | (Required) | Must have CN and SAN entries |
| CN | (Required) | Must match the requester's User Name, unless the Requester is an ERS Admin. ERS Admins are allowed to create requests for any CN |
| SAN | (Required) | Must be a valid MAC Address, delimited by '-' |
| Format | (Required) | Must be one of either PKCS12, PKCS12_CHAIN, PKCS8, or PKCS8_CHAIN |
| Password | (Required) | Protects the private key. Must have more than 8 characters, less than 15 characters, at least one upper case letter, at least one lower case letter, at least one digit, and can only contain [A-Z][a-z][0-9]_# |
This API helps to retrieve the version information related to the endpoint certificate.
responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/VersionInfo' components: schemas: VersionInfo: type: object properties: VersionInfo: $ref: '#/components/schemas/version' ERSEndPointCert: properties: certTemplateName: type: string example: Certificate_Template_Name format: type: string example: PKCS8 password: type: string example: Password_123 certificateRequest: type: object properties: customAttributes: type: object properties: san: type: string example: 11-22-33-44-55-66 cn: type: string example: userName [or] machineName version: type: object properties: currentServerVersion: type: string example: '1.0' supportedVersions: type: string example: '1.0' link: $ref: '#/components/schemas/link1' endpointcert: type: object properties: ERSEndPoint: $ref: '#/components/schemas/ERSEndPointCert' link1: type: object properties: rel: type: string example: self href: type: string example: https://