group admin

The OLP CLI supports the following:

• add an administrator to a group
• list administrators of a group
• remove an administrator from a group

group admin add

Adds administrators to a group.

olp group admin add <group ID> [command options]

Required parameters:

• <group ID> The ID of the group.
• Either of the following group members:
  • --app <appID1 appID2 ...> The list of application IDs you want to add to the group as administrators, separated by space.
  • --user <userID1 userID2 ...> The list of user IDs you want to add to the group as administrators, separated by space.

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 admin add GROUP-859ddd60-78f2-4ad2-865d-7351b01ff008 \
   --user HERE-05966c89-aaf1-4ae2-b0e4-3676b3f8b8c3

olp group admin add GROUP-859ddd60-78f2-4ad2-865d-7351b01ff008 ^
   --user HERE-05966c89-aaf1-4ae2-b0e4-3676b3f8b8c3

Output:

User HERE-05966c89-aaf1-4ae2-b0e4-3676b3f8b8c3 has been added to the group GROUP-859ddd60-78f2-4ad2-865d-7351b01ff008 as administrator

group admin list

Retrieves all administrators of a group.

olp group admin list <group ID> [command options]

Required parameters:

• <group ID> The ID of the group.

Optional parameters:

• --type <user|app> The type of group administrators to list. If the parameter is omitted, all group administrators are displayed.
• --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 administrators' HRNs, each on a new line.

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

Example:

olp group admin list

Output:

type           HRN                                                         ID                     name
app            hrn:here:account::olp-here-test:app/app-example             app-example            some-test-app
user           hrn:here:account::olp-here-test:user/user-example           user-example           some-test-user

group admin remove

Removes an administrator from a group.

olp group admin remove <group ID> [command options]

Required parameters:

• <group ID> The ID of the group.
• Either of the following group members:
  • --app <appID1 appID2 ...> The list of application IDs you want to remove from a group of administrators, separated by space.
  • --user <userID1 userID2 ...> The list of user IDs you want to remove from a group administrators, separated by space.

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.
• --membership Remove a membership from a group. By default, membership is preserved.
• --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 admin remove GROUP-859ddd60-78f2-4ad2-865d-7351b01ff008 \
   --user HERE-05966c89-aaf1-4ae2-b0e4-3676b3f8b8c3

olp group admin remove GROUP-859ddd60-78f2-4ad2-865d-7351b01ff008 ^
   --user HERE-05966c89-aaf1-4ae2-b0e4-3676b3f8b8c3

Output:

User HERE-05966c89-aaf1-4ae2-b0e4-3676b3f8b8c3 has been removed from the group administrators for the group GROUP-859ddd60-78f2-4ad2-865d-7351b01ff008