auth0 6.0.0.beta.0 → 6.0.0.beta.1

data/lib/auth0/client_grants/types/create_client_grant_request_content.rb

@@ -5,13 +5,21 @@ module Auth0
     module Types
       class CreateClientGrantRequestContent < Internal::Types::Model
         field :client_id, -> { String }, optional: true, nullable: false
+
         field :audience, -> { String }, optional: false, nullable: false
+
         field :default_for, -> { Auth0::Types::ClientGrantDefaultForEnum }, optional: true, nullable: false
+
         field :organization_usage, -> { Auth0::Types::ClientGrantOrganizationUsageEnum }, optional: true, nullable: false
+
         field :allow_any_organization, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
         field :scope, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
         field :subject_type, -> { Auth0::Types::ClientGrantSubjectTypeEnum }, optional: true, nullable: false
+
         field :authorization_details_types, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
         field :allow_all_scopes, -> { Internal::Types::Boolean }, optional: true, nullable: false
       end
     end

data/lib/auth0/client_grants/types/list_client_grants_request_parameters.rb

@@ -5,11 +5,17 @@ module Auth0
     module Types
       class ListClientGrantsRequestParameters < Internal::Types::Model
         field :from, -> { String }, optional: true, nullable: false
+
         field :take, -> { Integer }, optional: true, nullable: false
+
         field :audience, -> { String }, optional: true, nullable: false
+
         field :client_id, -> { String }, optional: true, nullable: false
+
         field :allow_any_organization, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
         field :subject_type, -> { Auth0::Types::ClientGrantSubjectTypeEnum }, optional: true, nullable: false
+
         field :default_for, -> { Auth0::Types::ClientGrantDefaultForEnum }, optional: true, nullable: false
       end
     end

data/lib/auth0/client_grants/types/update_client_grant_request_content.rb

@@ -5,10 +5,15 @@ module Auth0
     module Types
       class UpdateClientGrantRequestContent < Internal::Types::Model
         field :id, -> { String }, optional: false, nullable: false
+
         field :scope, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
         field :organization_usage, -> { Auth0::Types::ClientGrantOrganizationNullableUsageEnum }, optional: true, nullable: false
+
         field :allow_any_organization, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
         field :authorization_details_types, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
         field :allow_all_scopes, -> { Internal::Types::Boolean }, optional: true, nullable: false
       end
     end

data/lib/auth0/clients/client.rb

@@ -12,41 +12,31 @@ module Auth0
 
       # Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or
       # exclude may also be specified.
-      # For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in
-      # Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
+      # For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and
+      # [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
       #
-      # <ul>
-      #   <li>
-      #     The following can be retrieved with any scope:
-      #     <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code>.
-      #   </li>
-      #   <li>
-      #     The following properties can only be retrieved with the <code>read:clients</code> or
-      #     <code>read:client_keys</code> scope:
-      #     <code>callbacks</code>, <code>oidc_logout</code>, <code>allowed_origins</code>,
-      #     <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
-      #     <code>callback_url_template</code>, <code>jwt_configuration</code>,
-      #     <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
-      #     <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
-      #     <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
-      #     <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
-      #     <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
-      #     <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
-      #     <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
-      #     <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
-      # <code>refresh_token</code>, <code>refresh_token.rotation_type</code>,
-      # <code>refresh_token.expiration_type</code>,
-      # <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>,
-      # <code>refresh_token.policies</code>, <code>organization_usage</code>,
-      #     <code>organization_require_behavior</code>.
-      #   </li>
-      #   <li>
-      #     The following properties can only be retrieved with the
-      #     <code>read:client_keys</code> or <code>read:client_credentials</code> scope:
-      #     <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
-      #     <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
-      #   </li>
-      # </ul>
+      # - The following can be retrieved with any scope:
+      #     `client_id`, `app_type`, `name`, and `description`.
+      # - The following properties can only be retrieved with the `read:clients` or
+      #     `read:client_keys` scope:
+      #     `callbacks`, `oidc_logout`, `allowed_origins`,
+      #     `web_origins`, `tenant`, `global`, `config_route`,
+      #     `callback_url_template`, `jwt_configuration`,
+      #     `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
+      #     `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
+      #     `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
+      #     `custom_login_page_off`, `sso`, `addons`, `form_template`,
+      #     `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
+      #     `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
+      #     `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
+      #     `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
+      #     `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
+      #     `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
+      #     `organization_require_behavior`.
+      # - The following properties can only be retrieved with the
+      #     `read:client_keys` or `read:client_credentials` scope:
+      #     `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
+      #     `client_secret`, `client_authentication_methods` and `signing_key`.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -69,7 +59,6 @@ module Auth0
       # @return [Auth0::Types::ListClientsOffsetPaginatedResponseContent]
       def list(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
-        query_param_names = %i[fields include_fields page per_page include_totals is_global is_first_party app_type external_client_id q]
         query_params = {}
         query_params["fields"] = params[:fields] if params.key?(:fields)
         query_params["include_fields"] = params[:include_fields] if params.key?(:include_fields)
@@ -81,13 +70,12 @@ module Auth0
         query_params["app_type"] = params[:app_type] if params.key?(:app_type)
         query_params["external_client_id"] = params[:external_client_id] if params.key?(:external_client_id)
         query_params["q"] = params[:q] if params.key?(:q)
-        params.except(*query_param_names)
 
         Auth0::Internal::OffsetItemIterator.new(
           initial_page: query_params["page"],
           item_field: :clients,
           has_next_field: nil,
-          step: true
+          step: false
         ) do |next_page|
           query_params["page"] = next_page
           request = Auth0::Internal::JSON::Request.new(
@@ -104,7 +92,8 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::ListClientsOffsetPaginatedResponseContent.load(response.body)
+            parsed_response = Auth0::Types::ListClientsOffsetPaginatedResponseContent.load(response.body)
+            [parsed_response, response]
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -112,28 +101,24 @@ module Auth0
         end
       end
 
-      # Create a new client (application or SSO integration). For more information, read <a
-      # href="https://www.auth0.com/docs/get-started/auth0-overview/create-applications">Create Applications</a>
-      # <a href="https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on>">API Endpoints
-      # for Single Sign-On</a>.
+      # Create a new client (application or SSO integration). For more information, read [Create
+      # Applications](https://www.auth0.com/docs/get-started/auth0-overview/create-applications)
+      # [API Endpoints for Single
+      # Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on).
       #
       # Notes:
       # - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
-      # - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are
-      # mutually exclusive. Use
-      # <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method.
-      # Otherwise, use <code>token_endpoint_auth_method</code>
+      # - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use
+      # `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise,
+      # use `token_endpoint_auth_method`
       # to configure the client with client secret (basic or post) or with no authentication method (none).
-      # - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT
-      # authentication method, specify fully defined credentials.
+      # - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method,
+      # specify fully defined credentials.
       # These credentials will be automatically enabled for Private Key JWT authentication on the client.
-      # - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is
-      # required.
-      # - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must
-      # be set to RS256.
+      # - To configure `client_authentication_methods`, the `create:client_credentials` scope is required.
+      # - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
       #
-      # <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share
-      # user profile information.</div>
+      # SSO Integrations created via this endpoint will accept login requests and share user profile information.
       #
       # @param request_options [Hash]
       # @param params [Auth0::Clients::Types::CreateClientRequestContent]
@@ -205,10 +190,20 @@ module Auth0
         end
       end
 
+      # Idempotent registration for Client ID Metadata Document (CIMD) clients.
+      # Uses external_client_id as the unique identifier for upsert operations.
       #
-      #       Idempotent registration for Client ID Metadata Document (CIMD) clients.
-      #       Uses external_client_id as the unique identifier for upsert operations.
-      #       **Create:** Returns 201 when a new client is created (requires \
+      # <strong>Create:</strong> Returns 201 when a new client is created (requires <code>create:clients</code> scope).
+      # <strong>Update:</strong> Returns 200 when an existing client is updated (requires <code>update:clients</code>
+      # scope).
+      #
+      # This endpoint automatically:
+      # <ul>
+      #   <li>Fetches and validates the metadata document</li>
+      #   <li>Maps CIMD fields to Auth0 client configuration</li>
+      #   <li>Creates/rotates credentials from the JWKS</li>
+      #   <li>Enforces CIMD security policies (HTTPS-only, no shared secrets)</li>
+      # </ul>
       #
       # @param request_options [Hash]
       # @param params [Auth0::Clients::Types::RegisterCimdClientRequestContent]
@@ -244,40 +239,31 @@ module Auth0
 
       # Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list
       # of fields to include or exclude may also be specified.
-      # For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in
-      # Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
-      # <ul>
-      #   <li>
-      #     The following properties can be retrieved with any of the scopes:
-      #     <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code>.
-      #   </li>
-      #   <li>
-      #     The following properties can only be retrieved with the <code>read:clients</code> or
-      #     <code>read:client_keys</code> scopes:
-      #     <code>callbacks</code>, <code>oidc_logout</code>, <code>allowed_origins</code>,
-      #     <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
-      #     <code>callback_url_template</code>, <code>jwt_configuration</code>,
-      #     <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
-      #     <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
-      #     <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
-      #     <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
-      #     <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
-      #     <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
-      #     <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
-      #     <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
-      # <code>refresh_token</code>, <code>refresh_token.rotation_type</code>,
-      # <code>refresh_token.expiration_type</code>,
-      # <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>,
-      # <code>refresh_token.policies</code>, <code>organization_usage</code>,
-      #     <code>organization_require_behavior</code>.
-      #   </li>
-      #   <li>
-      # The following properties can only be retrieved with the <code>read:client_keys</code> or
-      # <code>read:client_credentials</code> scopes:
-      #     <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
-      #     <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
-      #   </li>
-      # </ul>
+      # For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and
+      # [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
+      #
+      # - The following properties can be retrieved with any of the scopes:
+      #     `client_id`, `app_type`, `name`, and `description`.
+      # - The following properties can only be retrieved with the `read:clients` or
+      #     `read:client_keys` scopes:
+      #     `callbacks`, `oidc_logout`, `allowed_origins`,
+      #     `web_origins`, `tenant`, `global`, `config_route`,
+      #     `callback_url_template`, `jwt_configuration`,
+      #     `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
+      #     `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
+      #     `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
+      #     `custom_login_page_off`, `sso`, `addons`, `form_template`,
+      #     `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
+      #     `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
+      #     `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
+      #     `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
+      #     `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
+      #     `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
+      #     `organization_require_behavior`.
+      # - The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials`
+      # scopes:
+      #     `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
+      #     `client_secret`, `client_authentication_methods` and `signing_key`.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -293,11 +279,9 @@ module Auth0
       # @return [Auth0::Types::GetClientResponseContent]
       def get(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
-        query_param_names = %i[fields include_fields]
         query_params = {}
         query_params["fields"] = params[:fields] if params.key?(:fields)
         query_params["include_fields"] = params[:include_fields] if params.key?(:include_fields)
-        params = params.except(*query_param_names)
 
         request = Auth0::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
@@ -352,25 +336,22 @@ module Auth0
         raise error_class.new(response.body, code: code)
       end
 
-      # Updates a client's settings. For more information, read <a
-      # href="https://www.auth0.com/docs/get-started/applications"> Applications in Auth0</a> and <a
-      # href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
+      # Updates a client's settings. For more information, read [Applications in
+      # Auth0](https://www.auth0.com/docs/get-started/applications) and [Single
+      # Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
       #
       # Notes:
       # - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
-      # - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are
-      # mutually exclusive. Use <code>client_authentication_methods</code> to configure the client with Private Key JWT
-      # authentication method. Otherwise, use <code>token_endpoint_auth_method</code> to configure the client with
-      # client secret (basic or post) or with no authentication method (none).
-      # - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT
-      # authentication method, only specify the credential IDs that were generated when creating the credentials on the
-      # client.
-      # - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is
-      # required.
-      # - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must
-      # be set to RS256.
-      # - To change a client's <code>is_first_party</code> property to <code>false</code>, the
-      # <code>organization_usage</code> and <code>organization_require_behavior</code> properties must be unset.
+      # - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use
+      # `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise,
+      # use `token_endpoint_auth_method` to configure the client with client secret (basic or post) or with no
+      # authentication method (none).
+      # - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method,
+      # only specify the credential IDs that were generated when creating the credentials on the client.
+      # - To configure `client_authentication_methods`, the `update:client_credentials` scope is required.
+      # - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
+      # - To change a client's `is_first_party` property to `false`, the `organization_usage` and
+      # `organization_require_behavior` properties must be unset.
       #
       # @param request_options [Hash]
       # @param params [Auth0::Clients::Types::UpdateClientRequestContent]
@@ -385,7 +366,7 @@ module Auth0
       def update(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
         request_data = Auth0::Clients::Types::UpdateClientRequestContent.new(params).to_h
-        non_body_param_names = ["id"]
+        non_body_param_names = %w[id]
         body = request_data.except(*non_body_param_names)
 
         request = Auth0::Internal::JSON::Request.new(
@@ -414,8 +395,8 @@ module Auth0
       # This endpoint cannot be used with clients configured with Private Key JWT authentication method
       # (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.
       #
-      # For more information, read <a
-      # href="https://www.auth0.com/docs/get-started/applications/rotate-client-secret">Rotate Client Secrets</a>.
+      # For more information, read [Rotate Client
+      # Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/auth0/clients/connections/client.rb

@@ -11,20 +11,14 @@ module Auth0
           @client = client
         end
 
-        # Retrieve all connections that are enabled for the specified <a
-        # href="https://www.auth0.com/docs/get-started/applications"> Application</a>, using checkpoint pagination. A
-        # list of fields to include or exclude for each connection may also be specified.
-        # <ul>
-        #   <li>
-        # This endpoint requires the <code>read:connections</code> scope and any one of <code>read:clients</code> or
-        # <code>read:client_summary</code>.
-        #   </li>
-        #   <li>
-        # <b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more
-        # results, a <code>next</code> value is included in the response. You can use this for subsequent API calls.
-        # When <code>next</code> is no longer included in the response, no further results are remaining.
-        #   </li>
-        # </ul>
+        # Retrieve all connections that are enabled for the specified
+        # [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of
+        # fields to include or exclude for each connection may also be specified.
+        #
+        # - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
+        # - **Note**: The first time you call this endpoint, omit the `from` parameter. If there are more results, a
+        # `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer
+        # included in the response, no further results are remaining.
         #
         # @param request_options [Hash]
         # @param params [Hash]
@@ -43,14 +37,12 @@ module Auth0
         # @return [Auth0::Types::ListClientConnectionsResponseContent]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
-          query_param_names = %i[strategy from take fields include_fields]
           query_params = {}
           query_params["strategy"] = params[:strategy] if params.key?(:strategy)
           query_params["from"] = params[:from] if params.key?(:from)
           query_params["take"] = params.fetch(:take, 50)
           query_params["fields"] = params[:fields] if params.key?(:fields)
           query_params["include_fields"] = params[:include_fields] if params.key?(:include_fields)
-          params = params.except(*query_param_names)
 
           Auth0::Internal::CursorItemIterator.new(
             cursor_field: :next_,
@@ -72,7 +64,8 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::ListClientConnectionsResponseContent.load(response.body)
+              parsed_response = Auth0::Types::ListClientConnectionsResponseContent.load(response.body)
+              [parsed_response, response]
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)

data/lib/auth0/clients/connections/types/connections_get_request.rb

@@ -6,10 +6,15 @@ module Auth0
       module Types
         class ConnectionsGetRequest < Internal::Types::Model
           field :id, -> { String }, optional: false, nullable: false
+
           field :strategy, -> { Auth0::Types::ConnectionStrategyEnum }, optional: true, nullable: false
+
           field :from, -> { String }, optional: true, nullable: false
+
           field :take, -> { Integer }, optional: true, nullable: false
+
           field :fields, -> { String }, optional: true, nullable: false
+
           field :include_fields, -> { Internal::Types::Boolean }, optional: true, nullable: false
         end
       end

data/lib/auth0/clients/credentials/client.rb

@@ -13,9 +13,9 @@ module Auth0
 
         # Get the details of a client credential.
         #
-        # <b>Important</b>: To enable credentials to be used for a client authentication method, set the
-        # <code>client_authentication_methods</code> property on the client. To enable credentials to be used for
-        # JWT-Secured Authorization requests set the <code>signed_request_object</code> property on the client.
+        # **Important**: To enable credentials to be used for a client authentication method, set the
+        # `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured
+        # Authorization requests set the `signed_request_object` property on the client.
         #
         # @param request_options [Hash]
         # @param params [Hash]
@@ -50,48 +50,69 @@ module Auth0
         # Create a client credential associated to your application. Credentials can be used to configure Private Key
         # JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
         #
-        # <h5>Public Key</h5>Public Key credentials can be used to set up Private Key JWT client authentication and
-        # JWT-secured Authorization requests.
+        # **Public Key**
         #
-        # Sample: <pre><code>{
+        # Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured
+        # Authorization requests.
+        #
+        # Sample:
+        #
+        # ```json
+        # {
         #   "credential_type": "public_key",
         #   "name": "string",
         #   "pem": "string",
         #   "alg": "RS256",
         #   "parse_expiry_from_cert": false,
         #   "expires_at": "2022-12-31T23:59:59Z"
-        # }</code></pre>
-        # <h5>Certificate (CA-signed & self-signed)</h5>Certificate credentials can be used to set up mTLS client
-        # authentication. CA-signed certificates can be configured either with a signed certificate or with just the
-        # certificate Subject DN.
+        # }
+        # ```
+        #
+        # **Certificate (CA-signed & self-signed)**
+        #
+        # Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be
+        # configured either with a signed certificate or with just the certificate Subject DN.
+        #
+        # CA-signed Certificate Sample (pem):
         #
-        # CA-signed Certificate Sample (pem): <pre><code>{
+        # ```json
+        # {
         #   "credential_type": "x509_cert",
         #   "name": "string",
         #   "pem": "string"
-        # }</code></pre>CA-signed Certificate Sample (subject_dn): <pre><code>{
+        # }
+        # ```
+        #
+        # CA-signed Certificate Sample (subject_dn):
+        #
+        # ```json
+        # {
         #   "credential_type": "cert_subject_dn",
         #   "name": "string",
         #   "subject_dn": "string"
-        # }</code></pre>Self-signed Certificate Sample: <pre><code>{
+        # }
+        # ```
+        #
+        # Self-signed Certificate Sample:
+        #
+        # ```json
+        # {
         #   "credential_type": "cert_subject_dn",
         #   "name": "string",
         #   "pem": "string"
-        # }</code></pre>
+        # }
+        # ```
         #
         # The credential will be created but not yet enabled for use until you set the corresponding properties in the
         # client:
-        # <ul>
-        # <li>To enable the credential for Private Key JWT or mTLS authentication methods, set the
-        # <code>client_authentication_methods</code> property on the client. For more information, read <a
-        # href="https://auth0.com/docs/get-started/applications/configure-private-key-jwt">Configure Private Key JWT
-        # Authentication</a> and <a href="https://auth0.com/docs/get-started/applications/configure-mtls">Configure mTLS
-        # Authentication</a></li>
-        # <li>To enable the credential for JWT-secured Authorization requests, set the
-        # <code>signed_request_object</code>property on the client. For more information, read <a
-        # href="https://auth0.com/docs/get-started/applications/configure-jar">Configure JWT-secured Authorization
-        # Requests (JAR)</a></li>
-        # </ul>
+        #
+        # - To enable the credential for Private Key JWT or mTLS authentication methods, set the
+        # `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT
+        # Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS
+        # Authentication](https://auth0.com/docs/get-started/applications/configure-mtls)
+        # - To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on
+        # the client. For more information, read [Configure JWT-secured Authorization Requests
+        # (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
         #
         # @param request_options [Hash]
         # @param params [Auth0::Clients::Credentials::Types::PostClientCredentialRequestContent]
@@ -106,7 +127,7 @@ module Auth0
         def create(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
           request_data = Auth0::Clients::Credentials::Types::PostClientCredentialRequestContent.new(params).to_h
-          non_body_param_names = ["client_id"]
+          non_body_param_names = %w[client_id]
           body = request_data.except(*non_body_param_names)
 
           request = Auth0::Internal::JSON::Request.new(
@@ -132,9 +153,9 @@ module Auth0
 
         # Get the details of a client credential.
         #
-        # <b>Important</b>: To enable credentials to be used for a client authentication method, set the
-        # <code>client_authentication_methods</code> property on the client. To enable credentials to be used for
-        # JWT-Secured Authorization requests set the <code>signed_request_object</code> property on the client.
+        # **Important**: To enable credentials to be used for a client authentication method, set the
+        # `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured
+        # Authorization requests set the `signed_request_object` property on the client.
         #
         # @param request_options [Hash]
         # @param params [Hash]

data/lib/auth0/clients/credentials/types/patch_client_credential_request_content.rb

@@ -6,7 +6,9 @@ module Auth0
       module Types
         class PatchClientCredentialRequestContent < Internal::Types::Model
           field :client_id, -> { String }, optional: false, nullable: false
+
           field :credential_id, -> { String }, optional: false, nullable: false
+
           field :expires_at, -> { String }, optional: true, nullable: false
         end
       end

data/lib/auth0/clients/credentials/types/post_client_credential_request_content.rb

@@ -6,13 +6,21 @@ module Auth0
       module Types
         class PostClientCredentialRequestContent < Internal::Types::Model
           field :client_id, -> { String }, optional: false, nullable: false
+
           field :credential_type, -> { Auth0::Types::ClientCredentialTypeEnum }, optional: false, nullable: false
+
           field :name, -> { String }, optional: true, nullable: false
+
           field :subject_dn, -> { String }, optional: true, nullable: false
+
           field :pem, -> { String }, optional: true, nullable: false
+
           field :alg, -> { Auth0::Types::PublicKeyCredentialAlgorithmEnum }, optional: true, nullable: false
+
           field :parse_expiry_from_cert, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
           field :expires_at, -> { String }, optional: true, nullable: false
+
           field :kid, -> { String }, optional: true, nullable: false
         end
       end