SPS can generate the server-side certificates on the fly. This technique is used for example in SSL-encrypted RDP sessions, RDP sessions that use Network Level Authentication (CredSSP), or SSH connections that use X.509-based authentication.

URL

GET https://<IP-address-of-SPS>/api/configuration/policies/signing_cas

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API. NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Sample request

The following command lists the configured signing Certificate Authorities (CAs).

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/policies/signing_cas

The following command retrieves the properties of a specific policy.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/policies/signing_cas/<object-id>

Response

The following is a sample response received when listing signing CAs.

For more information on the meta object, see Message format.

{
  "items": [
    {
      "key": "991699365727ac4eb4606",
      "meta": {
        "href": "/api/configuration/policies/signing_cas/991699365727ac4eb4606"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/policies/audit_policies",
    "href": "/api/configuration/policies/signing_cas",
    "last": "/api/configuration/policies/usermapping_policies",
    "next": "/api/configuration/policies/ticketing_policies",
    "parent": "/api/configuration/policies",
    "previous": "/api/configuration/policies/ldap_servers",
    "transaction": "/api/transaction"
  }
}

When retrieving the endpoint of a specific signing CA, the response is the following.

{
  "body": {
    "ca": {
      "key": "55b2419c-f94f-4836-9c0b-bc3796b6f556",
      "meta": {
        "href": "/api/configuration/x509/55b2419c-f94f-4836-9c0b-bc3796b6f556"
      }
    },
    "name": "API_CA"
  },
  "key": "991699365727ac4eb4606",
  "meta": {
    "first": "/api/configuration/policies/signing_cas/991699365727ac4eb4606",
    "href": "/api/configuration/policies/signing_cas/991699365727ac4eb4606",
    "last": "/api/configuration/policies/signing_cas/991699365727ac4eb4606",
    "next": null,
    "parent": "/api/configuration/policies/signing_cas",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

Element		Type	Description
key		string	Top level element, contains the ID of the signing CA.
body		Top level element (string)	Contains the properties of the signing CA.
	ca	string	References the identifier of the signing CA's X.509 certificate. You can configure certificates at the /api/configuration/x509/ endpoint. To modify or add an X.509 certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key).
	name	string	The name of the signing CA. This name is also displayed on the SPS web interface. It cannot contain whitespace.

Add a signing CA

To add a signing CA, you have to:

1. Open a transaction

   For more information, see Open a transaction.

2. Create a signing CA

   Have the value of the key element of a valid X.509 CA certificate stored on SPS.

3. Create the JSON object for the new signing CA.

   Use the X.509 certificate's key as the value of the ca element for the signing CA. You can find a detailed description of the available parameters listed in Element .

   POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/policies/signing_cas endpoint. If the POST request is successful, the response includes the key of the new signing CA. For example:

   {
     "key": "325768b5-5b85-467d-8e30-e2b57d0869c8",
     "meta": {
       "href": "/api/configuration/policies/signing_cas/325768b5-5b85-467d-8e30-e2b57d0869c8",
       "parent": "/api/configuration/policies/signing_cas",
       "transaction": "/api/transaction"
     }
   }

4. Commit your changes

   For more information, see Commit a transaction.

Modify a signing CA

To modify a signing CA, you have to:

1. Open a transaction

   For more information, see Open a transaction.

2. Modify the JSON object of the signing CA.

   Use the X.509 certificate's key as the value of the ca element for the signing CA. You can find a detailed description of the available parameters listed in Element .

   PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/policies/signing_cas/<key-of-the-object> endpoint.

3. Commit your changes

   For more information, see Commit a transaction.

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

HTTP response code	Status/Error	Description
201	Created	The new resource was successfully created.
400	InvalidQuery	The requested filter or its value is invalid.
400	Bad Request	The referenced certificate is not a valid CA certificate.
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404	NotFound	The requested object does not exist.