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
OwnerCode string
PublicKey string
UniqueId string
Usage string[]
Possible values: [Unknown
, Reports
, Authentication
, MessageLevelEncryption
, CredentialsDownload
, ResponseSignature
]
Type stringrequired
Possible values: [RSA
, PGP
]
ExpirationUtc date-time
RelatedClientId string
HasPrivateKey booleanrequired
{
"OwnerCode": "string",
"PublicKey": "string",
"UniqueId": "string",
"Usage": [
"Unknown"
],
"Type": "RSA",
"ExpirationUtc": "2024-06-06T16:41:09.066Z",
"RelatedClientId": "string",
"HasPrivateKey": true
}
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...