ory-client 0.2.0.alpha60 → 1.0.0.alpha0

data/lib/ory-client/models/o_auth2_client.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v0.2.0-alpha.60
+The version of the OpenAPI document: v1.0.0-alpha.0
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1
@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module OryClient
+  # 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.
   class OAuth2Client
     attr_accessor :allowed_cors_origins
 
@@ -25,38 +26,38 @@ module OryClient
 
     attr_accessor :authorization_code_grant_refresh_token_lifespan
 
-    # 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.
+    # 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.
     attr_accessor :backchannel_logout_session_required
 
-    # RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.
+    # 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.
     attr_accessor :backchannel_logout_uri
 
     attr_accessor :client_credentials_grant_access_token_lifespan
 
-    # ID is the id for this client.  The ID is autogenerated and immutable.
+    # OAuth 2.0 Client ID  The ID is autogenerated and immutable.
     attr_accessor :client_id
 
-    # Name is the human-readable string name of the client to be presented to the end-user during authorization.
+    # OAuth 2.0 Client Name  The human-readable name of the client to be presented to the end-user during authorization.
     attr_accessor :client_name
 
-    # 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.
+    # 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.
     attr_accessor :client_secret
 
-    # 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.
+    # OAuth 2.0 Client Secret Expires At  The field is currently not supported and its value is always 0.
     attr_accessor :client_secret_expires_at
 
-    # 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.
+    # 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.
     attr_accessor :client_uri
 
     attr_accessor :contacts
 
-    # CreatedAt returns the timestamp of the client's creation.
+    # OAuth 2.0 Client Creation Date  CreatedAt returns the timestamp of the client's creation.
     attr_accessor :created_at
 
-    # 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.
+    # 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.
     attr_accessor :frontchannel_logout_session_required
 
-    # 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.
+    # 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.
     attr_accessor :frontchannel_logout_uri
 
     attr_accessor :grant_types
@@ -65,26 +66,23 @@ module OryClient
 
     attr_accessor :implicit_grant_id_token_lifespan
 
+    # 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.
     attr_accessor :jwks
 
-    # 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.
+    # 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.
     attr_accessor :jwks_uri
 
     attr_accessor :jwt_bearer_grant_access_token_lifespan
 
-    # LogoURI is an URL string that references a logo for the client.
+    # OAuth 2.0 Client Logo URI  A URL string referencing the client's logo.
     attr_accessor :logo_uri
 
     attr_accessor :metadata
 
-    # Owner is a string identifying the owner of the OAuth 2.0 Client.
+    # OAuth 2.0 Client Owner  Owner is a string identifying the owner of the OAuth 2.0 Client.
     attr_accessor :owner
 
-    attr_accessor :password_grant_access_token_lifespan
-
-    attr_accessor :password_grant_refresh_token_lifespan
-
-    # 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.
+    # 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.
     attr_accessor :policy_uri
 
     attr_accessor :post_logout_redirect_uris
@@ -97,41 +95,41 @@ module OryClient
 
     attr_accessor :refresh_token_grant_refresh_token_lifespan
 
-    # RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client.
+    # 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.
     attr_accessor :registration_access_token
 
-    # RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.
+    # OpenID Connect Dynamic Client Registration URL  RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.
     attr_accessor :registration_client_uri
 
-    # 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.
+    # 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.
     attr_accessor :request_object_signing_alg
 
     attr_accessor :request_uris
 
     attr_accessor :response_types
 
-    # 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.
+    # 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.
     attr_accessor :scope
 
-    # 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.
+    # 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.
     attr_accessor :sector_identifier_uri
 
-    # 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`.
+    # 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`.
     attr_accessor :subject_type
 
-    # Requested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none.
+    # 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.
     attr_accessor :token_endpoint_auth_method
 
-    # Requested Client Authentication signing algorithm for the Token Endpoint.
+    # OAuth 2.0 Token Endpoint Signing Algorithm  Requested Client Authentication signing algorithm for the Token Endpoint.
     attr_accessor :token_endpoint_auth_signing_alg
 
-    # 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.
+    # 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.
     attr_accessor :tos_uri
 
-    # UpdatedAt returns the timestamp of the last update.
+    # OAuth 2.0 Client Last Update Date  UpdatedAt returns the timestamp of the last update.
     attr_accessor :updated_at
 
-    # 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.
+    # 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.
     attr_accessor :userinfo_signed_response_alg
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -163,8 +161,6 @@ module OryClient
         :'logo_uri' => :'logo_uri',
         :'metadata' => :'metadata',
         :'owner' => :'owner',
-        :'password_grant_access_token_lifespan' => :'password_grant_access_token_lifespan',
-        :'password_grant_refresh_token_lifespan' => :'password_grant_refresh_token_lifespan',
         :'policy_uri' => :'policy_uri',
         :'post_logout_redirect_uris' => :'post_logout_redirect_uris',
         :'redirect_uris' => :'redirect_uris',
@@ -221,8 +217,6 @@ module OryClient
         :'logo_uri' => :'String',
         :'metadata' => :'Object',
         :'owner' => :'String',
-        :'password_grant_access_token_lifespan' => :'String',
-        :'password_grant_refresh_token_lifespan' => :'String',
         :'policy_uri' => :'String',
         :'post_logout_redirect_uris' => :'Array<String>',
         :'redirect_uris' => :'Array<String>',
@@ -254,9 +248,8 @@ module OryClient
         :'client_credentials_grant_access_token_lifespan',
         :'implicit_grant_access_token_lifespan',
         :'implicit_grant_id_token_lifespan',
+        :'jwks',
         :'jwt_bearer_grant_access_token_lifespan',
-        :'password_grant_access_token_lifespan',
-        :'password_grant_refresh_token_lifespan',
         :'refresh_token_grant_access_token_lifespan',
         :'refresh_token_grant_id_token_lifespan',
         :'refresh_token_grant_refresh_token_lifespan',
@@ -390,14 +383,6 @@ module OryClient
         self.owner = attributes[:'owner']
       end
 
-      if attributes.key?(:'password_grant_access_token_lifespan')
-        self.password_grant_access_token_lifespan = attributes[:'password_grant_access_token_lifespan']
-      end
-
-      if attributes.key?(:'password_grant_refresh_token_lifespan')
-        self.password_grant_refresh_token_lifespan = attributes[:'password_grant_refresh_token_lifespan']
-      end
-
       if attributes.key?(:'policy_uri')
         self.policy_uri = attributes[:'policy_uri']
       end
@@ -522,16 +507,6 @@ module OryClient
         invalid_properties.push("invalid value for \"jwt_bearer_grant_access_token_lifespan\", must conform to the pattern #{pattern}.")
       end
 
-      pattern = Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
-      if !@password_grant_access_token_lifespan.nil? && @password_grant_access_token_lifespan !~ pattern
-        invalid_properties.push("invalid value for \"password_grant_access_token_lifespan\", must conform to the pattern #{pattern}.")
-      end
-
-      pattern = Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
-      if !@password_grant_refresh_token_lifespan.nil? && @password_grant_refresh_token_lifespan !~ pattern
-        invalid_properties.push("invalid value for \"password_grant_refresh_token_lifespan\", must conform to the pattern #{pattern}.")
-      end
-
       pattern = Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
       if !@refresh_token_grant_access_token_lifespan.nil? && @refresh_token_grant_access_token_lifespan !~ pattern
         invalid_properties.push("invalid value for \"refresh_token_grant_access_token_lifespan\", must conform to the pattern #{pattern}.")
@@ -560,8 +535,6 @@ module OryClient
       return false if !@implicit_grant_access_token_lifespan.nil? && @implicit_grant_access_token_lifespan !~ Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
       return false if !@implicit_grant_id_token_lifespan.nil? && @implicit_grant_id_token_lifespan !~ Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
       return false if !@jwt_bearer_grant_access_token_lifespan.nil? && @jwt_bearer_grant_access_token_lifespan !~ Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
-      return false if !@password_grant_access_token_lifespan.nil? && @password_grant_access_token_lifespan !~ Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
-      return false if !@password_grant_refresh_token_lifespan.nil? && @password_grant_refresh_token_lifespan !~ Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
       return false if !@refresh_token_grant_access_token_lifespan.nil? && @refresh_token_grant_access_token_lifespan !~ Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
       return false if !@refresh_token_grant_id_token_lifespan.nil? && @refresh_token_grant_id_token_lifespan !~ Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
       return false if !@refresh_token_grant_refresh_token_lifespan.nil? && @refresh_token_grant_refresh_token_lifespan !~ Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
@@ -645,28 +618,6 @@ module OryClient
       @jwt_bearer_grant_access_token_lifespan = jwt_bearer_grant_access_token_lifespan
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] password_grant_access_token_lifespan Value to be assigned
-    def password_grant_access_token_lifespan=(password_grant_access_token_lifespan)
-      pattern = Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
-      if !password_grant_access_token_lifespan.nil? && password_grant_access_token_lifespan !~ pattern
-        fail ArgumentError, "invalid value for \"password_grant_access_token_lifespan\", must conform to the pattern #{pattern}."
-      end
-
-      @password_grant_access_token_lifespan = password_grant_access_token_lifespan
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] password_grant_refresh_token_lifespan Value to be assigned
-    def password_grant_refresh_token_lifespan=(password_grant_refresh_token_lifespan)
-      pattern = Regexp.new(/^[0-9]+(ns|us|ms|s|m|h)$/)
-      if !password_grant_refresh_token_lifespan.nil? && password_grant_refresh_token_lifespan !~ pattern
-        fail ArgumentError, "invalid value for \"password_grant_refresh_token_lifespan\", must conform to the pattern #{pattern}."
-      end
-
-      @password_grant_refresh_token_lifespan = password_grant_refresh_token_lifespan
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] refresh_token_grant_access_token_lifespan Value to be assigned
     def refresh_token_grant_access_token_lifespan=(refresh_token_grant_access_token_lifespan)
@@ -731,8 +682,6 @@ module OryClient
           logo_uri == o.logo_uri &&
           metadata == o.metadata &&
           owner == o.owner &&
-          password_grant_access_token_lifespan == o.password_grant_access_token_lifespan &&
-          password_grant_refresh_token_lifespan == o.password_grant_refresh_token_lifespan &&
           policy_uri == o.policy_uri &&
           post_logout_redirect_uris == o.post_logout_redirect_uris &&
           redirect_uris == o.redirect_uris &&
@@ -763,7 +712,7 @@ module OryClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allowed_cors_origins, audience, authorization_code_grant_access_token_lifespan, authorization_code_grant_id_token_lifespan, authorization_code_grant_refresh_token_lifespan, backchannel_logout_session_required, backchannel_logout_uri, client_credentials_grant_access_token_lifespan, client_id, client_name, client_secret, client_secret_expires_at, client_uri, contacts, created_at, frontchannel_logout_session_required, frontchannel_logout_uri, grant_types, implicit_grant_access_token_lifespan, implicit_grant_id_token_lifespan, jwks, jwks_uri, jwt_bearer_grant_access_token_lifespan, logo_uri, metadata, owner, password_grant_access_token_lifespan, password_grant_refresh_token_lifespan, policy_uri, post_logout_redirect_uris, redirect_uris, refresh_token_grant_access_token_lifespan, refresh_token_grant_id_token_lifespan, refresh_token_grant_refresh_token_lifespan, registration_access_token, registration_client_uri, request_object_signing_alg, request_uris, response_types, scope, sector_identifier_uri, subject_type, token_endpoint_auth_method, token_endpoint_auth_signing_alg, tos_uri, updated_at, userinfo_signed_response_alg].hash
+      [allowed_cors_origins, audience, authorization_code_grant_access_token_lifespan, authorization_code_grant_id_token_lifespan, authorization_code_grant_refresh_token_lifespan, backchannel_logout_session_required, backchannel_logout_uri, client_credentials_grant_access_token_lifespan, client_id, client_name, client_secret, client_secret_expires_at, client_uri, contacts, created_at, frontchannel_logout_session_required, frontchannel_logout_uri, grant_types, implicit_grant_access_token_lifespan, implicit_grant_id_token_lifespan, jwks, jwks_uri, jwt_bearer_grant_access_token_lifespan, logo_uri, metadata, owner, policy_uri, post_logout_redirect_uris, redirect_uris, refresh_token_grant_access_token_lifespan, refresh_token_grant_id_token_lifespan, refresh_token_grant_refresh_token_lifespan, registration_access_token, registration_client_uri, request_object_signing_alg, request_uris, response_types, scope, sector_identifier_uri, subject_type, token_endpoint_auth_method, token_endpoint_auth_signing_alg, tos_uri, updated_at, userinfo_signed_response_alg].hash
     end
 
     # Builds the object from hash