GuidesChangelogData Inspector Library API Reference
Guides

group member

group member

The OLP CLI supports the following:

group member add

Adds members to a group.

olp group member 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, separated by space.
    • --user <userID1 userID2 ...> The list of user IDs you want to add to the group, 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.

Example:

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

group member list

Retrieves all available members in a group.

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

Required parameters:

  • <group ID> The ID of the group.

Optional parameters:

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

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

Example:

olp group member 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 member remove

Removes members from a group.

olp group member 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 the group, separated by space.
    • --user <userID1 userID2 ...> The list of user IDs you want to remove from the group, 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.

Example:

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