- URL:
- https://<root>/generateCertificate
- Methods:
POST- Version Introduced:
- 10.8
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The generate operation can be used to create a self-signed certificate or as a starting point for getting a production-ready CA-signed certificate. ArcGIS Enterprise portal will generate a certificate for you and store it in its keystore.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The name of the certificate. Example |
| The algorithm used to generate the key pairs. The default is Example |
| The size of the key. The default is Example |
| The algorithm used to sign the self-signed certificates. The default is derived from the Example Example |
(Required) | The common name used to identify the server for which the certificate is to be generated. Example |
| The department in which this server resides. Example |
(Required) | The name of the organization. Example |
| The name of the city. Example |
| The name of the state. Example |
| The two-letter abbreviation for the country. Example |
| The expiration time for the certificate in days. The default is Example |
| The certificate's Subject Alternative Name. This value can be a machine name or an IP address, but it must be prefixed by either Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the generate operation:
POST /<context>/portaladmin/machines/MACHINE.EXAMPLE.COM/sslCertificates/generate HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
alias=mycert&keyAlg=RSA&keySize=2048&sigAlg=SHA256withRSA&cn=MACHINE.ESRI.COM&orgUnit=Development&org=ESRI&city=Redlands&state=California&country=US&validity=90&san=DNS:machine.esri.comJSON Response example
{"status": "success"}