ory-client 0.2.0.alpha48 → 1.0.0.alpha0

data/docs/OAuth2Client.md

@@ -6,39 +6,49 @@
 | ---- | ---- | ----------- | ----- |
 | **allowed_cors_origins** | **Array<String>** |  | [optional] |
 | **audience** | **Array<String>** |  | [optional] |
-| **backchannel_logout_session_required** | **Boolean** | Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false. | [optional] |
-| **backchannel_logout_uri** | **String** | RP URL that will cause the RP to log itself out when sent a Logout Token by the OP. | [optional] |
-| **client_id** | **String** | ID  is the id for this client. | [optional] |
-| **client_name** | **String** | Name is the human-readable string name of the client to be presented to the end-user during authorization. | [optional] |
-| **client_secret** | **String** | Secret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again. | [optional] |
-| **client_secret_expires_at** | **Integer** | SecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration.  This feature is currently not supported and it's value will always be set to 0. | [optional] |
-| **client_uri** | **String** | ClientURI is an URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion. | [optional] |
+| **authorization_code_grant_access_token_lifespan** | **String** |  | [optional] |
+| **authorization_code_grant_id_token_lifespan** | **String** |  | [optional] |
+| **authorization_code_grant_refresh_token_lifespan** | **String** |  | [optional] |
+| **backchannel_logout_session_required** | **Boolean** | OpenID Connect Back-Channel Logout Session Required  Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false. | [optional] |
+| **backchannel_logout_uri** | **String** | OpenID Connect Back-Channel Logout URI  RP URL that will cause the RP to log itself out when sent a Logout Token by the OP. | [optional] |
+| **client_credentials_grant_access_token_lifespan** | **String** |  | [optional] |
+| **client_id** | **String** | OAuth 2.0 Client ID  The ID is autogenerated and immutable. | [optional] |
+| **client_name** | **String** | OAuth 2.0 Client Name  The human-readable name of the client to be presented to the end-user during authorization. | [optional] |
+| **client_secret** | **String** | OAuth 2.0 Client Secret  The secret will be included in the create request as cleartext, and then never again. The secret is kept in hashed format and is not recoverable once lost. | [optional] |
+| **client_secret_expires_at** | **Integer** | OAuth 2.0 Client Secret Expires At  The field is currently not supported and its value is always 0. | [optional] |
+| **client_uri** | **String** | OAuth 2.0 Client URI  ClientURI is a URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion. | [optional] |
 | **contacts** | **Array<String>** |  | [optional] |
-| **created_at** | **Time** | CreatedAt returns the timestamp of the client's creation. | [optional] |
-| **frontchannel_logout_session_required** | **Boolean** | Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false. | [optional] |
-| **frontchannel_logout_uri** | **String** | RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be. | [optional] |
+| **created_at** | **Time** | OAuth 2.0 Client Creation Date  CreatedAt returns the timestamp of the client's creation. | [optional] |
+| **frontchannel_logout_session_required** | **Boolean** | OpenID Connect Front-Channel Logout Session Required  Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false. | [optional] |
+| **frontchannel_logout_uri** | **String** | OpenID Connect Front-Channel Logout URI  RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be. | [optional] |
 | **grant_types** | **Array<String>** |  | [optional] |
-| **jwks** | **Object** |  | [optional] |
-| **jwks_uri** | **String** | URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. 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. | [optional] |
-| **logo_uri** | **String** | LogoURI is an URL string that references a logo for the client. | [optional] |
+| **implicit_grant_access_token_lifespan** | **String** |  | [optional] |
+| **implicit_grant_id_token_lifespan** | **String** |  | [optional] |
+| **jwks** | **Object** | OAuth 2.0 Client JSON Web Key Set  Client's JSON Web Key Set [JWK] document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it MUST NOT use jwks. One significant downside of jwks is that it does not enable key rotation (which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri and jwks parameters MUST NOT be used together. | [optional] |
+| **jwks_uri** | **String** | OAuth 2.0 Client JSON Web Key Set URL  URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. 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. | [optional] |
+| **jwt_bearer_grant_access_token_lifespan** | **String** |  | [optional] |
+| **logo_uri** | **String** | OAuth 2.0 Client Logo URI  A URL string referencing the client's logo. | [optional] |
 | **metadata** | **Object** |  | [optional] |
-| **owner** | **String** | Owner is a string identifying the owner of the OAuth 2.0 Client. | [optional] |
-| **policy_uri** | **String** | PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data. | [optional] |
+| **owner** | **String** | OAuth 2.0 Client Owner  Owner is a string identifying the owner of the OAuth 2.0 Client. | [optional] |
+| **policy_uri** | **String** | OAuth 2.0 Client Policy URI  PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data. | [optional] |
 | **post_logout_redirect_uris** | **Array<String>** |  | [optional] |
 | **redirect_uris** | **Array<String>** |  | [optional] |
-| **registration_access_token** | **String** | RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. | [optional] |
-| **registration_client_uri** | **String** | RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client. | [optional] |
-| **request_object_signing_alg** | **String** | JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm. | [optional] |
+| **refresh_token_grant_access_token_lifespan** | **String** |  | [optional] |
+| **refresh_token_grant_id_token_lifespan** | **String** |  | [optional] |
+| **refresh_token_grant_refresh_token_lifespan** | **String** |  | [optional] |
+| **registration_access_token** | **String** | OpenID Connect Dynamic Client Registration Access Token  RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration. | [optional] |
+| **registration_client_uri** | **String** | OpenID Connect Dynamic Client Registration URL  RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client. | [optional] |
+| **request_object_signing_alg** | **String** | OpenID Connect Request Object Signing Algorithm  JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm. | [optional] |
 | **request_uris** | **Array<String>** |  | [optional] |
 | **response_types** | **Array<String>** |  | [optional] |
-| **scope** | **String** | Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens. | [optional] |
-| **sector_identifier_uri** | **String** | URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values. | [optional] |
-| **subject_type** | **String** | SubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`. | [optional] |
-| **token_endpoint_auth_method** | **String** | Requested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none. | [optional] |
-| **token_endpoint_auth_signing_alg** | **String** | Requested Client Authentication signing algorithm for the Token Endpoint. | [optional] |
-| **tos_uri** | **String** | TermsOfServiceURI is a URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client. | [optional] |
-| **updated_at** | **Time** | UpdatedAt returns the timestamp of the last update. | [optional] |
-| **userinfo_signed_response_alg** | **String** | JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type. | [optional] |
+| **scope** | **String** | OAuth 2.0 Client Scope  Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens. | [optional] |
+| **sector_identifier_uri** | **String** | OpenID Connect Sector Identifier URI  URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values. | [optional] |
+| **subject_type** | **String** | OpenID Connect Subject Type  The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`. | [optional] |
+| **token_endpoint_auth_method** | **String** | OAuth 2.0 Token Endpoint Authentication Method  Requested Client Authentication method for the Token Endpoint. The options are:  `client_secret_post`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `client_secret_basic`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `none`: Used for public clients (native apps, mobile apps) which can not have secrets. | [optional] |
+| **token_endpoint_auth_signing_alg** | **String** | OAuth 2.0 Token Endpoint Signing Algorithm  Requested Client Authentication signing algorithm for the Token Endpoint. | [optional] |
+| **tos_uri** | **String** | OAuth 2.0 Client Terms of Service URI  A URL string pointing to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client. | [optional] |
+| **updated_at** | **Time** | OAuth 2.0 Client Last Update Date  UpdatedAt returns the timestamp of the last update. | [optional] |
+| **userinfo_signed_response_alg** | **String** | OpenID Connect Request Userinfo Signed Response Algorithm  JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type. | [optional] |
 
 ## Example
 
@@ -48,8 +58,12 @@ require 'ory-client'
 instance = OryClient::OAuth2Client.new(
   allowed_cors_origins: null,
   audience: null,
+  authorization_code_grant_access_token_lifespan: null,
+  authorization_code_grant_id_token_lifespan: null,
+  authorization_code_grant_refresh_token_lifespan: null,
   backchannel_logout_session_required: null,
   backchannel_logout_uri: null,
+  client_credentials_grant_access_token_lifespan: null,
   client_id: null,
   client_name: null,
   client_secret: null,
@@ -60,20 +74,26 @@ instance = OryClient::OAuth2Client.new(
   frontchannel_logout_session_required: null,
   frontchannel_logout_uri: null,
   grant_types: null,
+  implicit_grant_access_token_lifespan: null,
+  implicit_grant_id_token_lifespan: null,
   jwks: null,
   jwks_uri: null,
+  jwt_bearer_grant_access_token_lifespan: null,
   logo_uri: null,
   metadata: null,
   owner: null,
   policy_uri: null,
   post_logout_redirect_uris: null,
   redirect_uris: null,
+  refresh_token_grant_access_token_lifespan: null,
+  refresh_token_grant_id_token_lifespan: null,
+  refresh_token_grant_refresh_token_lifespan: null,
   registration_access_token: null,
   registration_client_uri: null,
   request_object_signing_alg: null,
   request_uris: null,
   response_types: null,
-  scope: null,
+  scope: scope1 scope-2 scope.3 scope:4,
   sector_identifier_uri: null,
   subject_type: null,
   token_endpoint_auth_method: null,

data/docs/OAuth2ClientTokenLifespans.md

@@ -0,0 +1,36 @@
+# OryClient::OAuth2ClientTokenLifespans
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_code_grant_access_token_lifespan** | **String** |  | [optional] |
+| **authorization_code_grant_id_token_lifespan** | **String** |  | [optional] |
+| **authorization_code_grant_refresh_token_lifespan** | **String** |  | [optional] |
+| **client_credentials_grant_access_token_lifespan** | **String** |  | [optional] |
+| **implicit_grant_access_token_lifespan** | **String** |  | [optional] |
+| **implicit_grant_id_token_lifespan** | **String** |  | [optional] |
+| **jwt_bearer_grant_access_token_lifespan** | **String** |  | [optional] |
+| **refresh_token_grant_access_token_lifespan** | **String** |  | [optional] |
+| **refresh_token_grant_id_token_lifespan** | **String** |  | [optional] |
+| **refresh_token_grant_refresh_token_lifespan** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2ClientTokenLifespans.new(
+  authorization_code_grant_access_token_lifespan: null,
+  authorization_code_grant_id_token_lifespan: null,
+  authorization_code_grant_refresh_token_lifespan: null,
+  client_credentials_grant_access_token_lifespan: null,
+  implicit_grant_access_token_lifespan: null,
+  implicit_grant_id_token_lifespan: null,
+  jwt_bearer_grant_access_token_lifespan: null,
+  refresh_token_grant_access_token_lifespan: null,
+  refresh_token_grant_id_token_lifespan: null,
+  refresh_token_grant_refresh_token_lifespan: null
+)
+```
+

data/docs/OAuth2ConsentRequest.md

@@ -0,0 +1,42 @@
+# OryClient::OAuth2ConsentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acr** | **String** | ACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication. | [optional] |
+| **amr** | **Array<String>** |  | [optional] |
+| **challenge** | **String** | ID is the identifier (\"authorization challenge\") of the consent authorization request. It is used to identify the session. |  |
+| **client** | [**OAuth2Client**](OAuth2Client.md) |  | [optional] |
+| **context** | **Object** |  | [optional] |
+| **login_challenge** | **String** | LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app. | [optional] |
+| **login_session_id** | **String** | LoginSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user. | [optional] |
+| **oidc_context** | [**OAuth2ConsentRequestOpenIDConnectContext**](OAuth2ConsentRequestOpenIDConnectContext.md) |  | [optional] |
+| **request_url** | **String** | RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters. | [optional] |
+| **requested_access_token_audience** | **Array<String>** |  | [optional] |
+| **requested_scope** | **Array<String>** |  | [optional] |
+| **skip** | **Boolean** | Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call. | [optional] |
+| **subject** | **String** | Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2ConsentRequest.new(
+  acr: null,
+  amr: null,
+  challenge: null,
+  client: null,
+  context: null,
+  login_challenge: null,
+  login_session_id: null,
+  oidc_context: null,
+  request_url: null,
+  requested_access_token_audience: null,
+  requested_scope: null,
+  skip: null,
+  subject: null
+)
+```
+

data/docs/OAuth2ConsentRequestOpenIDConnectContext.md

@@ -0,0 +1,26 @@
+# OryClient::OAuth2ConsentRequestOpenIDConnectContext
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acr_values** | **Array<String>** | ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.  OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter. | [optional] |
+| **display** | **String** | Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. The defined values are: page: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. popup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.  The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display. | [optional] |
+| **id_token_hint_claims** | **Hash<String, Object>** | IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client. | [optional] |
+| **login_hint** | **String** | LoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone number in the format specified for the phone_number Claim. The use of this parameter is optional. | [optional] |
+| **ui_locales** | **Array<String>** | UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value \"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2ConsentRequestOpenIDConnectContext.new(
+  acr_values: null,
+  display: null,
+  id_token_hint_claims: null,
+  login_hint: null,
+  ui_locales: null
+)
+```
+

data/docs/OAuth2ConsentSession.md

@@ -0,0 +1,32 @@
+# OryClient::OAuth2ConsentSession
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consent_request** | [**OAuth2ConsentRequest**](OAuth2ConsentRequest.md) |  | [optional] |
+| **expires_at** | [**OAuth2ConsentSessionExpiresAt**](OAuth2ConsentSessionExpiresAt.md) |  | [optional] |
+| **grant_access_token_audience** | **Array<String>** |  | [optional] |
+| **grant_scope** | **Array<String>** |  | [optional] |
+| **handled_at** | **Time** |  | [optional] |
+| **remember** | **Boolean** | Remember Consent  Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope. | [optional] |
+| **remember_for** | **Integer** | Remember Consent For  RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. | [optional] |
+| **session** | [**AcceptOAuth2ConsentRequestSession**](AcceptOAuth2ConsentRequestSession.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2ConsentSession.new(
+  consent_request: null,
+  expires_at: null,
+  grant_access_token_audience: null,
+  grant_scope: null,
+  handled_at: null,
+  remember: null,
+  remember_for: null,
+  session: null
+)
+```
+

data/docs/OAuth2ConsentSessionExpiresAt.md

@@ -0,0 +1,26 @@
+# OryClient::OAuth2ConsentSessionExpiresAt
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **Time** |  | [optional] |
+| **authorize_code** | **Time** |  | [optional] |
+| **id_token** | **Time** |  | [optional] |
+| **par_context** | **Time** |  | [optional] |
+| **refresh_token** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2ConsentSessionExpiresAt.new(
+  access_token: null,
+  authorize_code: null,
+  id_token: null,
+  par_context: null,
+  refresh_token: null
+)
+```
+

data/docs/OAuth2LoginRequest.md

@@ -0,0 +1,34 @@
+# OryClient::OAuth2LoginRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **challenge** | **String** | ID is the identifier (\"login challenge\") of the login request. It is used to identify the session. |  |
+| **client** | [**OAuth2Client**](OAuth2Client.md) |  |  |
+| **oidc_context** | [**OAuth2ConsentRequestOpenIDConnectContext**](OAuth2ConsentRequestOpenIDConnectContext.md) |  | [optional] |
+| **request_url** | **String** | RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters. |  |
+| **requested_access_token_audience** | **Array<String>** |  |  |
+| **requested_scope** | **Array<String>** |  |  |
+| **session_id** | **String** | SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user. | [optional] |
+| **skip** | **Boolean** | Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.  This feature allows you to update / set session information. |  |
+| **subject** | **String** | Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type when accepting the login request, or the request will fail. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2LoginRequest.new(
+  challenge: null,
+  client: null,
+  oidc_context: null,
+  request_url: null,
+  requested_access_token_audience: null,
+  requested_scope: null,
+  session_id: null,
+  skip: null,
+  subject: null
+)
+```
+

data/docs/OAuth2LogoutRequest.md

@@ -0,0 +1,28 @@
+# OryClient::OAuth2LogoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **challenge** | **String** | Challenge is the identifier (\"logout challenge\") of the logout authentication request. It is used to identify the session. | [optional] |
+| **client** | [**OAuth2Client**](OAuth2Client.md) |  | [optional] |
+| **request_url** | **String** | RequestURL is the original Logout URL requested. | [optional] |
+| **rp_initiated** | **Boolean** | RPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client. | [optional] |
+| **sid** | **String** | SessionID is the login session ID that was requested to log out. | [optional] |
+| **subject** | **String** | Subject is the user for whom the logout was request. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2LogoutRequest.new(
+  challenge: null,
+  client: null,
+  request_url: null,
+  rp_initiated: null,
+  sid: null,
+  subject: null
+)
+```
+

data/docs/OAuth2RedirectTo.md

@@ -0,0 +1,18 @@
+# OryClient::OAuth2RedirectTo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redirect_to** | **String** | RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2RedirectTo.new(
+  redirect_to: null
+)
+```
+

data/docs/OAuth2TokenExchange.md

@@ -0,0 +1,28 @@
+# OryClient::OAuth2TokenExchange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | The access token issued by the authorization server. | [optional] |
+| **expires_in** | **Integer** | The lifetime in seconds of the access token. For example, the value \"3600\" denotes that the access token will expire in one hour from the time the response was generated. | [optional] |
+| **id_token** | **Integer** | To retrieve a refresh token request the id_token scope. | [optional] |
+| **refresh_token** | **String** | The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope \"offline\" to your access token request. | [optional] |
+| **scope** | **Integer** | The scope of the access token | [optional] |
+| **token_type** | **String** | The type of the token issued | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::OAuth2TokenExchange.new(
+  access_token: null,
+  expires_in: null,
+  id_token: null,
+  refresh_token: null,
+  scope: null,
+  token_type: null
+)
+```
+