LogoLogo
API Reference
API Reference
  • API OVERVIEW
    • Getting Started with the Apono API
    • API Authentication
  • New Endpoints
  • APONO
    • Groups
    • Access Flows
    • Bundles
    • Connectors
    • Users
    • Integrations
    • Access Sessions
    • Available Access
    • Access Requests
    • Access Bundles
    • Identities
    • Activity
    • Access Scopes
Powered by GitBook
On this page
  • Why Should You Try It Out?
  • Key Improvements
  • How to Identify New Endpoints
  • List of New Endpoints

Was this helpful?

Export as PDF

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:

  • GET https://api.apono.io/api/admin/v2/access-flows

  • POST https://api.apono.io/api/admin/v2/access-flows

  • GET https://api.apono.io/api/admin/v2/access-flows/{id}

  • PUT https://api.apono.io/api/admin/v2/access-flows/{id}

  • DELETE https://api.apono.io/api/admin/v2/access-flows/{id}

Bundles:

  • GET https://api.apono.io/api/admin/v2/bundles

  • POST https://api.apono.io/api/admin/v2/bundles

  • GET https://api.apono.io/api/admin/v2/bundles/{id}

  • PUT https://api.apono.io/api/admin/v2/bundles/{id}

  • DELETE https://api.apono.io/api/admin/v2/bundles/{id}

Access Scopes:

  • GET https://api.apono.io/api/admin/v1/access-scopes

  • POST https://api.apono.io/api/admin/v1/access-scopes

  • GET https://api.apono.io/api/admin/v1/access-scopes/{id}

  • PUT https://api.apono.io/api/admin/v1/access-scopes/{id}

  • DELETE https://api.apono.io/api/admin/v1/access-scopes/{id}

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:

  • GET https://api.apono.io/api/admin/v4/integrations

  • POST https://api.apono.io/api/admin/v4/integrations

  • GET https://api.apono.io/api/admin/v4/integrations/{id}

  • PUT https://api.apono.io/api/admin/v4/integrations/{id}

  • DELETE https://api.apono.io/api/admin/v4/integrations/{id}

Groups:

  • GET https://api.apono.io/api/admin/v1/groups

  • POST https://api.apono.io/api/admin/v1/groups

  • GET https://api.apono.io/api/admin/v1/groups/{id}

  • DELETE https://api.apono.io/api/admin/v1/groups/{id}

  • GET https://api.apono.io/api/admin/v1/groups/{id}/members

  • PUT https://api.apono.io/api/admin/v1/groups/{id}/members

  • PUT https://api.apono.io/api/admin/v1/groups/{id}/members/{email}

  • DELETE https://api.apono.io/api/admin/v1/groups/{id}/members/{email}

  • PUT https://api.apono.io/api/admin/v1/groups/{id}/name

Users:

  • GET https://api.apono.io/api/admin/v3/users

  • GET https://api.apono.io/api/admin/v3/users/{id}

Available Access:

  • GET https://api.apono.io/api/user/v1/available-access/bundles

  • GET https://api.apono.io/api/user/v1/available-access/entitlements

Access Request:

  • GET https://api.apono.io/api/user/v4/access-requests

  • POST https://api.apono.io/api/user/v4/access-requests

  • GET https://api.apono.io/api/user/v4/access-requests/{id}

  • GET https://api.apono.io/api/user/v4/access-requests/{id}/entitlements

  • POST https://api.apono.io/api/user/v4/access-requests/{id}/request-again

  • POST https://api.apono.io/api/user/v4/access-requests/{id}/revoke

Access Session:

  • GET https://api.apono.io/api/user/v1/access-sessions

  • GET https://api.apono.io/api/user/v1/access-sessions/{id}

  • GET https://api.apono.io/api/user/v1/access-sessions/{id}/access-details

  • POST https://api.apono.io/api/user/v1/access-sessions/{id}/reset-credentials

PreviousAPI AuthenticationNextGroups

Last updated 9 days ago

Was this helpful?