latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

Agents
public

Register a new Key under an Agent in an Organization.

post/orgs/{orgId}/agents/{agentId}/keys

Path parameters

orgIdstring required

The Organization ID

agentIdstring required

The Agent id.

Request body

public_keystring required

A pcks8 RSA public key PEM encoded (as the ones produced by openssl), whose module length is greater or equal than 4096 bits.

Example request

{
  "public_key": "-----BEGIN PUBLIC KEY-----\n...-----END PUBLIC KEY-----"
}

Response

Successful list response.

fingerprintstring required

The Key fingerprint (sha256 hash of the DER representation of the key).

public_keystring required

A pcks8 RSA ublic key PEM encoded.

created_atstring date-time required

Time of the Key being registered.

created_bystring required

User ID of user that added the Key.

expired_atstring date-time required

Time when the Key should be replaced (2 years after its creation).

is_authorizedboolean required

If this key has been authorized to be used to validate requests coming from an Agent.

Example response

{
  "fingerprint": "9be36d7e31323a00e88facdd50843accd95ddbcffaefea28e49c28c08399417d",
  "public_key": "-----BEGIN PUBLIC KEY-----\n...-----END PUBLIC KEY-----",
  "created_at": "2020-06-22T09:37:23.523Z",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "expired_at": "2022-06-22T09:37:23.523Z",
  "is_authorized": true
}