Application Access Key Commands

The OLP CLI supports the following functionality for application access key management:

app key access list

Retrieves access keys of an application.

olp app key access list <app HRN> [command options]

Required parameters:

  • <app HRN> The HRN of the application.

Optional parameters:

  • --enabled <true|false> If set to true, filters by enabled access keys. If not specified all keys are returned.
  • --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 Display the command's result in JSON format.
  • --quiet List of the keys, skipping additional information.

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

Example:

The command below lists access keys of the application:


olp app key access list hrn:here-cn:account::myrealm:app/my-app-1234 --json

Output:


{"keys": [
    {
        "accessKeyId": "my-access-key-1234",
        "clientId": "my-client-1234",
        "accessKeyHrn": "hrn:here-cn:account::myrealm:accesskey/my-access-key-1234",
        "clientHrn": "hrn:here-cn:account::olp-here:app/my-client-1234",
        "createdTime": 1592482089625,
        "enabled": true
    }
]}

app key access create

Creates an access key for an application.

olp app key access create <app HRN> [command options]

Required parameters:

  • <app HRN> The HRN of the application.

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.
  • --json Display the command's result in JSON format.
  • --quiet Display only access key ID and access key secret.

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

Example:

The command below creates an application access key:


olp app key access create hrn:here-cn:account::myrealm:app/my-app-1234

Output:


here.user.id = my-user-1234
here.client.id = my-client-1234
here.access.key.id = my-access-key-1234
here.access.key.secret = my-access-secret-1234
here.token.endpoint.url = https://elb.cn-northwest-1.account.hereapi.cn/oauth2/token

app key access delete

Deletes an access key for an application.

olp app key access delete <app HRN> <access key HRN> [command options]

Note

Processes associated with an app such as pipelines cease functioning a maximum of 24 hours after you disable or delete this app access key.

Required parameters:

  • <app HRN> The HRN of the application.
  • <access key HRN> The HRN of the application access key.

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 Display an empty output skipping additional information.

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

Example:

The command below deletes an application access key:


olp app key access delete hrn:here-cn:account::myrealm:app/my-app-1234 hrn:here-cn:account::myrealm:accesskey/my-accesskey-1234

Output:


Access key hrn:here-cn:account::myrealm:accesskey/my-accesskey-1234 has been deleted.

app key access enable

Enables an access key of an application.

olp app key access enable <app HRN> <access key HRN> [command options]

Required parameters:

  • <app HRN> The HRN of the application.
  • <access key HRN> The HRN of the application access key.

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 Display an empty output skipping additional information.

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

Example:

The command below enables an application access key:


olp app key access enable hrn:here-cn:account::myrealm:app/my-app-1234 hrn:here-cn:account::myrealm:accesskey/my-accesskey-1234

Output:


Access key hrn:here-cn:account::myrealm:accesskey/my-accesskey-1234 has been enabled.

app key access disable

Disables an access key of an application.

olp app key access disable <app HRN> <access key HRN> [command options]

Note

Processes associated with an app such as pipelines cease functioning a maximum of 24 hours after you disable or delete this app access key.

Required parameters:

  • <app HRN> The HRN of the application.
  • <access key HRN> The HRN of the application access key.

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 Display an empty output skipping additional information.

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

Example:

The command below disables an application access key:


olp app key access disable hrn:here-cn:account::myrealm:app/my-app-1234 hrn:here-cn:account::myrealm:accesskey/my-accesskey-1234

Output:


Access key hrn:here-cn:account::myrealm:accesskey/my-accesskey-1234 has been disabled.

results matching ""

    No results matching ""