7a02e83c featured anyx admin conceptsapi and automation

API and automation

CONTACT

Agilicus AnyX is built on an API, and everything you do in the portal can be automated. The portal gives you the credentials and reference material to do that.

API keys

An API key is a credential that identifies an automated client to the Agilicus API. You create keys in the portal (see API keys) and use them in scripts, integrations, and SDK-based applications. Keys should be treated like passwords:

  • keep them secret (see the web guide’s Protect your API key (and your credit rating));
  • give each key a name that tells you what it is for;
  • revoke keys you no longer use; and
  • never embed keys in client-side code or public repositories.

Command-line access

You can interact with the API from the command line. The web guide’s Command-line API access shows the standard tooling and patterns, including how to sign in and how to read and write objects.

SDKs

Official SDKs are available for:

  • Python;
  • TypeScript (standard); and
  • TypeScript (Angular), which the portal itself uses.

The SDKs wrap the API so your code can manage organisations, users, groups, resources, policies, and audit data with type-safe calls.

What you can automate

Almost everything in the portal is available through the API, including:

  • user, group, and service-account management;
  • resource creation and configuration;
  • permission and policy assignment;
  • audit and metrics retrieval; and
  • connector and billing information.

This makes it possible to provision new users or resources automatically as part of your own workflows, or to synchronise identity data from your systems.

See also

Web guide