Authentication keys

These endpoints are for managing the public keys that are used for JWT authentication.

Submit a public key

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

SecurityBearer or BasicAuth
Request
path Parameters
member_id
required
string

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

Example: m:3qVTbXqXZza2VTKa28BPbExmxz9t:5zKtXEAq
Request Body schema: application/json
required
keyAlgorithm
string

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

Example: "ED25519"
publicKey
string

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.
For example:

  • Base64 URL format: _yDSz-_vUL92ezh5fJVhKpdbvwOKghDXQsaqDwGKi_A
  • PEM format: -----BEGIN PUBLIC KEY----- MCowBQYDK2VwAyEAGxDta2XXlr6Vxqk4kJq3+bLowoimRo+B52stoO7AWNg= -----END PUBLIC KEY-----

Example: "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAGxDta2XXlr6Vxqk4kJq3+bLowoimRo+B52stoO7AWNg=\n-----END PUBLIC KEY-----"
Responses
200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a sub-tpp, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

post/member/{member_id}/keys
Request samples
application/json
{
  • "keyAlgorithm": "ED25519",
  • "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAGxDta2XXlr6Vxqk4kJq3+bLowoimRo+B52stoO7AWNg=\n-----END PUBLIC KEY-----"
}
Response samples
application/json
{
  • "keyId": "_NouLPTuo7WBLBV6"
}

Get public keys

The GET /member/{member_id}/keys endpoint retrieves a list of all public keys, for the specified member.

SecurityBearer or BasicAuth
Request
path Parameters
member_id
required
string

This id specifies the member for whom the public keys are to be retrieved.

Example: m:3qVTbXqXZza2VTKa28BPbExmxz9t:5zKtXEAq
Responses
200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a sub-tpp, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

get/member/{member_id}/keys
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get a public key
The GET /member/{member_id}/keys/{key_id} endpoint retrieves the details of a specific public key, for the specified member.


SecurityBearer or BasicAuth 
Request 
path Parameters
member_id
required
string
This id specifies the member for whom the public key is to be retrieved.


 
 Example:  m:3qVTbXqXZza2VTKa28BPbExmxz9t:5zKtXEAq
key_id
required
string
This id specifies the public key to be retrieved.


 
 Example:  cJSOA7nQscQBScnE
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a sub-tpp, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


get/member/{member_id}/keys/{key_id}
Request samples 
Response samples 
application/json
{
  • "key": [
    ]
}
Delete a public key
The DELETE /member/{member_id}/keys/{key_id} endpoint deletes an existing public key, for the specified member.


SecurityBearer or BasicAuth 
Request 
path Parameters
member_id
required
string
This id specifies the member for whom the public key is to be deleted.


 
 Example:  m:3qVTbXqXZza2VTKa28BPbExmxz9t:5zKtXEAq
key_id
required
string
This id specifies the public key to be deleted.


 
 Example:  eep-VtCNYXo00LIS
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a sub-tpp, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


delete/member/{member_id}/keys/{key_id}
Request samples 
Response samples 
application/json
{ }
➔ Next to Reports