Requesting Access with CLI

Learn how request access using the Apono CLI

circle-check

The Apono CLI enables you to view, request, and receive permission to services, databases, and applications that are centrally managed via Apono.


Prerequisites

Item
Description

Apono Account

Grantee access to Apono You can verify that you have access by going to the Apono Portalarrow-up-right or contacting your administrator to obtain a user account.

Access Flow Grantee

Inclusion in at least one access flow

Contact your administrator for more information.


Log in to Apono

Before you can make access requests via the Apono CLI, you must log in to your Apono account.

Follow these steps to log in:

  1. In Terminal, initiate logging in to your Apono account. The Apono UI login screen will open in a new web browser tab.

    apono login
  2. In the web browser tab, log in to your Apono account. After successfully logging in to your account, the Authorized page will appear.

  3. Close the browser tab.


Request new access

You can request access to specific resources or a bundle.

lightbulb
circle-info

When making selections for each prompt, note the following:

  • If a specific prompt only has one associated option, that option will automatically be chosen and the next prompt will appear.

  • Use the arrow keys on your keyboard to highlight an option.

  • If a prompt accepts multiple options, use the spacebar to select one or several of the options.

  • Use the Enter or Return key on your keyboard to submit an entry.

Follow these steps to request access to an integration:

  1. In Terminal, enter apono. The What do you want to do? prompt appears.

  1. Select and submit Request new access. The Select request type prompt appears.

  2. Select and submit Integration. The Select integration prompt appears.

  3. Select and submit an integration. The Select resource type prompt appears.

  4. Select and submit a resource type. A prompt listing available resources appears.

  5. Select and submit one or more resources. The Select permissions prompt appears.

  6. Select and submit a permission. The Enter duration in hours prompt appears.

  7. Enter and submit a time duration. The Enter Justification prompt appears.

circle-info

You can enter minutes as a decimal portion of an hour. For example, 45 minutes as 0.75.

  1. Enter and submit a reason for requesting access. A response is displayed with a notice and status of the access request.

  2. (Optional) Copy and save the notice that displays the command to make the same request again.

lightbulb

If enabled by your admin, you will receive a notification via Slack or Microsoft Teams. Otherwise, the notification will be delivered by email.


Access the resource

After access has been granted, you can access the resource.

Follow these steps to access a resource:

  1. In Terminal, enter apono access. The Select access prompt and a list of resources appears.

  1. Select and submit the resource to access.The Select how to use access prompt appears.

  2. Select and submit an option.

Option
Description

Connect

Connects the user directly to the database

Once you have connected to the database, you can make queries directly from the CLI prompt.

Instructions

Prints instructions to access the database to the screen


Request access again

If your access has expired, been revoked, or been rejected, you can request the same access again.

Follow these steps to request access again:

  1. In Terminal, enter the command that was displayed when you submitted your original request. The following is an example integration request.

lightbulb

If enabled by your admin, you will receive a notification via Slack or Microsoft Teams. Otherwise, the notification will be delivered by email.


View requests

You can view your open and closed requests.

Follow these steps to view your requests:

  1. In Terminal, enter apono requests list at the prompt. A list of your recent requests will be displayed.


Revoke an access request

If you need to revoke your access, you must revoke access through one of the following clients:


Access Statuses

Status
Description

Pending Approval

The request is waiting for the approver to approve or reject the request.

Granting

The request has been approved. Apono is provisioning the access.

Active

Access has been provisioned. You can access the resource.

Follow these steps to access the resource:

  1. In Terminal, enter apono access. The Select access prompt and a list of resources appears.

  2. Select and submit the resource to access.The Select how to use access prompt appears.

  3. Select and submit Connect.

Rejected

The request has been rejected either automatically or by approvers.

Revoking

An admin has initiated removing your resource access.

Revoked

An admin has removed your resource access.

Failed

An error has occurred with your request. Contact your admin.

circle-exclamation

Last updated

Was this helpful?