Sha256: b6ed0c96c815549886d620d42bdd8cfb78fc1d188e73a5b6bf5bfe0ced54de52

Contents?: true

Size: 1.77 KB

Versions: 88

Compression:

Stored size: 1.77 KB

Contents

# OryClient::WellknownApi

All URIs are relative to *https://playground.projects.oryapis.com*

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**discover_json_web_keys**](WellknownApi.md#discover_json_web_keys) | **GET** /.well-known/jwks.json | Discover Well-Known JSON Web Keys |


## discover_json_web_keys

> <JsonWebKeySet> discover_json_web_keys

Discover Well-Known JSON Web Keys

This endpoint returns JSON Web Keys required to verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like [node-jwks-rsa](https://github.com/auth0/node-jwks-rsa) among others.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::WellknownApi.new

begin
  # Discover Well-Known JSON Web Keys
  result = api_instance.discover_json_web_keys
  p result
rescue OryClient::ApiError => e
  puts "Error when calling WellknownApi->discover_json_web_keys: #{e}"
end
```

#### Using the discover_json_web_keys_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<JsonWebKeySet>, Integer, Hash)> discover_json_web_keys_with_http_info

```ruby
begin
  # Discover Well-Known JSON Web Keys
  data, status_code, headers = api_instance.discover_json_web_keys_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <JsonWebKeySet>
rescue OryClient::ApiError => e
  puts "Error when calling WellknownApi->discover_json_web_keys_with_http_info: #{e}"
end
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**JsonWebKeySet**](JsonWebKeySet.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Version data entries

88 entries across 88 versions & 1 rubygems

Version Path
ory-client-1.11.6 docs/WellknownApi.md
ory-client-1.9.0 docs/WellknownApi.md
ory-client-1.8.1 docs/WellknownApi.md
ory-client-1.8.0 docs/WellknownApi.md
ory-client-1.6.2 docs/WellknownApi.md
ory-client-1.6.1 docs/WellknownApi.md
ory-client-1.5.2 docs/WellknownApi.md
ory-client-1.5.1 docs/WellknownApi.md
ory-client-1.5.0 docs/WellknownApi.md
ory-client-1.4.9 docs/WellknownApi.md
ory-client-1.4.8 docs/WellknownApi.md
ory-client-1.4.7 docs/WellknownApi.md
ory-client-1.4.6 docs/WellknownApi.md
ory-client-1.4.5 docs/WellknownApi.md
ory-client-1.4.4 docs/WellknownApi.md
ory-client-1.4.3 docs/WellknownApi.md
ory-client-1.4.2 docs/WellknownApi.md
ory-client-1.4.1 docs/WellknownApi.md
ory-client-1.4.0 docs/WellknownApi.md
ory-client-1.3.0 docs/WellknownApi.md