Documentation Center

Access Management API

Use the Access Management API if you want to interact with Tridion Access Management programmatically rather than through the user interface. We provide the API definition in the OpenAPI JSON format, and provide reference documentation as well.

Swagger user interface

You can use the Swagger user interface to explore the Access Management API. You can access the Swagger user interface at the following location:

https://HOST:PORT/ISHAMPROJECTSUFFIX/api/api-docs

where:

  • HOST is the hostname of the server where Access Management is installed
  • PORT is the port number to connect to the server
  • PROJECTSUFFIX is an optional unique identifier for the application

OpenAPI Specification

You can access the the OpenAPI Specification (or OAS) for the Access Management API from the following URL:

https://HOST:PORT/ISHAMPROJECTSUFFIX/api/api-docs/VERSION/openapi.json

Where:

  • HOST and PORT are as described in the preceding section
  • PROJECTSUFFIX is an optional unique identifier for the application
  • VERSION is the version of the API you are using, such as "v1".