/register: Register SSL Certificate

URL:
https://[root]/portals/[portalID]/certificates/register
Methods:
POST

Example usage

The following is a sample ArcGIS Online POST request for the register operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /sharing/rest/portals/0123456789ABCDEF/certificates/register HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

name=orgCert&domain=domain.com&certificate=...

Description

The register operation (HTTPS only) allows administrator to register custom X.509 HTTPS certificates with their ArcGIS Online organizations. This will allow ArcGIS Online organization to trust the custom certificates used by a remote server when making HTTPS requests to it, i.e. store credentials required to access its resource and share with others.

A maximum of 5 certificates can be registered with an organization.

Request parameters

ParameterDetails

name

Name for the certificate to be registered.

Example

Use dark colors for code blocksCopy
1
name=orgCert

domain

Server domain that the certificate is used for.

Example

Use dark colors for code blocksCopy
1
domain=domain.com

certificate

Base64-encoded certificate text, enclosed between -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.

Response properties

PropertyDetails

success

Indicates if the operation was successful.

certificateId

Id of the registered certificate.

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
{
  "success": true,
  "certificateId": "<certificateId>"
}

JSON Response example

The following demonstrates a returned success response:

Use dark colors for code blocksCopy
1
2
3
4
{
  "success": true,
  "certificateId": "adzf7nGZD1XCnyph"
}

The following demonstrates a returned error message:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "error": {
    "code": 500,
    "messageCode": "ORG_1207",
    "message": "The org has reached the max Custom SSL certificate allowed.",
    "details": []
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.