ory-client 0.2.0.alpha48 → 1.0.0.alpha0

data/docs/OidcApi.md

@@ -0,0 +1,473 @@
+# OryClient::OidcApi
+
+All URIs are relative to *https://playground.projects.oryapis.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_oidc_dynamic_client**](OidcApi.md#create_oidc_dynamic_client) | **POST** /oauth2/register | Register OAuth2 Client using OpenID Dynamic Client Registration |
+| [**delete_oidc_dynamic_client**](OidcApi.md#delete_oidc_dynamic_client) | **DELETE** /oauth2/register/{id} | Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol |
+| [**discover_oidc_configuration**](OidcApi.md#discover_oidc_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery |
+| [**get_oidc_dynamic_client**](OidcApi.md#get_oidc_dynamic_client) | **GET** /oauth2/register/{id} | Get OAuth2 Client using OpenID Dynamic Client Registration |
+| [**get_oidc_user_info**](OidcApi.md#get_oidc_user_info) | **GET** /userinfo | OpenID Connect Userinfo |
+| [**revoke_oidc_session**](OidcApi.md#revoke_oidc_session) | **GET** /oauth2/sessions/logout | OpenID Connect Front- and Back-channel Enabled Logout |
+| [**set_oidc_dynamic_client**](OidcApi.md#set_oidc_dynamic_client) | **PUT** /oauth2/register/{id} | Set OAuth2 Client using OpenID Dynamic Client Registration |
+
+
+## create_oidc_dynamic_client
+
+> <OAuth2Client> create_oidc_dynamic_client(o_auth2_client)
+
+Register OAuth2 Client using OpenID Dynamic Client Registration
+
+This endpoint behaves like the administrative counterpart (`createOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator.  Please note that using this endpoint you are not able to choose the `client_secret` nor the `client_id` as those values will be server generated when specifying `token_endpoint_auth_method` as `client_secret_basic` or `client_secret_post`.  The `client_secret` will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somewhere safe.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::OidcApi.new
+o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client | Dynamic Client Registration Request Body
+
+begin
+  # Register OAuth2 Client using OpenID Dynamic Client Registration
+  result = api_instance.create_oidc_dynamic_client(o_auth2_client)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->create_oidc_dynamic_client: #{e}"
+end
+```
+
+#### Using the create_oidc_dynamic_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuth2Client>, Integer, Hash)> create_oidc_dynamic_client_with_http_info(o_auth2_client)
+
+```ruby
+begin
+  # Register OAuth2 Client using OpenID Dynamic Client Registration
+  data, status_code, headers = api_instance.create_oidc_dynamic_client_with_http_info(o_auth2_client)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuth2Client>
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->create_oidc_dynamic_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) | Dynamic Client Registration Request Body |  |
+
+### Return type
+
+[**OAuth2Client**](OAuth2Client.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_oidc_dynamic_client
+
+> delete_oidc_dynamic_client(id)
+
+Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
+
+This endpoint behaves like the administrative counterpart (`deleteOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator.  To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header.  OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::OidcApi.new
+id = 'id_example' # String | The id of the OAuth 2.0 Client.
+
+begin
+  # Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
+  api_instance.delete_oidc_dynamic_client(id)
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->delete_oidc_dynamic_client: #{e}"
+end
+```
+
+#### Using the delete_oidc_dynamic_client_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_oidc_dynamic_client_with_http_info(id)
+
+```ruby
+begin
+  # Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
+  data, status_code, headers = api_instance.delete_oidc_dynamic_client_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->delete_oidc_dynamic_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the OAuth 2.0 Client. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## discover_oidc_configuration
+
+> <OidcConfiguration> discover_oidc_configuration
+
+OpenID Connect Discovery
+
+A mechanism for an OpenID Connect Relying Party to discover the End-User's OpenID Provider and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.  Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of clients go here: https://openid.net/developers/certified/
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::OidcApi.new
+
+begin
+  # OpenID Connect Discovery
+  result = api_instance.discover_oidc_configuration
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->discover_oidc_configuration: #{e}"
+end
+```
+
+#### Using the discover_oidc_configuration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OidcConfiguration>, Integer, Hash)> discover_oidc_configuration_with_http_info
+
+```ruby
+begin
+  # OpenID Connect Discovery
+  data, status_code, headers = api_instance.discover_oidc_configuration_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OidcConfiguration>
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->discover_oidc_configuration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**OidcConfiguration**](OidcConfiguration.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_oidc_dynamic_client
+
+> <OAuth2Client> get_oidc_dynamic_client(id)
+
+Get OAuth2 Client using OpenID Dynamic Client Registration
+
+This endpoint behaves like the administrative counterpart (`getOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol.  To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::OidcApi.new
+id = 'id_example' # String | The id of the OAuth 2.0 Client.
+
+begin
+  # Get OAuth2 Client using OpenID Dynamic Client Registration
+  result = api_instance.get_oidc_dynamic_client(id)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->get_oidc_dynamic_client: #{e}"
+end
+```
+
+#### Using the get_oidc_dynamic_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuth2Client>, Integer, Hash)> get_oidc_dynamic_client_with_http_info(id)
+
+```ruby
+begin
+  # Get OAuth2 Client using OpenID Dynamic Client Registration
+  data, status_code, headers = api_instance.get_oidc_dynamic_client_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuth2Client>
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->get_oidc_dynamic_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the OAuth 2.0 Client. |  |
+
+### Return type
+
+[**OAuth2Client**](OAuth2Client.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_oidc_user_info
+
+> <OidcUserInfo> get_oidc_user_info
+
+OpenID Connect Userinfo
+
+This endpoint returns the payload of the ID Token, including `session.id_token` values, of the provided OAuth 2.0 Access Token's consent request.  In the case of authentication error, a WWW-Authenticate header might be set in the response with more information about the error. See [the spec](https://datatracker.ietf.org/doc/html/rfc6750#section-3) for more details about header format.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OryClient::OidcApi.new
+
+begin
+  # OpenID Connect Userinfo
+  result = api_instance.get_oidc_user_info
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->get_oidc_user_info: #{e}"
+end
+```
+
+#### Using the get_oidc_user_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OidcUserInfo>, Integer, Hash)> get_oidc_user_info_with_http_info
+
+```ruby
+begin
+  # OpenID Connect Userinfo
+  data, status_code, headers = api_instance.get_oidc_user_info_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OidcUserInfo>
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->get_oidc_user_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**OidcUserInfo**](OidcUserInfo.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## revoke_oidc_session
+
+> revoke_oidc_session
+
+OpenID Connect Front- and Back-channel Enabled Logout
+
+This endpoint initiates and completes user logout at the Ory OAuth2 & OpenID provider and initiates OpenID Connect Front- / Back-channel logout:  https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html  Back-channel logout is performed asynchronously and does not affect logout flow.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::OidcApi.new
+
+begin
+  # OpenID Connect Front- and Back-channel Enabled Logout
+  api_instance.revoke_oidc_session
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->revoke_oidc_session: #{e}"
+end
+```
+
+#### Using the revoke_oidc_session_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> revoke_oidc_session_with_http_info
+
+```ruby
+begin
+  # OpenID Connect Front- and Back-channel Enabled Logout
+  data, status_code, headers = api_instance.revoke_oidc_session_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->revoke_oidc_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## set_oidc_dynamic_client
+
+> <OAuth2Client> set_oidc_dynamic_client(id, o_auth2_client)
+
+Set OAuth2 Client using OpenID Dynamic Client Registration
+
+This endpoint behaves like the administrative counterpart (`setOAuth2Client`) but is capable of facing the public internet directly to be used by third parties. It implements the OpenID Connect Dynamic Client Registration Protocol.  This feature is disabled per default. It can be enabled by a system administrator.  If you pass `client_secret` the secret is used, otherwise the existing secret is used. If set, the secret is echoed in the response. It is not possible to retrieve it later on.  To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header.  OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::OidcApi.new
+id = 'id_example' # String | OAuth 2.0 Client ID
+o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client | OAuth 2.0 Client Request Body
+
+begin
+  # Set OAuth2 Client using OpenID Dynamic Client Registration
+  result = api_instance.set_oidc_dynamic_client(id, o_auth2_client)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->set_oidc_dynamic_client: #{e}"
+end
+```
+
+#### Using the set_oidc_dynamic_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuth2Client>, Integer, Hash)> set_oidc_dynamic_client_with_http_info(id, o_auth2_client)
+
+```ruby
+begin
+  # Set OAuth2 Client using OpenID Dynamic Client Registration
+  data, status_code, headers = api_instance.set_oidc_dynamic_client_with_http_info(id, o_auth2_client)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuth2Client>
+rescue OryClient::ApiError => e
+  puts "Error when calling OidcApi->set_oidc_dynamic_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | OAuth 2.0 Client ID |  |
+| **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) | OAuth 2.0 Client Request Body |  |
+
+### Return type
+
+[**OAuth2Client**](OAuth2Client.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OidcConfiguration.md

@@ -0,0 +1,74 @@
+# OryClient::OidcConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_endpoint** | **String** | OAuth 2.0 Authorization Endpoint URL |  |
+| **backchannel_logout_session_supported** | **Boolean** | OpenID Connect Back-Channel Logout Session Required  Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP | [optional] |
+| **backchannel_logout_supported** | **Boolean** | OpenID Connect Back-Channel Logout Supported  Boolean value specifying whether the OP supports back-channel logout, with true indicating support. | [optional] |
+| **claims_parameter_supported** | **Boolean** | OpenID Connect Claims Parameter Parameter Supported  Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. | [optional] |
+| **claims_supported** | **Array<String>** | OpenID Connect Supported Claims  JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. | [optional] |
+| **code_challenge_methods_supported** | **Array<String>** | OAuth 2.0 PKCE Supported Code Challenge Methods  JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server. | [optional] |
+| **end_session_endpoint** | **String** | OpenID Connect End-Session Endpoint  URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP. | [optional] |
+| **frontchannel_logout_session_supported** | **Boolean** | OpenID Connect Front-Channel Logout Session Required  Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP. | [optional] |
+| **frontchannel_logout_supported** | **Boolean** | OpenID Connect Front-Channel Logout Supported  Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support. | [optional] |
+| **grant_types_supported** | **Array<String>** | OAuth 2.0 Supported Grant Types  JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. | [optional] |
+| **id_token_signed_response_alg** | **Array<String>** | OpenID Connect Default ID Token Signing Algorithms  Algorithm used to sign OpenID Connect ID Tokens. |  |
+| **id_token_signing_alg_values_supported** | **Array<String>** | OpenID Connect Supported ID Token Signing Algorithms  JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT. |  |
+| **issuer** | **String** | OpenID Connect Issuer URL  An URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL. |  |
+| **jwks_uri** | **String** | OpenID Connect Well-Known JSON Web Keys URL  URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. |  |
+| **registration_endpoint** | **String** | OpenID Connect Dynamic Client Registration Endpoint URL | [optional] |
+| **request_object_signing_alg_values_supported** | **Array<String>** | OpenID Connect Supported Request Object Signing Algorithms  JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter). | [optional] |
+| **request_parameter_supported** | **Boolean** | OpenID Connect Request Parameter Supported  Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. | [optional] |
+| **request_uri_parameter_supported** | **Boolean** | OpenID Connect Request URI Parameter Supported  Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. | [optional] |
+| **require_request_uri_registration** | **Boolean** | OpenID Connect Requires Request URI Registration  Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter. | [optional] |
+| **response_modes_supported** | **Array<String>** | OAuth 2.0 Supported Response Modes  JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports. | [optional] |
+| **response_types_supported** | **Array<String>** | OAuth 2.0 Supported Response Types  JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values. |  |
+| **revocation_endpoint** | **String** | OAuth 2.0 Token Revocation URL  URL of the authorization server's OAuth 2.0 revocation endpoint. | [optional] |
+| **scopes_supported** | **Array<String>** | OAuth 2.0 Supported Scope Values  JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used | [optional] |
+| **subject_types_supported** | **Array<String>** | OpenID Connect Supported Subject Types  JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public. |  |
+| **token_endpoint** | **String** | OAuth 2.0 Token Endpoint URL |  |
+| **token_endpoint_auth_methods_supported** | **Array<String>** | OAuth 2.0 Supported Client Authentication Methods  JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0 | [optional] |
+| **userinfo_endpoint** | **String** | OpenID Connect Userinfo URL  URL of the OP's UserInfo Endpoint. | [optional] |
+| **userinfo_signed_response_alg** | **Array<String>** | OpenID Connect User Userinfo Signing Algorithm  Algorithm used to sign OpenID Connect Userinfo Responses. |  |
+| **userinfo_signing_alg_values_supported** | **Array<String>** | OpenID Connect Supported Userinfo Signing Algorithm  JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OidcConfiguration.new(
+  authorization_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/auth,
+  backchannel_logout_session_supported: null,
+  backchannel_logout_supported: null,
+  claims_parameter_supported: null,
+  claims_supported: null,
+  code_challenge_methods_supported: null,
+  end_session_endpoint: null,
+  frontchannel_logout_session_supported: null,
+  frontchannel_logout_supported: null,
+  grant_types_supported: null,
+  id_token_signed_response_alg: null,
+  id_token_signing_alg_values_supported: null,
+  issuer: https://playground.ory.sh/ory-hydra/public/,
+  jwks_uri: https://{slug}.projects.oryapis.com/.well-known/jwks.json,
+  registration_endpoint: https://playground.ory.sh/ory-hydra/admin/client,
+  request_object_signing_alg_values_supported: null,
+  request_parameter_supported: null,
+  request_uri_parameter_supported: null,
+  require_request_uri_registration: null,
+  response_modes_supported: null,
+  response_types_supported: null,
+  revocation_endpoint: null,
+  scopes_supported: null,
+  subject_types_supported: null,
+  token_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/token,
+  token_endpoint_auth_methods_supported: null,
+  userinfo_endpoint: null,
+  userinfo_signed_response_alg: null,
+  userinfo_signing_alg_values_supported: null
+)
+```
+

data/docs/OidcUserInfo.md

@@ -0,0 +1,54 @@
+# OryClient::OidcUserInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **birthdate** | **String** | End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates. | [optional] |
+| **email** | **String** | End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. | [optional] |
+| **email_verified** | **Boolean** | True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. | [optional] |
+| **family_name** | **String** | Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters. | [optional] |
+| **gender** | **String** | End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable. | [optional] |
+| **given_name** | **String** | Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters. | [optional] |
+| **locale** | **String** | End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well. | [optional] |
+| **middle_name** | **String** | Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used. | [optional] |
+| **name** | **String** | End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. | [optional] |
+| **nickname** | **String** | Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael. | [optional] |
+| **phone_number** | **String** | End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678. | [optional] |
+| **phone_number_verified** | **Boolean** | True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format. | [optional] |
+| **picture** | **String** | URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User. | [optional] |
+| **preferred_username** | **String** | Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. | [optional] |
+| **profile** | **String** | URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. | [optional] |
+| **sub** | **String** | Subject - Identifier for the End-User at the IssuerURL. | [optional] |
+| **updated_at** | **Integer** | Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. | [optional] |
+| **website** | **String** | URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with. | [optional] |
+| **zoneinfo** | **String** | String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OidcUserInfo.new(
+  birthdate: null,
+  email: null,
+  email_verified: null,
+  family_name: null,
+  gender: null,
+  given_name: null,
+  locale: null,
+  middle_name: null,
+  name: null,
+  nickname: null,
+  phone_number: null,
+  phone_number_verified: null,
+  picture: null,
+  preferred_username: null,
+  profile: null,
+  sub: null,
+  updated_at: null,
+  website: null,
+  zoneinfo: null
+)
+```
+

data/docs/Pagination.md

@@ -5,6 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **page** | **Integer** | Pagination Page  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
+| **page_size** | **Integer** | Items per page  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to 250] |
+| **page_token** | **String** | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to '1'] |
 | **per_page** | **Integer** | Items per Page  This is the number of items per page. | [optional][default to 250] |
 
 ## Example
@@ -14,6 +16,8 @@ require 'ory-client'
 
 instance = OryClient::Pagination.new(
   page: null,
+  page_size: null,
+  page_token: null,
   per_page: null
 )
 ```

data/docs/PaginationHeaders.md

@@ -0,0 +1,20 @@
+# OryClient::PaginationHeaders
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **link** | **String** | The link header contains pagination links.  For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).  in: header | [optional] |
+| **x_total_count** | **String** | The total number of clients.  in: header | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::PaginationHeaders.new(
+  link: null,
+  x_total_count: null
+)
+```
+

data/docs/ParseError.md

@@ -0,0 +1,22 @@
+# OryClient::ParseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_end** | [**SourcePosition**](SourcePosition.md) |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **start** | [**SourcePosition**](SourcePosition.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ParseError.new(
+  _end: null,
+  message: null,
+  start: null
+)
+```
+