> ## Documentation Index
> Fetch the complete documentation index at: https://docs.threataware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Admin By Request

> Connect ThreatAware to Admin By Request for privileged access management visibility

## Overview

The Admin By Request integration enables ThreatAware to collect privileged access management (PAM) data from your Admin By Request deployment, providing visibility into administrative access patterns and security posture.

<Info>
  **Connection Method**: API
  **Setup Time**: 10 minutes
  **Access Required**: Admin By Request Administrator account
</Info>

## Data collected

The Admin By Request integration provides:

* Privileged access requests and approvals
* Administrative access history
* User privilege elevations
* Compliance audit data

## Use cases

<CardGroup cols={2}>
  <Card title="Privileged Access Tracking" icon="lock">
    Monitor and track all privileged access requests and approvals
  </Card>

  <Card title="Compliance Reporting" icon="clipboard-check">
    Generate reports for privileged access management compliance
  </Card>

  <Card title="Audit Trails" icon="file-contract">
    Maintain detailed audit logs of administrative actions
  </Card>

  <Card title="Access Control Validation" icon="shield">
    Verify least-privilege access principles are enforced
  </Card>
</CardGroup>

## Setup instructions

<Steps>
  <Step title="Access Admin By Request Portal">
    Begin by logging into Admin By Request:

    * Go to your Admin By Request portal
    * Sign in with an administrator account
  </Step>

  <Step title="Navigate to API Access Settings">
    Locate the API configuration area:

    * In the Admin By Request portal, navigate to **Settings**
    * Look for **API Access**, **API Settings**, or **Integrations** section
    * This is where you'll generate API credentials
  </Step>

  <Step title="Generate API Key">
    Create a new API key:

    * Click **Create New API Key** or similar option
    * Configure the API key permissions:
      * Ensure it has read access to required data
      * Select only necessary scopes for ThreatAware integration
    * Click **Generate** to create the key
    * Copy the **API Key** and save it securely

    <Warning>
      The API key is typically shown only once. Copy and save it immediately.
    </Warning>
  </Step>

  <Step title="Configure in ThreatAware">
    Enter the API key into ThreatAware:

    * Log in to the ThreatAware dashboard
    * Navigate to **Settings > Integrations**
    * Search for **Admin By Request** and click **Connect**
    * Paste the **API Key** into the designated field
    * Click **Connect** to establish the integration
  </Step>

  <Step title="Verify Connection">
    Confirm successful integration:

    * Check that the integration status in ThreatAware shows **Active**
    * Wait 5-10 minutes for initial data synchronization
    * Verify Admin By Request data appears in ThreatAware
  </Step>
</Steps>

## Required credentials

<AccordionGroup>
  <Accordion title="API Key" icon="key">
    **Field Name**: Admin By Request API Key
    **Type**: Password (encrypted)
    **Description**: The API access token for Admin By Request integration

    Generated in Admin By Request:

    * Settings > API Access section
    * Create a new API key with appropriate permissions
    * Unique to your Admin By Request instance

    <Tip>
      Store this API key in your organisation's password manager. Treat it with the same security as a password.
    </Tip>
  </Accordion>
</AccordionGroup>

## Verification and testing

After setup, verify the integration is working correctly:

1. **Check Integration Status**
   * Navigate to **Settings > Integrations** in ThreatAware
   * Confirm Admin By Request shows **Active** status
   * Check the last sync timestamp

2. **Verify Data Collection**
   * Wait 5-10 minutes for initial data synchronization
   * Search ThreatAware dashboard for Admin By Request data
   * Verify privileged access requests are appearing

3. **Test Queries**
   * Create a test query to filter privileged access data
   * Verify access history and approval information are available

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication Failure" icon="triangle-exclamation">
    **Symptoms**: Integration fails with authentication error

    **Solutions**:

    * Verify the API key is copied exactly without extra spaces
    * Ensure the API key has not expired
    * Check that the key has not been revoked in Admin By Request
    * Generate a new API key and update ThreatAware
    * Verify your account has API access permissions
  </Accordion>

  <Accordion title="Permission Issues" icon="ban">
    **Symptoms**: Integration connects but no data appears

    **Solutions**:

    * Check that the API key has appropriate permissions
    * Review Admin By Request API documentation for required scopes
    * Verify your account has permissions to access the data
    * Regenerate the API key with correct permissions
    * Contact Admin By Request support if issues persist
  </Accordion>

  <Accordion title="API Key Expired" icon="clock">
    **Symptoms**: Integration was working but now fails with authentication error

    **Solutions**:

    * Check the API key expiration in Admin By Request settings
    * Generate a new API key if the current one has expired
    * Update ThreatAware with the new API key
    * Document API key expiration dates in your password manager
    * Set reminders to rotate API keys before expiration
  </Accordion>

  <Accordion title="No Data After Connection" icon="database">
    **Symptoms**: Integration shows active but no privileged access data appears

    **Solutions**:

    * Wait up to 15 minutes for initial data synchronization
    * Verify there are active privileged access requests in Admin By Request
    * Check that your organisation has PAM policies configured
    * Review ThreatAware integration logs for sync errors
    * Contact Admin By Request support if data is missing
  </Accordion>
</AccordionGroup>

## Additional resources

<CardGroup cols={2}>
  <Card title="Admin By Request Documentation" icon="book" href="https://adminbyrequest.com/docs">
    Official Admin By Request documentation and guides
  </Card>

  <Card title="API Documentation" icon="code" href="https://adminbyrequest.com/docs">
    API reference and integration documentation
  </Card>

  <Card title="Admin By Request Support" icon="life-ring" href="https://adminbyrequest.com/">
    Contact Admin By Request for technical support
  </Card>

  <Card title="ThreatAware Support" icon="life-ring" href="mailto:help@threataware.com">
    Contact ThreatAware support for integration assistance
  </Card>
</CardGroup>

## Best practices

<Tip>
  **API Key Management**

  * Store API keys in your organisation's password manager
  * Rotate API keys periodically per your security policy
  * Never share API keys with unauthorized users
  * Document which systems use each API key
  * Revoke API keys immediately if compromise is suspected
</Tip>

<Tip>
  **Permission Scoping**

  * Request only necessary API permissions
  * Review Admin By Request API scopes before generating keys
  * Use read-only permissions for integrations when possible
  * Document the permissions needed for each integration
</Tip>

<Tip>
  **Monitoring**

  * Monitor API access logs in Admin By Request regularly
  * Set up alerts for failed authentication attempts
  * Review integration status in ThreatAware frequently
  * Document and track API usage patterns
</Tip>