LogoLogo
Documentation and Guides
Documentation and Guides
  • ABOUT APONO
    • Why Choose Apono
    • Security and Architecture
    • Glossary
  • GETTING STARTED
    • How Apono Works
    • Getting started
    • Access Discovery
    • Integrating with Apono
  • CONNECTORS AND SECRETS
    • Apono Integration Secret
    • High Availability for Connectors
    • Installing a connector with Docker
    • Manage integrations
    • Manage connectors
    • S3 Storage
  • AWS ENVIRONMENT
    • AWS Overview
    • Apono Connector for AWS
      • Installing a connector on EKS Using Terraform
      • Updating a connector in AWS
      • Installing a connector on AWS ECS using Terraform
    • AWS Integrations
      • Integrate an AWS account or organization
        • Auto Discover AWS RDS Instances
        • AWS Best Practices
      • Amazon Redshift
      • RDS PostgreSQL
      • AWS RDS MySQL
      • Integrate with EKS
      • AWS Lambda Custom Integration
      • EC2 via Systems Manager Agent (SSM)
  • AZURE ENVIRONMENT
    • Apono Connector for Azure
      • Install an Azure connector on ACI using Azure CLI
      • Install an Azure connector on ACI using PowerShell
      • Install an Azure connector on ACI using Terraform
      • Updating a connector in Azure
    • Azure Integrations
      • Integrate with Azure Management Group or Subscription
        • Auto Discover Azure SQL Databases
      • Azure MySQL
      • Azure PostgreSQL
      • Integrate with AKS
  • GCP ENVIRONMENT
    • Apono Connector for GCP
      • Installing a GCP connector on Cloud Run using CLI
      • Installing a GCP connector on GKE using CLI (Helm)
      • Installing a GCP connector on GKE using Terraform
      • Updating a connector in Google Cloud
    • GCP Integrations
      • Integrate a GCP organization or project
      • CloudSQL - MySQL
      • CloudSQL - PostgreSQL
      • Google Cloud Functions
      • Integrate with GKE
      • AlloyDB
  • KUBERNETES ENVIRONMENT
    • Apono Connector for Kubernetes
      • Installing a connector on Kubernetes with AWS permissions
      • Updating a Kubernetes connector
    • Kubernetes Integrations
      • Integrate with Self-Managed Kubernetes
  • ADDITIONAL INTEGRATIONS
    • Databases and Data Repositories
      • Microsoft SQL Server
      • MongoDB
      • MongoDB Atlas
      • MongoDB Atlas Portal
      • MySQL
      • Oracle Database
      • PostgreSQL
      • RabbitMQ
      • Redis Cloud (Redislabs)
      • Snowflake
      • Vertica
      • MariaDB
    • Network Management
      • SSH Servers
      • RDP Servers
      • Windows Domain Controller
      • AWS EC2 SSH Servers
      • Azure VM SSH Servers
      • Installing the Apono HTTP Proxy
    • Development Tools
      • GitHub
      • Rancher
    • Identity Providers
      • Okta SCIM
      • Okta Groups
      • Okta SSO for Apono logins
      • Google Workspace (Gsuite)
      • Google Workspace (GSuite) Groups
      • Azure Active Directory (Microsoft Entra ID)
      • Azure Active Directory (Entra ID) Groups
      • Jumpcloud
      • JumpCloud Groups
      • OneLogin
      • OneLogin Group
      • LDAP Groups
      • The Manager Attribute in Access Flows
      • HiBob
      • Ping Identity SSO
    • Incident Response Integrations
      • Opsgenie
      • PagerDuty
      • VictorOps (Splunk On-Call)
      • Zenduty
    • ChatOps Integrations
      • Slack integration
      • Teams integration
      • Backstage Integration
    • Secret Management
      • 1Password
  • WEBHOOK INTEGRATIONS
    • Webhooks Overview
    • Anomaly Webhook
    • Audit Log Webhook
    • Request Webhook
      • Custom Webhooks
      • Communications and Notifications
        • Slack Outbound Webhooks
        • Teams
        • Outlook and Gmail (Using Azure Logic App)
      • ITSM
        • Freshdesk
        • Jira
        • ServiceNow
        • Zendesk
        • Freshservice
        • ServiceDesk Plus
      • Logs and SIEMs
        • Coralogix
        • Datadog
        • Logz.io
        • Grafana
        • New Relic
        • SolarWinds
        • Sumo Logic
        • Cortex
        • Logpoint
        • Splunk
        • Microsoft Sentinel
      • Orchestration and workflow builders
        • Okta Workflows
        • Torq
    • Integration Webhook
    • Webhook Payload References
      • Audit Log Webhook Payload Schema Reference
      • Webhook Payload Schema Reference
    • Manage webhooks
    • Troubleshoot a webhook
    • Manual Webhook
      • ITSM
        • PagerDuty
  • ACCESS FLOWS
    • Access Flows
      • What are Access Flows?
    • Create Access Flows
      • Self Serve Access Flows
      • Automatic Access Flows
      • Access Duration
    • Manage Access Flows
      • Right Sizing
    • Revoke Access
    • Dynamic Access Management
      • Resource and Integration Owners
    • Common Use Cases
      • Ensuring SLA
      • Protecting PII and Customer Data
      • Production Stability and Management
      • Break Glass Protocol
    • Create Bundles
    • Manage Bundles
  • ACCESS REQUESTS AND APPROVALS
    • Slack
      • Requesting Access with Slack
      • Approving Access with Slack
      • Reviewing historical requests with Slack
    • Teams
      • Requesting Access with Teams
      • Approving Access with Teams
    • CLI
      • Install and manage the Apono CLI
      • Requesting Access with CLI
    • Web Portal
      • Requesting Access with the Web Portal
      • Approving Access with the Web Portal
      • Reviewing historical requests with the Web Portal
    • Freshservice
    • Favorites
  • Inventory
    • Inventory Overview
    • Inventory
    • Access Scopes
    • Risk Scores
    • Apono Query Language
  • AUDITS AND REPORTS
    • Activity Overview
      • Activity
      • Create Reports
      • Manage Reports
    • Compliance: Audit and Reporting
    • Auditing Access in Apono
    • Admin Audit Log (Syslog)
  • HELP AND DEBUGGING
    • Integration Status Page
    • Troubleshooting Errors
  • ARCHITECTURE AND SECURITY
    • Anomaly Detection
    • Multi-factor Authentication
    • Credentials Rotation Policy
    • Periodic User Cleanup & Deletion
    • End-user Authentication
    • Personal API Tokens
  • User Administration
    • Role-Based Access Control (RBAC) Reference
    • Create Identities
    • Manage Identities
Powered by GitBook
On this page
  • Prerequisites
  • Request access
  • Request Use Cases

Was this helpful?

Export as PDF
  1. ACCESS REQUESTS AND APPROVALS
  2. CLI

Requesting Access with CLI

Learn how request access using the Apono CLI

Last updated 7 months ago

Was this helpful?

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

Since requests for different integrations have specific requirements, we recommend using the following steps:

  1. Use the to make an initial integration request.

  2. Create and save an alias with the request command displayed in the CLI.


Prerequisites

Item
Description

Apono Account

Access Flow Grantee

Contact your administrator for more information.


Request access

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 in a new browser tab.

  3. Close both browser tabs.

Make an access request

Although each access request requires different details, the general workflow for all requests is similar.

Follow these steps to submit an access request:

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

    apono
  2. Select Request new access and press the Enter key. The Select request type prompt appears.

  3. Select an option and press the Enter key. A prompt appears.\

    Request Type
    Description

    Bundle

    Access to a defined group of resources A bundle of access may be based on a role or specific project needs.

    Integration

    Access to a specific resource

  4. Select an option for the prompt and for each of the subsequent prompts to request access. Each access request requires specific information. However, the last prompt to appear for all access requests is the Enter justification prompt.

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.

  1. Type a brief explanation to justify the access request and press the Enter key.

  2. Access the resource.

Accessing the resource depends upon the approval process:


Request Use Cases

Request and Immediate Access

An engineer needs access to all the Postgres databases in postgresql/dimi delete. SUPERUSER is the only permission level for the Postgres databases.

Follow these steps to submit an access request:

  1. In Terminal, start the workflow. The What do you want to do? prompt appears.

    apono
  2. Select Request new access and press Enter. The Select request type prompt appears.

  3. Select Integration and press the Enter key. A Select integration prompt appears.

  4. Select the integration and press the Enter key. Since only one option exists for the resource type, this option is automatically chosen. The Select Database prompt appears.

  5. Select one or several databases and press Enter key. Since only one option exists for the permissions, this option is automatically chosen. The Enter justification prompt appears.

  6. Type a brief explanation to justify the access request and press the Enter key. After submitting a request the following information is displayed:

    • Request Command: CLI command for the request that can be used to request access again in the future or to create an alias.

      apono requests create --integration "azure-aks/test" --resource-type "azure-aks-namespace" --permissions "admin" --permissions "edit" --resources "kube-system" --justification "Need access to this AKS namespace"
    • Status: Details of the request and its approval status.

    • Select Access Prompt: Prompt to gain access to the resource.

  7. Select the access and press the Enter key. The Select how to use access prompt appears.

For some integration workflows, you will not see additional prompts and will be immediately logged in to the resource.

  1. Select an access option and press the Enter key.\

    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

Manual Approval

An engineer needs admin and edit permissions for the AKS namespace, test/kube-system on azure-aks/test. This is the only AKS namespace in this environment.

Follow these steps to submit an access request:

  1. In Terminal, start the workflow. The What do you want to do? prompt appears.

    apono
  2. Select Request new access and press the Enter key. The Select request type prompt appears.

  3. Select Integration and press the Enter key. A Select integration prompt appears.

  4. Select the integration and press the Enter key. The Select resource type prompt appears.

  5. Select Namespace and press the Enter key. Since only one option exists, this option is automatically chosen. The Select permissions prompt appears.

  6. Select one or several permissions and press the Enter key. The Enter justification prompt appears.

  7. Type a brief explanation to justify the access request and press the Enter key.

After submitting a request the following information is displayed:

  • Request Command: CLI command for the request that can be used to request access again in the future or to create an alias.

    apono requests create --integration "azure-aks/test" --resource-type "azure-aks-namespace" --permissions "admin" --permissions "edit" --resources "kube-system" --justification "Need access to this AKS namespace"

Resource Access

An engineer who was previously granted access to a resource wants to connect to that resource.

Follow these steps to submit an access request:

  1. In Terminal, start the workflow. The What do you want to do? prompt appears.

    apono
  2. Select Connect to a resource and press the Enter key. The Select how to use access prompt appears.

  3. Select an access option and press the Enter key.

    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

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

Inclusion in at least one

Immediate approval: You will be granted access to the resource. You may be logged in automatically, provided connection instructions, or prompted for login credentials. See: .

Manual approval: You must await approval. After approval is granted, you can connect to a resource by following the connection instructions or entering your credentials. See: and .

Status: Details of the request and its approval status. Once a request has been approved, you can connect to a resource. See: .

Request and Immediate Access
Manual Approval
Resource Access
Resource Access
the Apono Portal
access flow
interactive approach
CLI access request
General workflow for a request and resource access