Fetching the Public Key
The post /v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/get-public-key
API returns the public key of an asymmetric key stored in a keystore on CipherTrust Manager. The key specified in the key_id
path variable MUST be an asymmetric key. The key version ID is optional and may be provided to get the public key of a specific version of the key.
The public key returned in response is a PEM-encoded public key according to IETF RFC 5280, specifically using the ‘SubjectPublicKeyInfo’ encoding to allow both the algorithm and public key to be encoded.
Request Parameters
Parameter | Type | Description |
---|---|---|
sap_tenant_id | string | ID of the SAP Tenant. |
Example Request
post https://<Host IP Address>/api/v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/get-public-key
<authorization token and other headers>
{
"request_metadata": {
"sap_tenant_id": "86428acc-a1c8-6de1-b8f7-8de9a436gdr3"
}
}
Example Response
{
"key_id": "feb06280-4717-43d1-a23c-45929aa24607",
"key_version_id": "56358acc-a1c8-4de1-b8c7-8de9adbe71e7",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA4Nb/HwJTW5ReFNesGw6R\n/XASqc+tmjAIi6rCK/vrq+Ujt3Z/9+BFCSSOS5t2d2y6LHr3sRyvG87YpgzjpccM\n3aYy4QIYtkFx1OsS2Im2Qt2fnxYHXqchZLLU+GWaHZ73kH93KxA7iS6QL0BoICBa\nnEhimZPZCk9dE/c2MjlkeKtxsU6jw4+1VE5cfqSAGyQh/O5xEtFvAvNO2dAKi++i\n+ocsMEeWeck9afSQr4wSrxLF3zrz4n4bOB6t7ROTJ47kJd3/XvV10G7wTgA0gyLc\nYLazCuswhoNLcKHFKN1fmXlJscUD676if3vdABlMQTctvlYX/0My/ttFeDl7SKWp\n18c09o4nhl8xW5zi48+9qQjLE4i6F1raoIDR7BWcP58cYbItFwkcytB3WHuau1eV\nC/MvYBSLuw9VRsvd69fZb0pc2PKB3BEzg1cTyRaTYyzLYYjKBvDhyRKQl6ShdI9m\ni3Ki6dAc+mwy/9uaip17kqIIDYEWH/Nq2K0DEPKs5hHgm+zg7orG1CrH/3s9M1X2\n1DPQus+eV/MaURlaBzPNe93fCpc/nTHjyWDWTyq33bH+CMPTHFqZBHDjkHJFuUw+\nB2bfZhgDzIrQXLvdi9d1K/A2mFmg5qs6RCRqfCsgM5HnlStIjW3AwANNPsgm5Zy0\nOE3Jrg2UuLf6hcqD2w6+iEkCAwEAAQ==\n-----END PUBLIC KEY-----\n"
}
Response Codes
Response Code | Description |
---|---|
200 | Ok |
400 | Bad request |
401 | Unauthorized |
404 | Not found |
403 | Forbidden |
500 | Internal server error |
Refer to HTTP status codes for details.