lib/oci/identity/identity_client.rb
# Creates a new group in your tenancy.
#
# You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy
# is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)
# reside within the tenancy itself, unlike cloud resources such as compute instances, which typically
# reside within compartments inside the tenancy. For information about OCIDs, see
# [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
#
# You must also specify a *name* for the group, which must be unique across all groups in your tenancy and
# cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more
# information about policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/Concepts/policies.htm).
#
# You must also specify a *description* for the group (although it can be an empty string). It does not
# have to be unique, and you can change it anytime with {#update_group update_group}.
#
# 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.
#
# After creating the group, you need to put users in it and write policies for it.
# See {#add_user_to_group add_user_to_group} and
# {#create_policy create_policy}.
#
# @param [OCI::Identity::Models::CreateGroupDetails] create_group_details Request object for creating a new 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::Group Group}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/identity/create_group.rb.html) to see an example of how to use create_group API.
Creates a new group in your tenancy.
You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy
is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)
reside within the tenancy itself, unlike cloud resources such as compute instances, which typically
reside within compartments inside the tenancy. For information about OCIDs, see
[Resource Identifiers].

You must also specify a *name* for the group, which must be unique across all groups in your tenancy and
cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more
information about policies, see [How Policies Work].

You must also specify a *description* for the group (although it can be an empty string). It does not
have to be unique, and you can change it anytime with {#update_group update_group}.

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.

After creating the group, you need to put users in it and write policies for it.
Creates a new group in your tenancy . You must specify your tenancy ' s OCID as the compartment ID in the request object ( remember that the tenancy is simply the root compartment ) . Notice that IAM resources ( users groups compartments and some policies ) reside within the tenancy itself unlike cloud resources such as compute instances which typically reside within compartments inside the tenancy . For information about OCIDs see [ Resource Identifiers ] . You must also specify a * name * for the group which must be unique across all groups in your tenancy and cannot be changed . You can use this name or the OCID when writing policies that apply to the group . For more information about policies see [ How Policies Work ] . You must also specify a * description * for the group ( although it can be an empty string ) . It does not have to be unique and you can change it anytime with { #update_group update_group } . 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 . After creating the group you need to put users in it and write policies for it .
def create_group(create_group_details, opts = {})
      logger.debug 'Calling operation IdentityClient#create_group.' if logger
      raise "Missing the required parameter 'create_group_details' when calling create_group." if create_group_details.nil?
      path = '/groups/'
      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(create_group_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityClient#create_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::Group'
        )
      end
    end
def create_group ( create_group_details , opts = { } ) logger . debug 'Calling operation IdentityClient#create_group.' if logger raise "Missing the required parameter 'create_group_details' when calling create_group." if create_group_details . nil? path = '/groups/' 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 ( create_group_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'IdentityClient#create_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::Group' ) end end
Creates a new group in your tenancy.
Creates a new group in your tenancy .
# 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::Group Group}
A Response object with data of type { OCI :: Identity :: Models :: Group Group }
Response
create_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 create_group API.
Click [ here ] to see an example of how to use create_group API .