lib/oci/identity/identity_client.rb
# Creates a new Console one-time password for the specified user. For more information about user
# credentials, see [User Credentials](https://docs.cloud.oracle.com/Content/Identity/Concepts/usercredentials.htm).
#
# Use this operation after creating a new user, or if a user forgets their password. The new one-time
# password is returned to you in the response, and you must securely deliver it to the user. They'll
# be prompted to change this password the next time they sign in to the Console. If they don't change
# it within 7 days, the password will expire and you'll need to create a new one-time password for the
# user.
#
# **Note:** The user's Console login is the unique name you specified when you created the user
# (see {#create_user create_user}).
#
# @param [String] user_id The OCID of the user.
# @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_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
#   server error without risk of executing that same action again. Retry tokens expire after 24
#   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
#   has been deleted and purged from the system, then a retry of the original creation request
#   may be rejected).
#
# @return [Response] A Response object with data of type {OCI::Identity::Models::UIPassword UIPassword}
Creates a new Console one-time password for the specified user. For more information about user
credentials, see [User Credentials].

Use this operation after creating a new user, or if a user forgets their password. The new one-time
password is returned to you in the response, and you must securely deliver it to the user. They'll
be prompted to change this password the next time they sign in to the Console. If they don't change
it within 7 days, the password will expire and you'll need to create a new one-time password for the
user.

The user's Console login is the unique name you specified when you created the user
.
Creates a new Console one - time password for the specified user . For more information about user credentials see [ User Credentials ] . Use this operation after creating a new user or if a user forgets their password . The new one - time password is returned to you in the response and you must securely deliver it to the user . They ' ll be prompted to change this password the next time they sign in to the Console . If they don ' t change it within 7 days the password will expire and you ' ll need to create a new one - time password for the user . The user ' s Console login is the unique name you specified when you created the user .
def create_or_reset_ui_password(user_id, opts = {})
      logger.debug 'Calling operation IdentityClient#create_or_reset_ui_password.' if logger
      raise "Missing the required parameter 'user_id' when calling create_or_reset_ui_password." if user_id.nil?
      raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id)
      path = '/users/{userId}/uiPassword'.sub('{userId}', user_id.to_s)
      operation_signing_strategy = :standard
      query_params = {}
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityClient#create_or_reset_ui_password') do
        @api_client.call_api(
          :POST,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'OCI::Identity::Models::UIPassword'
        )
      end
    end
def create_or_reset_ui_password ( user_id , opts = { } ) logger . debug 'Calling operation IdentityClient#create_or_reset_ui_password.' if logger raise "Missing the required parameter 'user_id' when calling create_or_reset_ui_password." if user_id . nil? raise "Parameter value for 'user_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( user_id ) path = '/users/{userId}/uiPassword' . sub ( '{userId}' , user_id . to_s ) operation_signing_strategy = :standard query_params = { } header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' header_params [ :' opc-retry-token ' ] = opts [ :opc_retry_token ] if opts [ :opc_retry_token ] header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'IdentityClient#create_or_reset_ui_password' ) do @api_client . call_api ( :POST , path , endpoint , header_params : header_params , query_params : query_params , operation_signing_strategy : operation_signing_strategy , body : post_body , return_type : 'OCI::Identity::Models::UIPassword' ) end end
Creates a new Console one-time password for the specified user.
Creates a new Console one - time password for the specified user .
# 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::Identity::Models::UIPassword UIPassword}
A Response object with data of type { OCI :: Identity :: Models :: UIPassword UIPassword }
Response
user_id
<not_specific>
opts
:opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations .
: opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again . Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations .
<not_specific>
opts the optional parameters
opts the optional parameters