PKI Keys Assignment Service: Overview

The PKI Keys Assignment service provides the ability to assign PKI keys to identities such as a container, container listener, user, service, or tenant theme from an external keystore by associating the keystore alias and password.

For more information see, Using the HSM as an External Keystore and Managing Keys and Certificates.

URL: https://{hostname}/

Action Endpoint Description
assign PKI keys to a container POST /rest/containers/{container_key}/pki/assign Assigns PKI keys to the Policy Manager container from an external keystore by associating the keystore alias and password with the key.
assign PKI keys to a container's inbound listener POST /rest/containers/{container_key}/listeners/{listener_name}/pki/assign Assigns PKI keys from an external keystore to a container's inbound listener by associating the keystore alias and password with the key.
get PKI keys for a container's inbound listener GET /rest/containers/{container_key}/listeners/{listener_name}/pki/info

Returns PKI information about the container's inbound listener.
assign PKI keys to a container's outbound identity POST /rest/containers/{container_key}/pki/outbound/assign Assigns PKI keys from an external keystore to the container's outbound identity by associating the keystore alias and password with the key.
get PKI keys for a container's outbound identity GET /rest/containers/{container_key}/pki/outbound/info

Returns PKI information about the container's outbound identity.
assign PKI keys to a service POST /rest/services/{service_key}/pki/assign Assigns PKI keys from an external keystore to a service identity by associating the keystore alias and password with the key.
get PKI keys for a service GET /rest/services/{service_key}/pki/info

Returns PKI information about the service.

Note: The certificate common name (CN) cannot be retrieved by querying the PM_PKIKEYS table. The certificate subject data is stored in the SUBJECTDN column as a BLOB, which cannot be decoded or queried for the CN by using the standard MySQL queries. To retrieve the CN and other certificate details, use the GET /rest/services/{service_key}/pki/info API instead of querying the database directly.
assign PKI keys to a user POST /rest/users/{user}/pki/assign Assigns PKI keys from an external keystore to a user by associating the keystore alias and password with the key. For more information, see Users Service: Overview.
assign PKI keys to a tenant theme POST /api/tenants/{tenant_id}/themes/{theme_name}/pki/assign Assigns PKI keys from an external keystore to a tenant theme by associating the keystore alias and password with the key. For more information, see Tenant Administration Service: Overview.