Fetch a Key
GET/api/v1/key/:id
This endpoint retrieves general information for a specific key, including the associated public key.
Request
Path Parameters
id stringrequired
Note that this field is returned as UniqueID from some calls.
Responses
- 200
- 400
- 404
- 500
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
OwnerCodestring
PublicKeystring
UniqueIdstring
Usagestring[]
Possible values: [Unknown
, Reports
, Authentication
, MessageLevelEncryption
, CredentialsDownload
, ResponseSignature
]
Typestringrequired
Possible values: [RSA
, PGP
]
ExpirationUtcdate-time
RelatedClientIdstring
HasPrivateKeybooleanrequired
{
"OwnerCode": "string",
"PublicKey": "string",
"UniqueId": "string",
"Usage": [
"Unknown"
],
"Type": "RSA",
"ExpirationUtc": "2024-07-29T15:51:28.071Z",
"RelatedClientId": "string",
"HasPrivateKey": true
}
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
TraceIdstring
Error
object
Codestring
Messagestring
AdditionalInfostring
ExtraData
object
property name*string
{
"TraceId": "string",
"Error": {
"Code": "string",
"Message": "string",
"AdditionalInfo": "string",
"ExtraData": {}
}
}
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
TraceIdstring
Error
object
Codestring
Messagestring
AdditionalInfostring
ExtraData
object
property name*string
{
"TraceId": "string",
"Error": {
"Code": "string",
"Message": "string",
"AdditionalInfo": "string",
"ExtraData": {}
}
}
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
TraceIdstring
Error
object
Codestring
Messagestring
AdditionalInfostring
ExtraData
object
property name*string
{
"TraceId": "string",
"Error": {
"Code": "string",
"Message": "string",
"AdditionalInfo": "string",
"ExtraData": {}
}
}