1 of 22

API Reference

API OVERVIEW

Getting Started with the Apono API

Overview

Welcome to the Apono Public API reference! This guide will help you start integrating Apono into your workflows. Using the API, you can easily create Access Flows, add Integrations, create and manage access requests, export activity logs, and more.

Getting Started

All API requests are made over HTTPS and must be authenticated. Responses are returned in JSON format.

Authentication

Apono’s API uses token-based authentication. To authenticate, include the following header in each request:

Authorization: Bearer <your-api-token>

If authentication is not provided or fails, a 401 "Unauthorized" response will be returned.

HTTP/1.1 401 Unauthorized

{
    "status": "401",
    "code": "Unauthorized"
}

You can create and manage your API tokens on the API Tokens page of your Apono app or user portal. Refer to API Authentication for step-by-step instructions on generating your API tokens.

Base URL

All requests should be made to the following base URL:

https://api.apono.io/api/

Headers

Include the following headers with all API calls:

Content-Type: application/json
Authorization: Bearer <your-api-token>

OpenAPI Specification

For teams that want to integrate Apono’s API into internal tools, generate client SDKs, or validate request structures, we provide a full OpenAPI (Swagger) spec.

View the OpenAPI spec

(You can import this directly into tools like Postman, Insomnia, or Swagger UI.)

Support

Need help? Reach out to us at [email protected]

Next Steps

API Authentication

Generate an API Token

Log in to the Apono App or User Portal.
Click the Profile icon in the bottom left corner.
Click Settings and then Personal API Token to view your API tokens.

You can also access the API tokens page directly via the following links, depending on your platform: Admin or Portal.

Click the Add API Token button to generate a new token.
Give the new token a name and click Generate New Token.

Record Your API Tokens in a Safe Place. This is the only time that the unencrypted token is displayed.

Use the API Token

When using any Apono API endpoint, you will be asked to authenticate with one of your tokens. Add this to your request header:

--header 'authorization: Bearer <your-api-token>'

If you are accessing endpoints under the /user/ path, the end user must generate the authenticated token. These endpoints are designed for actions that reflect the permissions and context of the individual user making the request.

To enable API token generation for end users, please contact Apono Support at [email protected].

This capability must be explicitly enabled for your organization before end users can generate their tokens.

Discovering Identity Attribute Types

Identity attribute types define how Apono identifies and evaluates identities in access flows. These types represent built-in identities (like users or groups) or custom attributes integrated from context integrations.

The available types vary depending on your account configuration and connected identity sources. To view the exact list of supported types, run the discovery script below.

import os
import requests

API_URL = "https://api.apono.io/api/admin/v1/attributes"

def get_auth_headers() -> dict:
    token = os.getenv("APONO_TOKEN")
    if not token:
        raise RuntimeError("Missing APONO_TOKEN environment variable")
    return {
        "Authorization": f"Bearer {token}",
        "Accept": "*/*"
    }

def fetch_unique_attribute_types() -> set:
    headers = get_auth_headers()
    attribute_types = set()
    next_page_token = None

    while True:
        params = {}
        if next_page_token:
            params["page_token"] = next_page_token
        response = requests.get(API_URL, headers=headers, params=params)
        response.raise_for_status()
        data = response.json()

        for attribute_item in data.get("items", []):
            attr_type = attribute_item.get("type")
            if attr_type:
                attribute_types.add(attr_type)

        next_page_token = data.get("pagination", {}).get("next_page_token")
        if not next_page_token:
            break

    return attribute_types

if __name__ == "__main__":
    print(sorted(fetch_unique_attribute_types()))

New Endpoints

As part of the continuous development of Apono’s Public API, we are introducing new Admin and End User endpoints.

Why Should You Try It Out?

We’ve released new API endpoints designed to bring greater alignment with Apono’s platform capabilities. These improvements make it easier to automate access management and use Apono.

Key Improvements

Access Management

Access Flows

Support for advanced access flows with richer logic for requestors, approvers, and new settings aligned with what’s available in Apono’s UI, so you can replicate complex access governance policies entirely via API.

Access Scopes

Access Scopes Support: Define and use access scopes directly within bundles and access flows, allowing you to save and use dynamic, reusable groups of resources.

RBAC User Roles Representation

User roles in API responses now match Apono’s native role-based access control (RBAC) model, helping you to enforce role-based access and approval policies programmatically.

Apono Group Management

Query, create, delete, and search Apono groups, removing the need for manual group setup or user assignment in your access flows.

End-User Access Requests

Enable self-service access request workflows by giving admins the ability to extend access capabilities to their end users. This allows you to build internal tools or automation that enable users to independently request, manage, and track access.

Improved Usability

Flexible Name-Based Filtering

Use GET requests to filter objects based on names
Filter expressions now support: contains, starts with, and ends with for all name fields. This enables more intuitive searches, like name=*prod* to look for all prod instances.

Name-Based Object Creation

Apono’s objects (like Access Flows and Bundles) can now be created using object names instead of IDs, simplifying scripting and automation by eliminating the need for extra lookups.

Human-Readable API Responses

API responses now include both IDs and corresponding names. This makes responses easier to interpret, debug, and integrate into tools without additional lookups.

Better Documentation

Comprehensive documentation accompanies all new endpoints, making implementation and troubleshooting faster and easier.

How to Identify New Endpoints

You can identify new endpoints by the following characteristics:

Versioning: Paths include higher version numbers (e.g., /v2, /v3, /v4) reflecting new functionality.
Path Prefixes: Look for new path prefixes like: /admin/ and /user/

List of New Endpoints

Access Flows:

Bundles:

Access Scopes:

Connectors:

GET https://api.apono.io/api/admin/v3/connectors
GET https://api.apono.io/api/admin/v3/connectors/{id}
PUT https://api.apono.io/api/admin/v3/connectors/{id}
DELETE https://api.apono.io/api/admin/v3/connectors/{id}

Integrations:

Groups:

Users:

Available Access:

Access Request:

Access Session:

APONO

Activity Reports

Attributes

Groups

Access Flows

Bundles

Connectors

Users

Integrations

Access Sessions

Available Access

Delegated Access Requests

Access Requests

Access Bundles

Identities

Activity

Access Scopes

New Endpoints

As part of the continuous development of Apono’s Public API, we are introducing new Admin and End User endpoints.

Why Should You Try It Out?

We’ve released new API endpoints designed to bring greater alignment with Apono’s platform capabilities. These improvements make it easier to automate access management and use Apono.

Key Improvements

Access Management

Access Flows

Support for advanced access flows with richer logic for requestors, approvers, and new settings aligned with what’s available in Apono’s UI, so you can replicate complex access governance policies entirely via API.

Access Scopes

Access Scopes Support: Define and use access scopes directly within bundles and access flows, allowing you to save and use dynamic, reusable groups of resources.

RBAC User Roles Representation

User roles in API responses now match Apono’s native role-based access control (RBAC) model, helping you to enforce role-based access and approval policies programmatically.

Apono Group Management

Query, create, delete, and search Apono groups, removing the need for manual group setup or user assignment in your access flows.

End-User Access Requests

Enable self-service access request workflows by giving admins the ability to extend access capabilities to their end users. This allows you to build internal tools or automation that enable users to independently request, manage, and track access.

Improved Usability

Flexible Name-Based Filtering

Use GET requests to filter objects based on names
Filter expressions now support: contains, starts with, and ends with for all name fields. This enables more intuitive searches, like name=*prod* to look for all prod instances.

Name-Based Object Creation

Apono’s objects (like Access Flows and Bundles) can now be created using object names instead of IDs, simplifying scripting and automation by eliminating the need for extra lookups.

Human-Readable API Responses

API responses now include both IDs and corresponding names. This makes responses easier to interpret, debug, and integrate into tools without additional lookups.

Better Documentation

Comprehensive documentation accompanies all new endpoints, making implementation and troubleshooting faster and easier.

How to Identify New Endpoints

You can identify new endpoints by the following characteristics:

Versioning: Paths include higher version numbers (e.g., /v2, /v3, /v4) reflecting new functionality.
Path Prefixes: Look for new path prefixes like: /admin/ and /user/

List of New Endpoints

Access Flows:

Bundles:

Access Scopes:

Connectors:

GET https://api.apono.io/api/admin/v3/connectors
GET https://api.apono.io/api/admin/v3/connectors/{id}
PUT https://api.apono.io/api/admin/v3/connectors/{id}
DELETE https://api.apono.io/api/admin/v3/connectors/{id}

Integrations:

Groups:

Users:

Available Access:

Access Request:

Access Session:

POST /api/admin/v1/activity-reports HTTP/1.1 Host: api.apono.io Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 542 { "name": "text", "fields": [ "text" ], "filters": { "requestor_source_ids": [ "text" ], "grantee_source_ids": [ "text" ], "grantee_identity_types": [ "text" ], "integration_ids": [ "text" ], "permission_names": [ "text" ], "resource_ids": [ "text" ], "resource_types": [ "text" ], "statuses": [ "text" ], "trigger_types": [ "text" ], "access_flow_ids": [ "text" ] }, "timeframe": { "absolute": { "start_date": "2022-03-10T16:15:50Z", "end_date": "2022-03-10T16:15:50Z" }, "relative": { "last": 1, "unit": "text", "rounded": true } }, "schedule": { "cron_expression": "text", "recipients": [ "text" ] }, "format": "text" }

{ "id": "text", "name": "text", "fields": [ "text" ], "filters": { "requestor_source_ids": [ "text" ], "grantee_source_ids": [ "text" ], "grantee_identity_types": [ "text" ], "integration_ids": [ "text" ], "permission_names": [ "text" ], "resource_ids": [ "text" ], "resource_types": [ "text" ], "statuses": [ "text" ], "trigger_types": [ "text" ], "access_flow_ids": [ "text" ] }, "timeframe": { "absolute": { "start_date": "2022-03-10T16:15:50Z", "end_date": "2022-03-10T16:15:50Z" }, "relative": { "last": 1, "unit": "text", "rounded": true } }, "schedule": { "cron_expression": "text", "recipients": [ "text" ] }, "format": "text", "creation_date": "2022-03-10T16:15:50Z", "update_date": "2022-03-10T16:15:50Z" }

PUT /api/admin/v1/activity-reports/{id} HTTP/1.1 Host: api.apono.io Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 542 { "name": "text", "fields": [ "text" ], "filters": { "requestor_source_ids": [ "text" ], "grantee_source_ids": [ "text" ], "grantee_identity_types": [ "text" ], "integration_ids": [ "text" ], "permission_names": [ "text" ], "resource_ids": [ "text" ], "resource_types": [ "text" ], "statuses": [ "text" ], "trigger_types": [ "text" ], "access_flow_ids": [ "text" ] }, "timeframe": { "absolute": { "start_date": "2022-03-10T16:15:50Z", "end_date": "2022-03-10T16:15:50Z" }, "relative": { "last": 1, "unit": "text", "rounded": true } }, "schedule": { "cron_expression": "text", "recipients": [ "text" ] }, "format": "text" }

{ "items": [ { "id": "text", "name": "text", "active": true, "trigger": "text", "requestors": { "logical_operator": "text", "conditions": [ { "source_integration_id": "text", "source_integration_name": "text", "type": "text", "match_operator": "text", "values": [ "text" ] } ] }, "request_for": { "request_scopes": [ "text" ], "grantees": { "logical_operator": "text", "conditions": [ { "source_integration_id": "text", "source_integration_name": "text", "type": "text", "match_operator": "text", "values": [ "text" ] } ] } }, "access_targets": [ { "integration": { "integration_id": "text", "integration_name": "text", "resource_type": "text", "permissions": [ "text" ], "resources_scopes": [ { "scope_mode": "text", "type": "text", "key": "text", "values": [ "text" ] } ] }, "bundle": { "bundle_id": "text", "bundle_name": "text" }, "access_scope": { "access_scope_id": "text", "access_scope_name": "text" } } ], "approver_policy": { "approval_mode": "text", "approver_groups": [ { "logical_operator": "text", "approvers": [ { "source_integration_id": "text", "source_integration_name": "text", "type": "text", "match_operator": "text", "values": [ "text" ] } ] } ] }, "grant_duration_in_min": 1, "timeframe": { "start_time": "text", "end_time": "text", "days_of_week": [ "MONDAY" ], "time_zone": "text" }, "settings": { "justification_required": true, "require_approver_reason": true, "requestor_cannot_approve_himself": true, "require_mfa": true, "labels": [ "text" ] }, "creation_date": { "0": "2", "1": "0", "2": "2", "3": "5", "4": "-", "5": "1", "6": "2", "7": "-", "8": "0", "9": "8", "10": "T", "11": "0", "12": "1", "13": ":", "14": "2", "15": "2", "16": ":", "17": "0", "18": "2", "19": ".", "20": "8", "21": "8", "22": "7", "23": "Z" }, "update_date": "text" } ], "pagination": { "next_page_token": "text" } }

Create Access Flow

post

Note: Some fields are only applicable in self-serve access flows and are ignored or not required in automatic access flows. Refer to each field’s description to understand when it applies.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequired

Display name of the access flow

activebooleanRequired

Activity state of the access flow (active or inactive)

triggerstringRequired

Event or action that triggers the access flow

request_forall of | nullableOptional

approver_policyall of | nullableOptional

grant_duration_in_mininteger · int32 | nullableOptional

Duration of access granted to the user, in minutes

timeframeall of | nullableOptional

request_for_othersbooleanRequired

Responses

200

application/json

post

/api/admin/v2/access-flows

POST /api/admin/v2/access-flows HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1179

{
  "name": "text",
  "active": true,
  "trigger": "text",
  "requestors": {
    "logical_operator": "text",
    "conditions": [
      {
        "source_integration_reference": "text",
        "type": "text",
        "match_operator": "text",
        "values": [
          "text"
        ]
      }
    ]
  },
  "request_for": {
    "request_scopes": [
      "text"
    ],
    "grantees": {
      "logical_operator": "text",
      "conditions": [
        {
          "source_integration_reference": "text",
          "type": "text",
          "match_operator": "text",
          "values": [
            "text"
          ]
        }
      ]
    }
  },
  "access_targets": [
    {
      "integration": {
        "integration_reference": "text",
        "resource_type": "text",
        "permissions": [
          "text"
        ],
        "resources_scopes": [
          {
            "scope_mode": "text",
            "type": "text",
            "key": "text",
            "values": [
              "text"
            ]
          }
        ]
      },
      "bundle": {
        "bundle_reference": "text"
      },
      "access_scope": {
        "access_scope_reference": "text"
      }
    }
  ],
  "approver_policy": {
    "approval_mode": "text",
    "approver_groups": [
      {
        "logical_operator": "text",
        "approvers": [
          {
            "source_integration_reference": "text",
            "type": "text",
            "match_operator": "text",
            "values": [
              "text"
            ]
          }
        ]
      }
    ]
  },
  "grant_duration_in_min": 1,
  "timeframe": {
    "start_time": "text",
    "end_time": "text",
    "days_of_week": [
      "MONDAY"
    ],
    "time_zone": "text"
  },
  "settings": {
    "justification_required": true,
    "require_approver_reason": true,
    "requestor_cannot_approve_himself": true,
    "require_mfa": true,
    "labels": [
      "text"
    ]
  },
  "request_for_others": true
}

200

{
  "id": "text",
  "name": "text",
  "active": true,
  "trigger": "text",
  "requestors": {
    "logical_operator": "text",
    "conditions": [
      {
        "source_integration_id": "text",
        "source_integration_name": "text",
        "type": "text",
        "match_operator": "text",
        "values": [
          "text"
        ]
      }
    ]
  },
  "request_for": {
    "request_scopes": [
      "text"
    ],
    "grantees": {
      "logical_operator": "text",
      "conditions": [
        {
          "source_integration_id": "text",
          "source_integration_name": "text",
          "type": "text",
          "match_operator": "text",
          "values": [
            "text"
          ]
        }
      ]
    }
  },
  "access_targets": [
    {
      "integration": {
        "integration_id": "text",
        "integration_name": "text",
        "resource_type": "text",
        "permissions": [
          "text"
        ],
        "resources_scopes": [
          {
            "scope_mode": "text",
            "type": "text",
            "key": "text",
            "values": [
              "text"
            ]
          }
        ]
      },
      "bundle": {
        "bundle_id": "text",
        "bundle_name": "text"
      },
      "access_scope": {
        "access_scope_id": "text",
        "access_scope_name": "text"
      }
    }
  ],
  "approver_policy": {
    "approval_mode": "text",
    "approver_groups": [
      {
        "logical_operator": "text",
        "approvers": [
          {
            "source_integration_id": "text",
            "source_integration_name": "text",
            "type": "text",
            "match_operator": "text",
            "values": [
              "text"
            ]
          }
        ]
      }
    ]
  },
  "grant_duration_in_min": 1,
  "timeframe": {
    "start_time": "text",
    "end_time": "text",
    "days_of_week": [
      "MONDAY"
    ],
    "time_zone": "text"
  },
  "settings": {
    "justification_required": true,
    "require_approver_reason": true,
    "requestor_cannot_approve_himself": true,
    "require_mfa": true,
    "labels": [
      "text"
    ]
  },
  "creation_date": {
    "0": "2",
    "1": "0",
    "2": "2",
    "3": "5",
    "4": "-",
    "5": "1",
    "6": "2",
    "7": "-",
    "8": "0",
    "9": "8",
    "10": "T",
    "11": "0",
    "12": "1",
    "13": ":",
    "14": "2",
    "15": "2",
    "16": ":",
    "17": "0",
    "18": "2",
    "19": ".",
    "20": "8",
    "21": "8",
    "22": "7",
    "23": "Z"
  },
  "update_date": "text"
}

{ "id": "text", "name": "text", "active": true, "trigger": "text", "requestors": { "logical_operator": "text", "conditions": [ { "source_integration_id": "text", "source_integration_name": "text", "type": "text", "match_operator": "text", "values": [ "text" ] } ] }, "request_for": { "request_scopes": [ "text" ], "grantees": { "logical_operator": "text", "conditions": [ { "source_integration_id": "text", "source_integration_name": "text", "type": "text", "match_operator": "text", "values": [ "text" ] } ] } }, "access_targets": [ { "integration": { "integration_id": "text", "integration_name": "text", "resource_type": "text", "permissions": [ "text" ], "resources_scopes": [ { "scope_mode": "text", "type": "text", "key": "text", "values": [ "text" ] } ] }, "bundle": { "bundle_id": "text", "bundle_name": "text" }, "access_scope": { "access_scope_id": "text", "access_scope_name": "text" } } ], "approver_policy": { "approval_mode": "text", "approver_groups": [ { "logical_operator": "text", "approvers": [ { "source_integration_id": "text", "source_integration_name": "text", "type": "text", "match_operator": "text", "values": [ "text" ] } ] } ] }, "grant_duration_in_min": 1, "timeframe": { "start_time": "text", "end_time": "text", "days_of_week": [ "MONDAY" ], "time_zone": "text" }, "settings": { "justification_required": true, "require_approver_reason": true, "requestor_cannot_approve_himself": true, "require_mfa": true, "labels": [ "text" ] }, "creation_date": { "0": "2", "1": "0", "2": "2", "3": "5", "4": "-", "5": "1", "6": "2", "7": "-", "8": "0", "9": "8", "10": "T", "11": "0", "12": "1", "13": ":", "14": "2", "15": "2", "16": ":", "17": "0", "18": "2", "19": ".", "20": "8", "21": "8", "22": "7", "23": "Z" }, "update_date": "text" }

Update Access Flow

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

namestringRequired

Display name of the access flow

activebooleanRequired

Activity state of the access flow (active or inactive)

triggerstringRequired

Event or action that triggers the access flow

request_forall of | nullableOptional

approver_policyall of | nullableOptional

grant_duration_in_mininteger · int32 | nullableOptional

Duration of access granted to the user, in minutes

timeframeall of | nullableOptional

request_for_othersbooleanRequired

Responses

200

application/json

put

/api/admin/v2/access-flows/{id}

PUT /api/admin/v2/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1179

{
  "name": "text",
  "active": true,
  "trigger": "text",
  "requestors": {
    "logical_operator": "text",
    "conditions": [
      {
        "source_integration_reference": "text",
        "type": "text",
        "match_operator": "text",
        "values": [
          "text"
        ]
      }
    ]
  },
  "request_for": {
    "request_scopes": [
      "text"
    ],
    "grantees": {
      "logical_operator": "text",
      "conditions": [
        {
          "source_integration_reference": "text",
          "type": "text",
          "match_operator": "text",
          "values": [
            "text"
          ]
        }
      ]
    }
  },
  "access_targets": [
    {
      "integration": {
        "integration_reference": "text",
        "resource_type": "text",
        "permissions": [
          "text"
        ],
        "resources_scopes": [
          {
            "scope_mode": "text",
            "type": "text",
            "key": "text",
            "values": [
              "text"
            ]
          }
        ]
      },
      "bundle": {
        "bundle_reference": "text"
      },
      "access_scope": {
        "access_scope_reference": "text"
      }
    }
  ],
  "approver_policy": {
    "approval_mode": "text",
    "approver_groups": [
      {
        "logical_operator": "text",
        "approvers": [
          {
            "source_integration_reference": "text",
            "type": "text",
            "match_operator": "text",
            "values": [
              "text"
            ]
          }
        ]
      }
    ]
  },
  "grant_duration_in_min": 1,
  "timeframe": {
    "start_time": "text",
    "end_time": "text",
    "days_of_week": [
      "MONDAY"
    ],
    "time_zone": "text"
  },
  "settings": {
    "justification_required": true,
    "require_approver_reason": true,
    "requestor_cannot_approve_himself": true,
    "require_mfa": true,
    "labels": [
      "text"
    ]
  },
  "request_for_others": true
}

200

{
  "id": "text",
  "name": "text",
  "active": true,
  "trigger": "text",
  "requestors": {
    "logical_operator": "text",
    "conditions": [
      {
        "source_integration_id": "text",
        "source_integration_name": "text",
        "type": "text",
        "match_operator": "text",
        "values": [
          "text"
        ]
      }
    ]
  },
  "request_for": {
    "request_scopes": [
      "text"
    ],
    "grantees": {
      "logical_operator": "text",
      "conditions": [
        {
          "source_integration_id": "text",
          "source_integration_name": "text",
          "type": "text",
          "match_operator": "text",
          "values": [
            "text"
          ]
        }
      ]
    }
  },
  "access_targets": [
    {
      "integration": {
        "integration_id": "text",
        "integration_name": "text",
        "resource_type": "text",
        "permissions": [
          "text"
        ],
        "resources_scopes": [
          {
            "scope_mode": "text",
            "type": "text",
            "key": "text",
            "values": [
              "text"
            ]
          }
        ]
      },
      "bundle": {
        "bundle_id": "text",
        "bundle_name": "text"
      },
      "access_scope": {
        "access_scope_id": "text",
        "access_scope_name": "text"
      }
    }
  ],
  "approver_policy": {
    "approval_mode": "text",
    "approver_groups": [
      {
        "logical_operator": "text",
        "approvers": [
          {
            "source_integration_id": "text",
            "source_integration_name": "text",
            "type": "text",
            "match_operator": "text",
            "values": [
              "text"
            ]
          }
        ]
      }
    ]
  },
  "grant_duration_in_min": 1,
  "timeframe": {
    "start_time": "text",
    "end_time": "text",
    "days_of_week": [
      "MONDAY"
    ],
    "time_zone": "text"
  },
  "settings": {
    "justification_required": true,
    "require_approver_reason": true,
    "requestor_cannot_approve_himself": true,
    "require_mfa": true,
    "labels": [
      "text"
    ]
  },
  "creation_date": {
    "0": "2",
    "1": "0",
    "2": "2",
    "3": "5",
    "4": "-",
    "5": "1",
    "6": "2",
    "7": "-",
    "8": "0",
    "9": "8",
    "10": "T",
    "11": "0",
    "12": "1",
    "13": ":",
    "14": "2",
    "15": "2",
    "16": ":",
    "17": "0",
    "18": "2",
    "19": ".",
    "20": "8",
    "21": "8",
    "22": "7",
    "23": "Z"
  },
  "update_date": "text"
}

POST /api/v1/access-flows HTTP/1.1 Host: api.apono.io Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 700 { "name": "text", "active": true, "trigger": { "type": "text", "timeframe": { "start_of_day_time_in_seconds": 1, "end_of_day_time_in_seconds": 1, "days_in_week": [ "MONDAY" ], "time_zone": "text" } }, "grantees": [ { "id": "text", "type": "text" } ], "integration_targets": [ { "integration_id": "text", "resource_type": "text", "resource_tag_includes": [ { "name": "text", "value": "text" } ], "resource_tag_excludes": [ { "name": "text", "value": "text" } ], "permissions": [ "text" ] } ], "bundle_targets": [ { "bundle_id": "text" } ], "approvers": [ { "id": "text", "type": "text" } ], "revoke_after_in_sec": 1, "settings": { "require_justification_on_request_again": true, "require_all_approvers": true, "require_approver_justification": true, "approver_cannot_approve_himself": true } }

{ "id": "text", "name": "text", "active": true, "trigger": { "type": "text", "timeframe": { "start_of_day_time_in_seconds": 1, "end_of_day_time_in_seconds": 1, "days_in_week": [ "MONDAY" ], "time_zone": "text" } }, "grantees": [ { "id": "text", "type": "text" } ], "integration_targets": [ { "integration_id": "text", "resource_type": "text", "resource_tag_includes": [ { "name": "text", "value": "text" } ], "resource_tag_excludes": [ { "name": "text", "value": "text" } ], "permissions": [ "text" ] } ], "bundle_targets": [ { "bundle_id": "text" } ], "approvers": [ { "id": "text", "type": "text" } ], "revoke_after_in_sec": 1, "settings": { "require_justification_on_request_again": true, "require_all_approvers": true, "require_approver_justification": true, "approver_cannot_approve_himself": true }, "created_date": "{seconds}.{nanos}" }

PATCH /api/v1/access-flows/{id} HTTP/1.1 Host: api.apono.io Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 700 { "name": "text", "active": true, "trigger": { "type": "text", "timeframe": { "start_of_day_time_in_seconds": 1, "end_of_day_time_in_seconds": 1, "days_in_week": [ "MONDAY" ], "time_zone": "text" } }, "grantees": [ { "id": "text", "type": "text" } ], "integration_targets": [ { "integration_id": "text", "resource_type": "text", "resource_tag_includes": [ { "name": "text", "value": "text" } ], "resource_tag_excludes": [ { "name": "text", "value": "text" } ], "permissions": [ "text" ] } ], "bundle_targets": [ { "bundle_id": "text" } ], "approvers": [ { "id": "text", "type": "text" } ], "revoke_after_in_sec": 1, "settings": { "require_justification_on_request_again": true, "require_all_approvers": true, "require_approver_justification": true, "approver_cannot_approve_himself": true } }

{ "items": [ { "id": "text", "name": "text", "type": "text", "category": "text", "connector_id": "text", "status": "text", "last_sync_time": "text", "integration_config": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "secret_store_config": { "aws": { "region": "text", "secret_id": "text" }, "gcp": { "project": "text", "secret_id": "text" }, "kubernetes": { "namespace": "text", "name": "text" }, "azure": { "vault_url": "text", "name": "text" }, "hashicorp_vault": { "secret_engine": "text", "path": "text" }, "apono": { "parameters": { "ANY_ADDITIONAL_PROPERTY": "text" } } }, "connected_resource_types": [ "text" ], "custom_access_details": "text", "owner": { "attribute_type": "text", "attribute_value": [ "text" ], "source_integration_id": "text", "source_integration_name": "text" }, "owners_mapping": { "key_name": "text", "attribute_type": "text", "source_integration_id": "text", "source_integration_name": "text" } } ], "pagination": { "next_page_token": "text" } }

Create Integration

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequired

Unique, alphanumeric, user-friendly name used to identify the integration

typestringRequired

Apono-defined identifier for the specific integration type

connector_idstring | nullableOptional

Unique identifier of the Apono connector

integration_configall ofRequired

Set of integration-specific connection and management parameters. Refer to the Integration Configuration documentation for specific configuration values.

secret_store_configall of | nullableOptional

connected_resource_typesstring[] | nullableOptional

List of discoverable resource types within the integration

custom_access_detailsstring | nullableOptional

Admin custom instructions (max 400 characters) for accessing the integration’s resources, shown to end users

ownerall of | nullableOptional

owners_mappingall of | nullableOptional

Responses

200

application/json

post

/api/admin/v4/integrations

POST /api/admin/v4/integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 635

{
  "name": "text",
  "type": "text",
  "connector_id": "text",
  "integration_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secret_store_config": {
    "aws": {
      "region": "text",
      "secret_id": "text"
    },
    "gcp": {
      "project": "text",
      "secret_id": "text"
    },
    "kubernetes": {
      "namespace": "text",
      "name": "text"
    },
    "azure": {
      "vault_url": "text",
      "name": "text"
    },
    "hashicorp_vault": {
      "secret_engine": "text",
      "path": "text"
    }
  },
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text",
  "owner": {
    "attribute_type": "text",
    "attribute_value": [
      "text"
    ],
    "source_integration_reference": "text"
  },
  "owners_mapping": {
    "key_name": "text",
    "attribute_type": "text",
    "source_integration_reference": "text"
  }
}

200

{
  "id": "text",
  "name": "text",
  "type": "text",
  "category": "text",
  "connector_id": "text",
  "status": "text",
  "last_sync_time": "text",
  "integration_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secret_store_config": {
    "aws": {
      "region": "text",
      "secret_id": "text"
    },
    "gcp": {
      "project": "text",
      "secret_id": "text"
    },
    "kubernetes": {
      "namespace": "text",
      "name": "text"
    },
    "azure": {
      "vault_url": "text",
      "name": "text"
    },
    "hashicorp_vault": {
      "secret_engine": "text",
      "path": "text"
    },
    "apono": {
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text",
  "owner": {
    "attribute_type": "text",
    "attribute_value": [
      "text"
    ],
    "source_integration_id": "text",
    "source_integration_name": "text"
  },
  "owners_mapping": {
    "key_name": "text",
    "attribute_type": "text",
    "source_integration_id": "text",
    "source_integration_name": "text"
  }
}

PUT /api/admin/v4/integrations/{id} HTTP/1.1 Host: api.apono.io Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 621 { "name": "text", "connector_id": "text", "integration_config": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "secret_store_config": { "aws": { "region": "text", "secret_id": "text" }, "gcp": { "project": "text", "secret_id": "text" }, "kubernetes": { "namespace": "text", "name": "text" }, "azure": { "vault_url": "text", "name": "text" }, "hashicorp_vault": { "secret_engine": "text", "path": "text" } }, "connected_resource_types": [ "text" ], "custom_access_details": "text", "owner": { "attribute_type": "text", "attribute_value": [ "text" ], "source_integration_reference": "text" }, "owners_mapping": { "key_name": "text", "attribute_type": "text", "source_integration_reference": "text" } }

{ "id": "text", "name": "text", "type": "text", "category": "text", "connector_id": "text", "status": "text", "last_sync_time": "text", "integration_config": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "secret_store_config": { "aws": { "region": "text", "secret_id": "text" }, "gcp": { "project": "text", "secret_id": "text" }, "kubernetes": { "namespace": "text", "name": "text" }, "azure": { "vault_url": "text", "name": "text" }, "hashicorp_vault": { "secret_engine": "text", "path": "text" }, "apono": { "parameters": { "ANY_ADDITIONAL_PROPERTY": "text" } } }, "connected_resource_types": [ "text" ], "custom_access_details": "text", "owner": { "attribute_type": "text", "attribute_value": [ "text" ], "source_integration_id": "text", "source_integration_name": "text" }, "owners_mapping": { "key_name": "text", "attribute_type": "text", "source_integration_id": "text", "source_integration_name": "text" } }

POST /api/user/v4/access-requests HTTP/1.1 Host: api.apono.io Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 201 { "bundle_reference": "text", "entitlements": [ { "resource_id": "text", "permission_id": "text" } ], "justification": "text", "duration_in_sec": 1, "custom_fields": { "ANY_ADDITIONAL_PROPERTY": "text" }, "grantee": "text" }

[ { "id": "text", "status": "text", "duration_in_sec": 1, "justification": "text", "creation_date": "text", "revocation_date": "text", "custom_fields": { "ANY_ADDITIONAL_PROPERTY": "text" }, "access_groups": [ { "integration": { "id": "text", "name": "text" }, "resource_types": [ { "id": "text", "label": "text" } ] } ], "requestor": { "id": "text", "source_id": "text" }, "grantee": { "id": "text", "source_id": "text" }, "bundle": { "id": "text", "name": "text" } } ]

API Reference

API OVERVIEW

Getting Started with the Apono API

Overview

Getting Started

Authentication

Base URL

Headers

OpenAPI Specification

Support

Next Steps

API Authentication

Generate an API Token

Use the API Token

Discovering Identity Attribute Types

New Endpoints

Why Should You Try It Out?

Key Improvements

Access Management

Improved Usability

How to Identify New Endpoints

List of New Endpoints

APONO

Activity Reports

Attributes

Groups

Access Flows

Bundles

Connectors

Users

Integrations

Access Sessions

Available Access

Delegated Access Requests

Access Requests

Access Bundles

Identities

Activity

Access Scopes

API Authentication

Generate an API Token

Use the API Token

Getting Started with the Apono API

Overview

Getting Started

Authentication

Base URL

Headers

OpenAPI Specification

Support

Next Steps

Activity Reports

Connectors

Users

Access Sessions

Available Access

Attributes

Groups

Access Bundles

Access Flows

Integrations

Activity

Bundles

Identities

Access Scopes

Access Requests

Discovering Identity Attribute Types

Delegated Access Requests

New Endpoints

Why Should You Try It Out?

Key Improvements

Access Management

Improved Usability

How to Identify New Endpoints

List of New Endpoints

List Activity Reports

Create Activity Report

Get Activity Report

Update Access Flow

Delete Activity Report