Skip to main content

Vault V1 JWT API Reference

Run In Postman
post/v1/key/sign/jwt
curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/key/sign/jwt' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Sign JWT

POST
https://vault.aws.us.pangea.cloud/v1/key/sign/jwt

Sign a JSON Web Token (JWT) using a key.

required parameters

string (pangea-id)

ID of a Vault key, secret, token, or folder

string

JWT payload (in JSON)

object

Pangea standard response schema

object
string

Signed JSON Web Token (JWS)

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1/key/verify/jwt
curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/key/verify/jwt' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Verify JWT

POST
https://vault.aws.us.pangea.cloud/v1/key/verify/jwt

Verify the signature of a JSON Web Token (JWT).

required parameters

string

Signed JSON Web Token (JWS)

object

Pangea standard response schema

object
boolean

Indicates whether the signature has been verified:

  • true - The signature is valid
  • false - The signature is not valid
string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1/get/jwk
curl -sSLX POST 'https://vault.aws.us.pangea.cloud/v1/get/jwk' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Get JWKS

POST
https://vault.aws.us.pangea.cloud/v1/get/jwk

Retrieve a public key and associated metadata in JSON Web Key (JWK) format.

required parameters

string (pangea-id)

ID of a key

string, integer

Version(s) to retrieve. Supported parameter values are:

  • all - Retrieve all versions of the item.
  • <num> - Retrieve a specific version number of the item.
  • -<num> - Retrieve last <num> + 1 versions of the item.
  • <no-value> - Return the current version.
object

Pangea standard response schema

object

JSON Web Key Set (JWKS) object containing one or more JSON Web Keys (JWK). The key version is indicated in the "kid" value after the | delimiter. Fields with key information are encoded in Base64URL format.

array<object>

JSON Web Key Set (JWKS) object

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Was this article helpful?

Contact us