app

The OLP CLI supports the following functionality for application management:

• list apps
• create an app
• update an app
• show an app
• delete an app

app list

Lists all apps to which your current app has access as a manager.

olp app list [command options]

Optional parameters:

• [filter] Freeform text to filter the app list by name. The filter checks if an app's HRN, name, or description contains the filter string. Note that filtering happens on the OLP CLI side, so if you use both [filter] and --limit, the number of apps returned may be less than the --limit value.
• <--read|--write|--manage|--share> Use one of these flags to retrieve all the apps to which your app has a specific permission.
• --limit <max number of apps> The maximum number of apps returned in the result (100 by default).
• --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.
• --json Displays the command result in JSON format.
• --quiet Displays the app HRNs, each on a new line.

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

Example:

The command below lists those apps whose HRN, name, or description contains my-app.

olp app list my-app --json

Output:

{"apps": [
        {
            "appCreationEnabled": true,
            "hrn": "hrn:here-cn:account::org:app/my-app-1234",
            "appId": "someAppId",
            "name": "my-app-name",
            "description": "my app description",
            "status": "active"
        }
    ]
}

app create

Creates an app.

olp app create <app name> [command options]

Required parameters:

• <app name> The human-readable name of the app.

Optional parameters:

• --description <app description> A detailed description of the app. Enclose the description in quotes.
• --app-creation-enabled <true|false> Defines if the app is allowed to create other apps (false by default).
• --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.
• --json Displays the command result in JSON format.
• --quiet Displays the app HRN.

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

Example:

The command below creates a new app:

olp app create my-app-name --description "my app description"

Output:

Application hrn:here-cn:account::org:app/my-app-1234 has been created

app update

Updates an app.

olp app update <app HRN> [command options]

Required parameters:

• <app HRN> The HRN of the app.

Optional parameters:

• --name <app name> A new human-readable name for the app. If nothing is specified, the original name is retained.
• --description <app description> A new description for the app and its contents. If nothing is specified, the original description is retained.
• --app-creation-enabled <true|false> Defines if the app is allowed to create other apps. If nothing is specified, the original value is retained.
• --trusted-domains <enable|disable> Enables trusted domains for the application. A maximum of 3,000 trusted domains per application are allowed.
• --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.
• --json Displays the command result in JSON format.
• --quiet Displays empty output with no additional information.

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

Example:

The command below updates the name of an app:

olp app update hrn:here-cn:account::org:app/my-app-1234 --name "my updated name"

Output:

Application hrn:here-cn:account::org:app/my-app-1234 has been updated

The command below enables the trusted domains of an app:

olp app update hrn:here-cn:account::org:app/my-app-1234 --trusted-domains enable

Output:

Application hrn:here-cn:account::org:app/my-app-1234 has been updated

app show

Shows the details of an app.

olp app show <app HRN>

Required parameters:

• <app HRN> The HRN of the app.

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.
• --quiet Displays the app name.
• --json Displays the command result in JSON format.

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

Example:

The command below shows the details of an app:

olp app show hrn:here-cn:account::org:app/my-app-1234 --json

olp app show hrn:here-cn:account::org:app/my-app-1234 --json

Output:

{
"appId": "my-app-1234",
"name": "my-app-name",
"description": "My app description",
"hrn": "hrn:here-cn:account::org:app/my-app-1234",
"status": "active",
"appCreationEnabled": false,
"trustedDomainsEnabled": false,
"roles": ["CrossRealmTrustManager"]
}

app delete

Deletes an app.

olp app delete <app HRN>

Required parameters:

• <app HRN> The HRN of the app 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 HERE 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:

The command below deletes the app appId:

olp app delete hrn:here-cn:account::org:app/my-app-1234

Output:

Application hrn:here-cn:account::org:app/my-app-1234 has been deleted