create
******


Description
===========

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 UpdateGroup.

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 AddUserToGroup and CreatePolicy.


Usage
=====

   oci iam group create [OPTIONS]


Options
=======


--compartment-id, -c [text]
---------------------------

The OCID of the tenancy containing the group. If not provided, this
parameter will use the tenancy from the config file.


--name [text]
-------------

The name you assign to the group during creation. The name must be
unique across all groups in the tenancy and cannot be changed.
[required]


--description [text]
--------------------

The description you assign to the group during creation. Does not have
to be unique, and it's changeable. [required]


--freeform-tags [complex type]
------------------------------

Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace. For more information, see
Resource Tags. Example: *{"Department": "Finance"}* This is a complex
type whose value must be valid JSON. The value can be provided as a
string on the command line or passed in as a file using the
file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


--defined-tags [complex type]
-----------------------------

Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags. Example:
*{"Operations": {"CostCenter": "42"}}* This is a complex type whose
value must be valid JSON. The value can be provided as a string on the
command line or passed in as a file using the file://path/to/file
syntax.

The --generate-param-json-input option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


--wait-for-state [CREATING|ACTIVE|INACTIVE|DELETING|DELETED]
------------------------------------------------------------

This operation creates, modifies or deletes a resource that has a
defined lifecycle state. Specify this option to perform the action and
then wait until the resource reaches a given lifecycle state. If
timeout is reached, a return code of 2 is returned. For any other
error, a return code of 1 is returned.


--max-wait-seconds [integer]
----------------------------

The maximum time to wait for the resource to reach the lifecycle state
defined by --wait-for-state. Defaults to 1200 seconds.


--wait-interval-seconds [integer]
---------------------------------

Check every --wait-interval-seconds to see whether the resource to see
if it has reached the lifecycle state defined by --wait-for-state.
Defaults to 30 seconds.


--from-json [text]
------------------

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate
a sample json file to be used with this command option. The key names
are pre-populated and match the command option names (converted to
camelCase format, e.g. compartment-id --> compartmentId), while the
values of the keys need to be populated by the user before using the
sample file as an input to this command. For any command option that
accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our "using CLI with
advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions


-?, -h, --help
--------------

For detailed help on any of these individual commands, enter <command>
--help.
