org

The OLP CLI supports the following functionality for organization management:

• list groups
• list apps
• list users
• list pending invitations

org group list

Lists all groups of the organization.

olp org group list [command options]

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 HERE platform portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --csv Displays the command result with additional fields in CSV format.
• --quiet Displays the group HRNs, each on a new line.
• --admin Adds information about group administrators to the output. Valid only if --csv is also specified. If the value returned in the "Administrators" field is "Access denied", your app credentials are restricted from accessing group administrators information.

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

Example:

The command below lists groups of the organization in CSV format.

olp org group list --csv --admin

Output:

group ID,name,description,administrators
my-group-id,my-group-name,My group description,USER|user-id|John Doe|[email protected];APP|app-id|Manager App Name
another-group-id,Another Group Name,"Comma, separated, words, as, a, description",APP|admin-app-id|"App|Name;With,Special;|,Characters"

org app list

Lists all apps of the organization.

olp org app list [command options]

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 HERE platform portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --csv Displays the command result with additional fields in CSV format.
• --quiet Displays the app HRNs, each on a new line.
• --manager Adds information about application managers to the output. Valid only if --csv is also specified. If the value returned in the "Managers" field is "Access denied", your app credentials are restricted from accessing app managers information.

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

Example:

The command below lists apps of the organization in CSV format.

olp org app list --csv --manager

Output:

app ID,name,description,status,managers
my-app-id,my-app-name,My app description,active,USER|user-id|John Doe|[email protected];APP|app-id|Manager App Name;GROUP|group-id|Manager Group Name
another-app-id,Another app Name,"Comma, separated, words, as, a, description",active,"APP|manager-app-id|""App|Name;With,Special;|,Characters"";USER|another-user-id|Jane Smith|[email protected]"

org user list

Lists all users of the organization.

olp org user list [command options]

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 HERE platform portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --csv Displays the command result with additional fields in CSV format.
• --quiet Displays the user HRNs, each on a new line.

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

Example:

The command below lists users of the organization in CSV format.

olp org user list --csv

Output:

user ID,name,email,org roles,account state
user-id,John Doe,[email protected],"OrgAdmin, GroupAdmin",enabled

org invitation list

Lists all pending invitations of the organization.

olp org invitation list [command options]

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 HERE platform portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --csv Displays the command result with additional fields in CSV format.
• --quiet Displays the pending invitation HRNs, each on a new line.

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

Example:

The command below lists pending invitations of the organization in CSV format.

olp org invitation list --csv

Output:

name,email,date sent
John Doe,[email protected],2021-04-26T08:20:49.345