Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Authentication keys

Submit a public key

The POST /member/{memberId}/keys endpoint submits a public key for authentication, for the specified member.

post/member/{memberId}/keys

Path parameters

memberIdstring required
Example:m:3qVTbXqXZza2VTKa28BPbExmxz9t:5zKtXEAq

This id specifies the member for whom the public key is to be submitted.

Request body

keyAlgorithmstring

The security algorithm designed to protect the public key, <i>e.g.</i> ED25519, ECDSA_SHA256, RS256.

publicKeystring

The public key of the key pair to be uploaded. This key verifies that the payload has been signed by the owner of the private key. <br/>For example: <ul><li><b>Base64 URL format</b>: _yDSz-_vUL92ezh5fJVhKpdbvwOKghDXQsaqDwGKi_A</li> <li><b>PEM format</b>: -----BEGIN PUBLIC KEY----- MCowBQYDK2VwAyEAGxDta2XXlr6Vxqk4kJq3+bLowoimRo+B52stoO7AWNg= -----END PUBLIC KEY-----</li></ul>

Example request

{
  "keyAlgorithm": "ED25519",
  "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAGxDta2XXlr6Vxqk4kJq3+bLowoimRo+B52stoO7AWNg=\n-----END PUBLIC KEY-----"
}

Response

Successful response

keyIdstring

The unique identifier for the public key.

Example response

{
  "keyId": "_NouLPTuo7WBLBV6"
}