group

For examples of group workflows, see Group Workflows.

For more information on groups in the platform, see Identity & Access Management Guide.

The OLP CLI provides the following commands for managing groups:

• create a group
• list all available groups
• delete a group

group create

Creates a group.

olp group create <group name> [command options]

Required parameters:

• <group name> The name of the group.

Optional parameters:

• --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --json Displays the created group in JSON format.
• --quiet Displays the group ID.

For more information on using credentials and profiles, see Credentials setup.

Example:

olp group create test-group

Output:

Group GROUP-dc403eaa-791d-4e60-8293-8ed340674df1 has been created

group list

Retrieves all available groups.

olp group list [filter] [command options]

Optional parameters:

• [filter] Freeform text used to filter the group list. The filter checks if the name field contains the filter string.
• --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --json Displays the command result in JSON format.
• --quiet Displays group IDs, each on a new line.

For more information on using credentials and profiles, see Credentials setup.

Example:

olp group list

Output:

ID                                              name
GROUP-dc403eaa-791d-4e60-8293-8ed340674df1      first-group
GROUP-ju115jwh-383g-3f74-3471-2na580191rq5      second-group

group delete

Deletes a specified group.

olp group delete <group ID> [command options]

Warning

This command removes the group completely, and there is no way to restore it.

Required parameters:

• <group ID> The ID of the group to delete.

Optional parameters:

• --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --quiet Displays empty output with no additional information.

For more information on using credentials and profiles, see Credentials setup.

Example:

olp group delete GROUP-dc403eaa-791d-4e60-8293-8ed340674df1

Output:

Group GROUP-dc403eaa-791d-4e60-8293-8ed340674df1 has been deleted