FortID LogoFortID

Update KMS Config

Update Key Management System Credentials Config

Update Key Management System Credentials Config

POST
/control/issuer/{issuerId}/update-key-config

Updates Key Management System Credentials Config if issuerId matches an Issuer which uses third party KMS for credential signing. Some common use cases include:

  • KMS credentials currently provided to the Issuer are expired or will expire
  • The key's certificate has expired
  • The key is being rotated
  • The key is transferred to another server or some other KMS
  • Key name has changed

Path Parameters

issuerId*string

The ID of the Issuer.

Header Parameters

X-API-KEY*string

API key for authenticating requests to the Issuer Service.

Request Body

application/json

issuerKeyConfig*|

Configuration which contains information and credentials required for the issuer to sign with a key pair stored in the KMS.

Response Body

application/json

application/json

application/json

curl -X POST "https://eis.fortid.com/control/issuer/fortid_issuer/update-key-config" \  -H "X-API-KEY: HCLN4ZKnWYJAfyNkDnQ57gEAHuejD6MN" \  -H "Content-Type: application/json" \  -d '{    "issuerKeyConfig": {      "hashicorpVault": {        "vaultAddr": "https://vault-server:8400",        "tlsTrustAnchorCert": "-----BEGIN CERTIFICATE-----\nMIIFqTCCA5GgAwIBAgIUK665solptYn1rWGpbhAW9sF3k7YwDQYJKoZIhvcNAQEL\nBQAwZDELMAkGA1UEBhMCSFIxDzANBgNVBAgMBlphZ3JlYjEPMA0GA1UEBwwGWmFn\ncmViMQ0wCwYDVQQKDARUQlRMMQwwCgYDVQQLDANCZWUxFjAUBgNVBAMMDUZvcnRJ\nRCBEZXYgQ0EwHhcNMjUwNjEwMTA0NzQ3WhcNMzUwNjA4MTA0NzQ3WjBkMQswCQYD\nVQQGEwJIUjEPMA0GA1UECAwGWmFncmViMQ8wDQYDVQQHDAZaYWdyZWIxDTALBgNV\nBAoMBFRCVEwxDDAKBgNVBAsMA0JlZTEWMBQGA1UEAwwNRm9ydElEIERldiBDQTCC\nAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBALnb3fSlM8HmVDWQWGuSJKpT\n8342lb20VG6XDIHwuNtiOTRvhv8pDYjxFINwuENc/Cm7azLKWGgcQ4l+Ug0ZN8Fs\n5XFJ2phtfgNDIoSxsCAfU6zmoh8G1yOPSk0khzqw6br48u7cbN3/zXy/2WlDpWy5\n5yASNBSTt2ldH6HJbD6opHIYnjIF7UtDo91nTQRczJkyo3EXkH2M7zkXbRZiUUiX\nbIBjNXOOBH+BQt43NMllo8J9fxx45+UdOYV6g0v0D9GE27I5orNMwQ60uAsH72ph\ngXSA4fC6gG5gO82WJabyJZYum0pXFmSiwHtbzhjop0/d5iMQ0fe/39QD+cBZlLrE\nlo3hTSVjxHp05f8UEsbsyInZ8cq8dJ/OgI0D91NNFtotozz9qEHHNqaE1sdi7RR4\nyXPFYqUvWRs+7uQNn5ZWMLSMakJEgyjuemrdVNIlWgMapMSn+myYrFL2km9voXql\nvF9ghjZksD6iz3QfXprLEtDZOLUQLSZaUWpcWJI1iA9XV8DoU+utCouBiGGAyrt7\nQKDPvAIiJ8eY/QT71yj/J3D4Qx7AtgpFNOEHT+5mBQeSdWZFv9TLF73KS+noNqAq\nlsZEsVFGG6cetw/16V6ol9VyeuruzYawyKtnBEDCkJF4zJHk8N2L+FWJwoKry/xQ\nkL9L1tyzI81+2QWapebzAgMBAAGjUzBRMB0GA1UdDgQWBBSpSIKD+fDYt1P2mCvm\ncEibL1MSizAfBgNVHSMEGDAWgBSpSIKD+fDYt1P2mCvmcEibL1MSizAPBgNVHRMB\nAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQCQBCW80s++2urUPsxHwzWHSJjO\nBKDvqYFYE+J6rxnfZmcGZf375Mwon9lIOccVOnYMTZxCsAAGFgPj+nE1AURPKSWC\ndoxZo7lrRUp1Rihqi2YJxFixpuLy+atx7wM0g2BeV3Q5YDsLTekUZ+/ROMvNp1Qb\n+VFOF2WDukBp/nxnd9/FRBOqzXWN52VqcbnpW1+KdR/FFlQ/6kAAzg3hg581BfbV\nZBXmfIcQR6dnyMISoUs6nqH1+bBvPltM/nGPX36aosovNkaGlMjHjJ3XZ7LYfoVD\n0D3zGyInFpWxpgRDi1CUEwD0+wbBQ1zmC5vR4cs1GVOy7SM9ogdSdCV8ArdGqs5u\ntGcFdJ2+DcMHuLMzXwojx1HCmiElzJL2wiInoYdOKnpa5a+iv4Zcr6k5aiR8X5ZO\ndd+WqXSep9/DdgKzPcN5cmTl0zDCs0QfoamIOrIaNHBNypfoMKkHovrcFxjygrbO\nBWK0OgWn1DH8f72ZnmaqYYmI6NyhZcDezTVmu/HNoMyT/spyzQJEk5moYwEDT3ng\nbcgS80ubPVgp2fEDZKCbQRJPWA8S12TRJV+FCnfUJ2N6maoKYOj7NE2J7T+4cH7s\nAx6+WMqPo6FXfoZjZPA6/a0mgSZ/aE9sci2WgKKqNeOyHioeuzAPFmCfSO9AsQr8\nLTT3MEPO2zelxL7vsA==\n-----END CERTIFICATE-----\n",        "keyName": "credential-signing-key",        "keyVersion": 1,        "vaultToken": "hvs.CvmS4c0DPTvHv5eJgXWMJg9r"      },      "certChain": [        "-----BEGIN CERTIFICATE-----\nMIICLzCCAdSgAwIBAgIUG3hPTlvk19YHRC7Og8NQiJNmjlMwCgYIKoZIzj0EAwIw\nbzELMAkGA1UEBhMCSFIxDzANBgNVBAcMBlphZ3JlYjEPMA0GA1UECgwGRm9ydElE\nMT4wPAYDVQQDDDVFeGFtcGxlIGludGVybWVkaWFyeSBjZXJ0aWZpY2F0ZSBmb3Ig\nS01TIHNpZ25pbmcga2V5czAeFw0yNTA4MjUxMjE2MTlaFw0yNjA4MjUxMjE2MTla\nMF0xCzAJBgNVBAYTAkhSMQ8wDQYDVQQHDAZaYWdyZWIxDzANBgNVBAoMBkZvcnRJ\nRDEsMCoGA1UEAwwjRXhhbXBsZSBIYXNoaUNvcnAgVmF1bHQgc2lnbmluZyBrZXkw\nWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAASXomrIiwVs5fWrehwghzoaDXNLzZtE\nr+PJ9n6v7OrYHmyC49fulveUFN8CDwIBYlG4uRkT1ViMIHkL8v7Cqtxxo2AwXjAd\nBgNVHQ4EFgQUY5RxJ3X3XbJJKAZ5sFHgvoaLdF4wHwYDVR0jBBgwFoAUVl3w/FVX\nHFyNtt1kLpRpKRBf89EwDAYDVR0TAQH/BAIwADAOBgNVHQ8BAf8EBAMCB4AwCgYI\nKoZIzj0EAwIDSQAwRgIhAIQuOwcesDat9rXMLYH6TEx8ecHLvx3TgHsphWsl9h2N\nAiEAyjszl0fXaR7PXrLzpI0jD2cZaKcDhsC6GpbGboMS9uw=\n-----END CERTIFICATE-----\n",        "-----BEGIN CERTIFICATE-----\nMIICLDCCAdGgAwIBAgIUZSNsHdaGzMIubkVo9d6KscyGBsswCgYIKoZIzj0EAwIw\nUjELMAkGA1UEBhMCSFIxDzANBgNVBAcMBlphZ3JlYjEPMA0GA1UECgwGRm9ydElE\nMSEwHwYDVQQDDBhFeGFtcGxlIHJvb3QgY2VydGlmaWNhdGUwIBcNMjUwODI1MTIw\nODM0WhgPMjEyNTA4MDExMjA4MzRaMG8xCzAJBgNVBAYTAkhSMQ8wDQYDVQQHDAZa\nYWdyZWIxDzANBgNVBAoMBkZvcnRJRDE+MDwGA1UEAww1RXhhbXBsZSBpbnRlcm1l\nZGlhcnkgY2VydGlmaWNhdGUgZm9yIEtNUyBzaWduaW5nIGtleXMwWTATBgcqhkjO\nPQIBBggqhkjOPQMBBwNCAAQA3H327eblqgqPkkGymaQtR9M5xzVz6sO9VufLainR\ndNnzmSqv2QY3aGBQYQUG+nfDJQS+BjD13XJAqO3nbZiHo2YwZDAdBgNVHQ4EFgQU\nVl3w/FVXHFyNtt1kLpRpKRBf89EwHwYDVR0jBBgwFoAUZAMvUV6KlYQHAC4l61dh\nuQTCO+AwEgYDVR0TAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwCgYIKoZI\nzj0EAwIDSQAwRgIhAK5OBgninc4/r0Rz3/jo2S484o8+5M49o7n1ek6vfD1/AiEA\nqVNL4j3A/27CGobD3PKTsdCu93+/IUkkU2OpJx/yZfs=\n-----END CERTIFICATE-----\n"      ]    }  }'
Empty
{
  "message": "User input validation error: Key config validation error: ..."
}
Empty
Empty
{
  "message": "Issuer with provided id not found"
}
Empty
{
  "message": "string"
}