Skip to content
Orvanov0.2.0

keys.getJwks

GET
/v1/projects/{projectId}/.well-known/jwks.json
import { Client, Orvano } from '@orvano/js'
const orvano = new Orvano(new Client({ endpoint: 'https://orvano.example.com' }))
const jwks = await orvano.keys.getJwks('<projectId>')
console.log(jwks)

Gets a project’s public signing keys, to check its access tokens.

Client and server SDKs: a signed in user’s access token, or a server SDK on behalf of one. A failure answers with a problem details body; its code has a page under Errors.

projectId
required
string

The project ID.

The request has succeeded.

Media typeapplication/json

A project’s public signing keys: the active key and any key retired within the last 24 hours.

object
keys
required

The keys.

Array<object>

One public signing key, as a JSON Web Key (RFC 7517).

object
kty
required

The key type, EC.

string
crv
required

The curve, P-256.

string
x
required

The public point’s x coordinate, base64url.

string
y
required

The public point’s y coordinate, base64url.

string
kid
required

The key ID, the kid in a token’s header.

string
alg
required

The algorithm, ES256.

string
use
required

What the key is for, sig.

string
Example
{
"keys": [
{
"kty": "EC",
"crv": "P-256",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0",
"kid": "AZJPXo0rfE2OIT1ebzqLnA",
"alg": "ES256",
"use": "sig"
}
]
}

An unexpected error response.

Media typeapplication/problem+json

An RFC 9457 problem details body. Every operation declares it as its default response, sent as application/problem+json.

object
type
required

Identifies the error: https://orvano.dev/errors/<code>.

string
title
required

The standard HTTP reason phrase for the status.

string
status
required

The HTTP status code.

integer format: int32
detail

A short, safe sentence about this occurrence, when the server has one.

string
code
required

Orvano’s stable error code, from the ErrorCode catalog. SDKs treat it as a plain string.

string
requestId
required

The request ID to quote when reporting a problem; also sent as X-Request-Id.

string
Example
{
"type": "https://orvano.dev/errors/not_found",
"title": "Not Found",
"status": 404,
"code": "not_found",
"requestId": "4bf92f3577b34da6a3ce929d0e0e4736"
}