ory-hydra-client 1.9.0.alpha1 → 1.9.2

data/docs/LogoutRequest.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::LogoutRequest.new(request_url: null,
-                                 rp_initiated: null,
-                                 sid: null,
-                                 subject: null)
+instance = OryHydraClient::LogoutRequest.new(
+  request_url: null,
+  rp_initiated: null,
+  sid: null,
+  subject: null
+)
 ```
 
-

data/docs/OAuth2Client.md

@@ -2,80 +2,81 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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] 
-**contacts** | **Array<String>** |  | [optional] 
-**created_at** | **DateTime** | 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] 
-**grant_types** | **Array<String>** |  | [optional] 
-**jwks** | [**Object**](.md) |  | [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] 
-**metadata** | [**Object**](.md) |  | [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] 
-**post_logout_redirect_uris** | **Array<String>** |  | [optional] 
-**redirect_uris** | **Array<String>** |  | [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] 
-**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** | **DateTime** | 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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **post_logout_redirect_uris** | **Array<String>** |  | [optional] |
+| **redirect_uris** | **Array<String>** |  | [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] |
+| **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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::OAuth2Client.new(allowed_cors_origins: null,
-                                 audience: null,
-                                 backchannel_logout_session_required: null,
-                                 backchannel_logout_uri: null,
-                                 client_id: null,
-                                 client_name: null,
-                                 client_secret: null,
-                                 client_secret_expires_at: null,
-                                 client_uri: null,
-                                 contacts: null,
-                                 created_at: null,
-                                 frontchannel_logout_session_required: null,
-                                 frontchannel_logout_uri: null,
-                                 grant_types: null,
-                                 jwks: null,
-                                 jwks_uri: null,
-                                 logo_uri: null,
-                                 metadata: null,
-                                 owner: null,
-                                 policy_uri: null,
-                                 post_logout_redirect_uris: null,
-                                 redirect_uris: null,
-                                 request_object_signing_alg: null,
-                                 request_uris: null,
-                                 response_types: null,
-                                 scope: null,
-                                 sector_identifier_uri: null,
-                                 subject_type: null,
-                                 token_endpoint_auth_method: null,
-                                 token_endpoint_auth_signing_alg: null,
-                                 tos_uri: null,
-                                 updated_at: null,
-                                 userinfo_signed_response_alg: null)
+instance = OryHydraClient::OAuth2Client.new(
+  allowed_cors_origins: null,
+  audience: null,
+  backchannel_logout_session_required: null,
+  backchannel_logout_uri: null,
+  client_id: null,
+  client_name: null,
+  client_secret: null,
+  client_secret_expires_at: null,
+  client_uri: null,
+  contacts: null,
+  created_at: null,
+  frontchannel_logout_session_required: null,
+  frontchannel_logout_uri: null,
+  grant_types: null,
+  jwks: null,
+  jwks_uri: null,
+  logo_uri: null,
+  metadata: null,
+  owner: null,
+  policy_uri: null,
+  post_logout_redirect_uris: null,
+  redirect_uris: null,
+  request_object_signing_alg: null,
+  request_uris: null,
+  response_types: null,
+  scope: null,
+  sector_identifier_uri: null,
+  subject_type: null,
+  token_endpoint_auth_method: null,
+  token_endpoint_auth_signing_alg: null,
+  tos_uri: null,
+  updated_at: null,
+  userinfo_signed_response_alg: null
+)
 ```
 
-

data/docs/OAuth2TokenIntrospection.md

@@ -2,40 +2,43 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** | Active is a boolean indicator of whether or not the presented token is currently active.  The specifics of a token's \"active\" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a \"true\" value return for the \"active\" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time). | 
-**aud** | **Array<String>** | Audience contains a list of the token's intended audiences. | [optional] 
-**client_id** | **String** | ID is aclient identifier for the OAuth 2.0 client that requested this token. | [optional] 
-**exp** | **Integer** | Expires at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire. | [optional] 
-**ext** | [**Object**](.md) | Extra is arbitrary data set by the session. | [optional] 
-**iat** | **Integer** | Issued at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued. | [optional] 
-**iss** | **String** | IssuerURL is a string representing the issuer of this token | [optional] 
-**nbf** | **Integer** | NotBefore is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before. | [optional] 
-**obfuscated_subject** | **String** | ObfuscatedSubject is set when the subject identifier algorithm was set to \"pairwise\" during authorization. It is the `sub` value of the ID Token that was issued. | [optional] 
-**scope** | **String** | Scope is a JSON string containing a space-separated list of scopes associated with this token. | [optional] 
-**sub** | **String** | Subject of the token, as defined in JWT [RFC7519]. Usually a machine-readable identifier of the resource owner who authorized this token. | [optional] 
-**token_type** | **String** | TokenType is the introspected token's type, for example `access_token` or `refresh_token`. | [optional] 
-**username** | **String** | Username is a human-readable identifier for the resource owner who authorized this token. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Active is a boolean indicator of whether or not the presented token is currently active.  The specifics of a token's \"active\" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a \"true\" value return for the \"active\" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time). |  |
+| **aud** | **Array<String>** | Audience contains a list of the token's intended audiences. | [optional] |
+| **client_id** | **String** | ID is aclient identifier for the OAuth 2.0 client that requested this token. | [optional] |
+| **exp** | **Integer** | Expires at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire. | [optional] |
+| **ext** | **Object** | Extra is arbitrary data set by the session. | [optional] |
+| **iat** | **Integer** | Issued at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued. | [optional] |
+| **iss** | **String** | IssuerURL is a string representing the issuer of this token | [optional] |
+| **nbf** | **Integer** | NotBefore is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before. | [optional] |
+| **obfuscated_subject** | **String** | ObfuscatedSubject is set when the subject identifier algorithm was set to \"pairwise\" during authorization. It is the `sub` value of the ID Token that was issued. | [optional] |
+| **scope** | **String** | Scope is a JSON string containing a space-separated list of scopes associated with this token. | [optional] |
+| **sub** | **String** | Subject of the token, as defined in JWT [RFC7519]. Usually a machine-readable identifier of the resource owner who authorized this token. | [optional] |
+| **token_type** | **String** | TokenType is the introspected token's type, typically `Bearer`. | [optional] |
+| **token_use** | **String** | TokenUse is the introspected token's use, for example `access_token` or `refresh_token`. | [optional] |
+| **username** | **String** | Username is a human-readable identifier for the resource owner who authorized this token. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::OAuth2TokenIntrospection.new(active: null,
-                                 aud: null,
-                                 client_id: null,
-                                 exp: null,
-                                 ext: null,
-                                 iat: null,
-                                 iss: null,
-                                 nbf: null,
-                                 obfuscated_subject: null,
-                                 scope: null,
-                                 sub: null,
-                                 token_type: null,
-                                 username: null)
+instance = OryHydraClient::OAuth2TokenIntrospection.new(
+  active: null,
+  aud: null,
+  client_id: null,
+  exp: null,
+  ext: null,
+  iat: null,
+  iss: null,
+  nbf: null,
+  obfuscated_subject: null,
+  scope: null,
+  sub: null,
+  token_type: null,
+  token_use: null,
+  username: null
+)
 ```
 
-

data/docs/Oauth2TokenResponse.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**access_token** | **String** |  | [optional] 
-**expires_in** | **Integer** |  | [optional] 
-**id_token** | **String** |  | [optional] 
-**refresh_token** | **String** |  | [optional] 
-**scope** | **String** |  | [optional] 
-**token_type** | **String** |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  | [optional] |
+| **expires_in** | **Integer** |  | [optional] |
+| **id_token** | **String** |  | [optional] |
+| **refresh_token** | **String** |  | [optional] |
+| **scope** | **String** |  | [optional] |
+| **token_type** | **String** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::Oauth2TokenResponse.new(access_token: null,
-                                 expires_in: null,
-                                 id_token: null,
-                                 refresh_token: null,
-                                 scope: null,
-                                 token_type: null)
+instance = OryHydraClient::Oauth2TokenResponse.new(
+  access_token: null,
+  expires_in: null,
+  id_token: null,
+  refresh_token: null,
+  scope: null,
+  token_type: null
+)
 ```
 
-

data/docs/OpenIDConnectContext.md

@@ -2,24 +2,25 @@
 
 ## 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** | [**Object**](.md) | 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] 
+| 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** | **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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::OpenIDConnectContext.new(acr_values: null,
-                                 display: null,
-                                 id_token_hint_claims: null,
-                                 login_hint: null,
-                                 ui_locales: null)
+instance = OryHydraClient::OpenIDConnectContext.new(
+  acr_values: null,
+  display: null,
+  id_token_hint_claims: null,
+  login_hint: null,
+  ui_locales: null
+)
 ```
 
-

data/docs/PluginConfig.md

@@ -2,46 +2,47 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**args** | [**PluginConfigArgs**](PluginConfigArgs.md) |  | 
-**description** | **String** | description | 
-**docker_version** | **String** | Docker Version used to create the plugin | [optional] 
-**documentation** | **String** | documentation | 
-**entrypoint** | **Array<String>** | entrypoint | 
-**env** | [**Array<PluginEnv>**](PluginEnv.md) | env | 
-**interface** | [**PluginConfigInterface**](PluginConfigInterface.md) |  | 
-**ipc_host** | **Boolean** | ipc host | 
-**linux** | [**PluginConfigLinux**](PluginConfigLinux.md) |  | 
-**mounts** | [**Array<PluginMount>**](PluginMount.md) | mounts | 
-**network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) |  | 
-**pid_host** | **Boolean** | pid host | 
-**propagated_mount** | **String** | propagated mount | 
-**user** | [**PluginConfigUser**](PluginConfigUser.md) |  | [optional] 
-**work_dir** | **String** | work dir | 
-**rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **args** | [**PluginConfigArgs**](PluginConfigArgs.md) |  |  |
+| **description** | **String** | description |  |
+| **docker_version** | **String** | Docker Version used to create the plugin | [optional] |
+| **documentation** | **String** | documentation |  |
+| **entrypoint** | **Array<String>** | entrypoint |  |
+| **env** | [**Array<PluginEnv>**](PluginEnv.md) | env |  |
+| **interface** | [**PluginConfigInterface**](PluginConfigInterface.md) |  |  |
+| **ipc_host** | **Boolean** | ipc host |  |
+| **linux** | [**PluginConfigLinux**](PluginConfigLinux.md) |  |  |
+| **mounts** | [**Array<PluginMount>**](PluginMount.md) | mounts |  |
+| **network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) |  |  |
+| **pid_host** | **Boolean** | pid host |  |
+| **propagated_mount** | **String** | propagated mount |  |
+| **user** | [**PluginConfigUser**](PluginConfigUser.md) |  | [optional] |
+| **work_dir** | **String** | work dir |  |
+| **rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::PluginConfig.new(args: null,
-                                 description: null,
-                                 docker_version: null,
-                                 documentation: null,
-                                 entrypoint: null,
-                                 env: null,
-                                 interface: null,
-                                 ipc_host: null,
-                                 linux: null,
-                                 mounts: null,
-                                 network: null,
-                                 pid_host: null,
-                                 propagated_mount: null,
-                                 user: null,
-                                 work_dir: null,
-                                 rootfs: null)
+instance = OryHydraClient::PluginConfig.new(
+  args: null,
+  description: null,
+  docker_version: null,
+  documentation: null,
+  entrypoint: null,
+  env: null,
+  interface: null,
+  ipc_host: null,
+  linux: null,
+  mounts: null,
+  network: null,
+  pid_host: null,
+  propagated_mount: null,
+  user: null,
+  work_dir: null,
+  rootfs: null
+)
 ```
 
-

data/docs/PluginConfigArgs.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**description** | **String** | description | 
-**name** | **String** | name | 
-**settable** | **Array<String>** | settable | 
-**value** | **Array<String>** | value | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | description |  |
+| **name** | **String** | name |  |
+| **settable** | **Array<String>** | settable |  |
+| **value** | **Array<String>** | value |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-hydra-client'
 
-instance = OryHydraClient::PluginConfigArgs.new(description: null,
-                                 name: null,
-                                 settable: null,
-                                 value: null)
+instance = OryHydraClient::PluginConfigArgs.new(
+  description: null,
+  name: null,
+  settable: null,
+  value: null
+)
 ```
 
-