Rotate Public Key
POST/api/v1/key
Use this endpoint to change your public key that is stored by Splitit (you should never share a private key with Splitit). In this scenario, Splitit uses your public key to encrypt data sent to you, to verify that communication that came from you is actually from you.
- Used to PGP-encrypt outgoing traffic from Splitit, such as reports and credentials
- Used by Splitit to authenticate your signatures (RSA key-pair authentication)
Request
- application/json
Body
required
OwnerCode stringrequired
Given to you by Splitit support, same as Owner in other calls
Usage string[]required
Possible values: [Unknown
, Reports
, Authentication
, MessageLevelEncryption
, CredentialsDownload
, ResponseSignature
]
Type stringrequired
Possible values: [RSA
, PGP
]
PublicKey stringrequired
E.g., "sU9tOVHOcM6jPOjjWZpXZs4V0cmc01BZfChF5afrj71Dz2COn2"
ExpirationUtc date-timerequired
E.g., 2024-07-06T15:46:26.409Z
RelatedClientId string
Responses
- 200
- 400
- 404
- 500
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
UniqueId string
{
"UniqueId": "string"
}
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
TraceId string
Error
object
Code string
Message string
AdditionalInfo string
ExtraData
object
property name* string
{
"TraceId": "string",
"Error": {
"Code": "string",
"Message": "string",
"AdditionalInfo": "string",
"ExtraData": {}
}
}
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
TraceId string
Error
object
Code string
Message string
AdditionalInfo string
ExtraData
object
property name* string
{
"TraceId": "string",
"Error": {
"Code": "string",
"Message": "string",
"AdditionalInfo": "string",
"ExtraData": {}
}
}
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
TraceId string
Error
object
Code string
Message string
AdditionalInfo string
ExtraData
object
property name* string
{
"TraceId": "string",
"Error": {
"Code": "string",
"Message": "string",
"AdditionalInfo": "string",
"ExtraData": {}
}
}
Loading...