lib/oci/cims/incident_client.rb
# Checks whether the requested user is valid.
# @param [String] csi The Customer Support Identifier number for the support account.
# @param [String] ocid User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
# @param [Hash] opts the optional parameters
# @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
#   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
# @option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
# @option opts [String] :problem_type The kind of support request.
# @option opts [String] :homeregion The region of the tenancy.
# @return [Response] A Response object with data of type {OCI::Cims::Models::ValidationResponse ValidationResponse}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/cims/validate_user.rb.html) to see an example of how to use validate_user API.
Checks whether the requested user is valid.
Checks whether the requested user is valid .
def validate_user(csi, ocid, opts = {})
      logger.debug 'Calling operation IncidentClient#validate_user.' if logger
      raise "Missing the required parameter 'csi' when calling validate_user." if csi.nil?
      raise "Missing the required parameter 'ocid' when calling validate_user." if ocid.nil?
      path = '/v2/incidents/user/validate'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:problemType] = opts[:problem_type] if opts[:problem_type]
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      header_params[:csi] = csi
      header_params[:ocid] = ocid
      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
      header_params[:homeregion] = opts[:homeregion] if opts[:homeregion]
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IncidentClient#validate_user') do
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'OCI::Cims::Models::ValidationResponse'
        )
      end
    end
def validate_user ( csi , ocid , opts = { } ) logger . debug 'Calling operation IncidentClient#validate_user.' if logger raise "Missing the required parameter 'csi' when calling validate_user." if csi . nil? raise "Missing the required parameter 'ocid' when calling validate_user." if ocid . nil? path = '/v2/incidents/user/validate' operation_signing_strategy = :standard query_params = { } query_params [ :problemType ] = opts [ :problem_type ] if opts [ :problem_type ] header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' header_params [ :csi ] = csi header_params [ :ocid ] = ocid header_params [ :' opc-request-id ' ] = opts [ :opc_request_id ] if opts [ :opc_request_id ] header_params [ :homeregion ] = opts [ :homeregion ] if opts [ :homeregion ] post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'IncidentClient#validate_user' ) do @api_client . call_api ( :GET , path , endpoint , header_params : header_params , query_params : query_params , operation_signing_strategy : operation_signing_strategy , body : post_body , return_type : 'OCI::Cims::Models::ValidationResponse' ) end end
Checks whether the requested user is valid.
Checks whether the requested user is valid .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type {OCI::Cims::Models::ValidationResponse ValidationResponse}
A Response object with data of type { OCI :: Cims :: Models :: ValidationResponse ValidationResponse }
Response
csi
ocid
opts
:homeregion The region of the tenancy.
: homeregion The region of the tenancy .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use validate_user API.
Click [ here ] to see an example of how to use validate_user API .