GuidesChangelogData Inspector Library API Reference
Guides

role

role

The OLP CLI supports the following functionality for role management:

role list

Retrieves roles available in a realm or project or group.

olp role list <resource HRN> [command options]

Required parameters:

  • <resource HRN> HRN of the realm/project/group.

Optional parameters:

  • --role-name <role name> Filters the role list by role name. Possible values are OrgAdmin, OrgInviter, GroupAdmin, ResourceManager, ProjectAdmin, MonitoringDashboardEditor, LicensingAdmin, MarketplaceProvider, MarketplaceConsumer, CustomerManager, CrossRealmTrustManager, SupportAdmin, AppAdmin.
  • --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 a list of role HRNs with no additional information.

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

Example:

The command below lists roles in the realm:

olp role list hrn:here:account::my-realm:realm/my-realm --role-name OrgAdmin

Output:

HRN                                                                                                         name
hrn:here:authorization::my-realm:role/ROLE-204d6425-4190-4117-92af-76a0397117b6          OrgAdmin

Use olp role show <role HRN> to display more information about a role

role show

Displays the details of a role.

olp role show <role HRN> [command options]

Required parameters:

  • <role HRN> HRN of a role.

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

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

Example:

The command below provides the details of a role:

olp role show hrn:here:authorization::my-realm:role/ROLE-1234

Output:

service ID                                            action                            resource
SERVICE-b9acbead-4666-487e-88b0-cfb64ed0ac6a          read                              hrn:here:authorization::my-realm:project/1709035379445
SERVICE-b9acbead-4666-487e-88b0-cfb64ed0ac6a          write                             hrn:here:authorization::my-realm:project/1709035379445
SERVICE-b9acbead-4666-487e-88b0-cfb64ed0ac6a          manage                            hrn:here:authorization::my-realm:project/1709035379445
SERVICE-b9acbead-4666-487e-88b0-cfb64ed0ac6a          manageMembers                     hrn:here:authorization::my-realm:project/1709035379445
SERVICE-b9acbead-4666-487e-88b0-cfb64ed0ac6a          readPermissions                   hrn:here:authorization::my-realm:role/ROLE-c16489b5-9294-4729-98eb-e18dcaf4b677