list-groups¶

Description¶

Lists groups. If no group names are specified, the call lists all groups.

list-groups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-groups
[--group-names <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--group-names (array)

The group names or CRNs of the groups. If not provided, all groups in the account are retrieved.

Syntax:

"string" "string" ...

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 100 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

--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¶

groups -> (array)

The list of groups.

item -> (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.

nextToken -> (string)

The token to use when requesting the next set of results. If not present, there are no additional results.

Form Factors¶

public, private