keys.getOpenIdConfiguration

GET

/v1/projects/{projectId}/.well-known/openid-configuration

import { Client, Orvano } from '@orvano/js'

const orvano = new Orvano(new Client({ endpoint: 'https://orvano.example.com' }))

const openIdConfiguration = await orvano.keys.getOpenIdConfiguration('<projectId>')
console.log(openIdConfiguration)

// app/page.tsx, a server component. Route handlers and server actions use createServerClient too.
import { cookies } from 'next/headers'
import { createServerClient } from '@orvano/nextjs'

export default async function Page() {
  const orvano = createServerClient({
    endpoint: process.env.ORVANO_ENDPOINT!,
    cookies: await cookies(),
  })
  const openIdConfiguration = await orvano.keys.getOpenIdConfiguration('<projectId>')
  return <pre>{JSON.stringify(openIdConfiguration, null, 2)}</pre>
}

import 'package:orvano_flutter/orvano_flutter.dart';

Future<void> main() async {
  final orvano = Orvano(Client(endpoint: 'https://orvano.example.com'));
  final openIdConfiguration = await orvano.keys.getOpenIdConfiguration(
    '<projectId>',
  );
  print(openIdConfiguration.toJson());
}

import 'dart:io';

import 'package:orvano_dart/orvano_dart.dart';

Future<void> main() async {
  final orvano = Orvano(
    Client(
      endpoint: 'https://orvano.example.com',
      apiKey: Platform.environment['ORVANO_API_KEY'],
    ),
  );
  final openIdConfiguration = await orvano.keys.getOpenIdConfiguration(
    '<projectId>',
  );
  print(openIdConfiguration.toJson());
}

using Orvano;

using var orvano = new OrvanoClient(new OrvanoClientOptions(new Uri("https://orvano.example.com"))
{
    ApiKey = Environment.GetEnvironmentVariable("ORVANO_API_KEY"),
});
var openIdConfiguration = await orvano.Keys.GetOpenIdConfigurationAsync("<projectId>");
Console.WriteLine(openIdConfiguration);

Gets a project’s discovery document, for JWT libraries that configure themselves from the issuer.

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.

Parameters

Path Parameters

projectId

required

string

The project ID.

Responses

200

The request has succeeded.

application/json

The discovery document standard JWT libraries configure themselves from. Orvano is not an OpenID provider; this exists so tools that take an issuer URL find the keys. Its names are the standard snake case ones.

object

issuer

required

The issuer, the iss of every access token of the project.

string

jwks_uri

required

Where the project’s JWKS lives.

string

id_token_signing_alg_values_supported

required

Always ["ES256"].

Array<string>

subject_types_supported

required

Always ["public"].

Array<string>

response_types_supported

required

Always ["token"].

Array<string>

Example

{
  "issuer": "https://orvano.example.com/v1/projects/shop",
  "jwks_uri": "https://orvano.example.com/v1/projects/shop/.well-known/jwks.json"
}

default

An unexpected error response.

application/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"
}