Export Public Key (JWKS JSON)
GET {{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}
To get a JSON web key set (JWKS) from a specific encryption-decryption key pair, the GET {{apiPath}}/v1/environments/{{envID|}/key/{{keyID}} operation returns a JSON file. This operation requires an Accept header in the request that specifies application/jwk-set+json.
The sample shows the JSON response, which includes the following keys property claims:
-
kty: The key type. -
kid: The key ID, a value that identifies the ID of the corresponding encryption-decryption key pair. -
n: The modulus value for the RSA public key. -
e: The RSA public exponent.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}' \
--header 'Accept: application/jwk-set+json' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Accept", "application/jwk-set+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/jwk-set+json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
GET /v1/environments/{{envID}}/keys/{{keyID}} HTTP/1.1
Host: {{apiPath}}
Accept: application/jwk-set+json
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}")
.method("GET", body)
.addHeader("Accept", "application/jwk-set+json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}",
"method": "GET",
"timeout": 0,
"headers": {
"Accept": "application/jwk-set+json",
"Authorization": "Bearer {{accessToken}}"
},
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'GET',
'url': '{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}',
'headers': {
'Accept': 'application/jwk-set+json',
'Authorization': 'Bearer {{accessToken}}'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}"
payload = {}
headers = {
'Accept': 'application/jwk-set+json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Accept' => 'application/jwk-set+json',
'Authorization' => 'Bearer {{accessToken}}'
));
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"
url = URI("{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/jwk-set+json"
request["Authorization"] = "Bearer {{accessToken}}"
response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/keys/{{keyID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/jwk-set+json", forHTTPHeaderField: "Accept")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "GET"
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"keys": [
{
"kty": "RSA",
"kid": "ca08f6d9-4cf8-4bec-a732-6f7b06e14f4c",
"n": "pNl7_x8QxV1cF54WsmwPjX8hHBjnquOJOFlO7d3FVqjWLHykT1e7gBEbROCEOtoDAm0XQRul62zWmXAT4XkrFr7_TChjl5-y734WB_LbU44ncJq3zq6qGUZaKggcCQpoo8vhkcwE4T8FUbIydhRscyc9rBRJx-w8POWlavecmjfYU5L8kitft0i2YbkU330Mx_KerVzlmhsjSYqrS4kUWrIYOOQvv_m4FavU8QyVqRGKQEoH8wioIG14qE0kih9m4gmIExjkztAZ2cCSvfAdPDXoGVt8jint8jbakc4sSBTtCEhSemL8gPpEDU1klQgJHGNpUNld_51OyELIutJFqQ",
"e": "AQAB"
}
]
}