create-group¶

Description¶

Create a group. A group is a named collection of users and machine users. Roles and resource roles can be assigned to a group impacting all members of the group.

Synopsis¶

  create-group
--group-name <value>
[--sync-membership-on-user-login | --no-sync-membership-on-user-login]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--group-name (string)

The name of the group. This name must be unique. There are certain restrictions on the group name. Refer to the How To > User Management section in the Management Console documentation for the details.

--sync-membership-on-user-login | --no-sync-membership-on-user-login (boolean)

Whether group membership is synced when a user logs in. The default is to sync group membership.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

group -> (object)

Information about a group.

groupName -> (string)

The group name.

crn -> (string)

The CRN of the group.

creationDate -> (datetime)

The date when this group record was created.

syncMembershipOnUserLogin -> (boolean)

Whether group membership is synced when a user logs in. The default is to sync group membership.

azureCloudIdentities -> (array)

The list of Azure cloud identities assigned to the group.

item -> (object)

An Azure cloud identity.

objectId -> (string)

The Azure object ID (OID).

environmentCrn -> (string)

The CRN of the environment this Azure cloud identity is associated with. If omitted, this cloud identity is associated with all Azure environments.

Form Factors¶

public, private