Risk Management

Retrieve enterprise security posture analytics, compliance data, and key performance indicators via the Admin REST API.

Description

The Risk Management endpoint provides programmatic access to security posture metrics, compliance benchmarks, and organizational KPIs captured by the Keeper Risk Management Dashboardarrow-up-right.

The Risk Management Dashboard tracks key utilization metrics across your Keeper Enterprise environment, including user onboarding status, vault activity, two-factor authentication adoption, and adherence to Keeper Security Benchmarks. The Risk Management endpoint exposes this data through a RESTful interface, enabling CSPM (Cloud Security Posture Management) integration and programmatic security posture assessment.

Overview

The Admin REST API Risk Management endpoint delivers comprehensive security posture data from your Keeper Enterprise environment. This capability supports critical security, compliance, and operational use cases:

Security Posture Monitoring Retrieve real-time metrics on user deployment, vault utilization, and 2FA adoption. Track organizational security health across all users and identify gaps in credential protection coverage.

Compliance Automation Programmatically assess adherence to Keeper Security Benchmarks. Integrate benchmark compliance status into GRC (Governance, Risk, and Compliance) platforms for automated compliance reporting against SOX, ISO 27001, HIPAA, PCI-DSS, and internal security policies.

Executive Dashboards Feed security posture analytics and KPIs into business intelligence platforms for executive visibility. Track deployment progress, user adoption trends, and security benchmark remediation over time.

CSPM Integration Incorporate Keeper security posture data into your Cloud Security Posture Management stack. Automate detection of misconfigurations and track remediation progress across your credential management environment.

circle-info

Native connectors for Security Posture Management tools like Wiz, Tenable, and Savyint are coming soon. For now, administrators can use middleware, such as AWS Cloudtrails and Cloudwatch to broker data from Keeper to Wiz. See AWS Docsarrow-up-right.

Prerequisites

Key Metrics Available

The endpoint provides access to the following security posture data:

Metric Category
Description

User Deployment

Total users, active users, invited users, invitation acceptance rates

Vault Utilization

Users who have created records, record creation activity

Login Activity

Users logged in within 30 days, last login timestamps

2FA Adoption

Users with 2FA-protected vaults (non-SSO environments)

License Utilization

Active licenses, available licenses, utilization percentage

Security Benchmarks

Critical items to resolve, completed benchmarks, ignored benchmarks

Security Alerts

High-priority alert counts, occurrence trends, 30-day comparisons

Configuration

Enterprise Stat

Endpoint

Purpose Retrieve Risk Management recent login count.

Authentication Send your API token in the x-api-token header: x-api-token: Bearer <API_TOKEN>

Headers

Header
Example

x-api-token

Bearer <API_TOKEN>

Query parameters

Request

Example success response (200)

Error codes

Code
Message
Cause

401

Unauthorized

Invalid or missing API token

500

Internal Server Error

Unexpected server error

Security Notes

  • Treat API tokens like passwords; rotate them on a schedule.

  • Restrict permissions to the minimum required roles and actions.

  • Prefer short expirations; use never only for special automation cases.

  • Store tokens in a secure location (e.g., Keeper Vault).

Enterprise Stat Details

Endpoint

Purpose Retrieve the recent login count (users who logged in the last 30 days) and the number of users who have at least one record in their Vault

Authentication Send your API token in the x-api-token header: x-api-token: Bearer <API_TOKEN>

Headers

Header
Example

x-api-token

Bearer <API_TOKEN>

Query parameters

Request

Example success response (200)

Error codes

Code
Message
Cause

401

Unauthorized

Invalid or missing API token

500

Internal Server Error

Unexpected server error


Security Notes

  • Treat API tokens like passwords; rotate them on a schedule.

  • Restrict permissions to the minimum required roles and actions.

  • Prefer short expirations; use never only for special automation cases.

  • Store tokens in a secure location (e.g., Keeper Vault).

Security Alerts Summary

Endpoint

Purpose Retrieve summary of events that happened in the last 30 days

Authentication Send your API token in the x-api-token header: x-api-token: Bearer <API_TOKEN>

Headers

Header
Example

x-api-token

Bearer <API_TOKEN>

Query parameters

Request

Example success response (200)

Error codes

Code
Message
Cause

401

Unauthorized

Invalid or missing API token

500

Internal Server Error

Unexpected server error


Security Notes

  • Treat API tokens like passwords; rotate them on a schedule.

  • Restrict permissions to the minimum required roles and actions.

  • Prefer short expirations; use never only for special automation cases.

  • Store tokens in a secure location (e.g., Keeper Vault).

Security Alerts Detail

Endpoint

Purpose Retrieve details of event that happened in the last 30 days with a comparison to the previous 30 days aet is audit event type (id) example: account_recovery_decline

Authentication Send your API token in the x-api-token header: x-api-token: Bearer <API_TOKEN>

Query parameters

Name
Type
Required
Description

audit_event_type

ISO 8601

Yes

Audit event type from stats

Headers

Header
Example

x-api-token

Bearer <API_TOKEN>

Query parameters

Request

Example success response (200)

Error codes

Code
Message
Cause

400

Can't find required query param: audit_event_type value

audit_event_type is missing or not matches internal mapping

401

Unauthorized

Invalid or missing API token

500

Internal Server Error

Unexpected server error


Security Notes

  • Treat API tokens like passwords; rotate them on a schedule.

  • Restrict permissions to the minimum required roles and actions.

  • Prefer short expirations; use never only for special automation cases.

  • Store tokens in a secure location (e.g., Keeper Vault).

Get security benchmarks

Endpoint

Purpose Get the list of security benchmark set for the calling enterprise

Authentication Send your API token in the x-api-token header: x-api-token: Bearer <API_TOKEN>

Headers

Header
Example

x-api-token

Bearer <API_TOKEN>

Query parameters

Request

Example success response (200)

Error codes

Code
Message
Cause

401

Unauthorized

Invalid or missing API token

500

Internal Server Error

Unexpected server error


Security Notes

  • Treat API tokens like passwords; rotate them on a schedule.

  • Restrict permissions to the minimum required roles and actions.

  • Prefer short expirations; use never only for special automation cases.

  • Store tokens in a secure location (e.g., Keeper Vault).

Set security benchmarks

Endpoint

Purpose Set a list of security benchmark. Corresponding audit events will be logged.

Authentication Send your API token in the x-api-token header: x-api-token: Bearer <API_TOKEN>

Headers

Header
Example

x-api-token

Bearer <API_TOKEN>

Query parameters

Request

Example success response (200)

Error codes

Code
Message
Cause

401

Unauthorized

Invalid or missing API token

500

Internal Server Error

Unexpected server error

Last updated

Was this helpful?