lib/oci/identity/identity_client.rb
# Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID.
#
# After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
# object, first make sure its `lifecycleState` has changed to ACTIVE.
#
# @param [OCI::Identity::Models::AddUserToGroupDetails] add_user_to_group_details Request object for adding a user to a group.
# @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::UserGroupMembership UserGroupMembership}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/identity/add_user_to_group.rb.html) to see an example of how to use add_user_to_group API.
Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID.
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
object, first make sure its `lifecycleState` has changed to ACTIVE.
Adds the specified user to the specified group and returns a ` UserGroupMembership ` object with its own OCID . After you send your request the new object ' s ` lifecycleState ` will temporarily be CREATING . Before using the object first make sure its ` lifecycleState ` has changed to ACTIVE .
def add_user_to_group(add_user_to_group_details, opts = {})
      logger.debug 'Calling operation IdentityClient#add_user_to_group.' if logger
      raise "Missing the required parameter 'add_user_to_group_details' when calling add_user_to_group." if add_user_to_group_details.nil?
      path = '/userGroupMemberships/'
      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 = @api_client.object_to_http_body(add_user_to_group_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityClient#add_user_to_group') 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::UserGroupMembership'
        )
      end
    end
def add_user_to_group ( add_user_to_group_details , opts = { } ) logger . debug 'Calling operation IdentityClient#add_user_to_group.' if logger raise "Missing the required parameter 'add_user_to_group_details' when calling add_user_to_group." if add_user_to_group_details . nil? path = '/userGroupMemberships/' 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 = @api_client . object_to_http_body ( add_user_to_group_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'IdentityClient#add_user_to_group' ) 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::UserGroupMembership' ) end end
Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID.
Adds the specified user to the specified group and returns a ` UserGroupMembership ` object with its own OCID .
# 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::UserGroupMembership UserGroupMembership}
A Response object with data of type { OCI :: Identity :: Models :: UserGroupMembership UserGroupMembership }
Response
add_user_to_group_details
<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
note
Click [here] to see an example of how to use add_user_to_group API.
Click [ here ] to see an example of how to use add_user_to_group API .