Getting started

All Identity360 APIs require one mandatory field in the header:

• Authorization: Token for authentication request.

• Prerequisites
• HTTP methods
• General errors
• Pagination

Prerequisites

To use Identity360's API, you must meet the following prerequisites:

1. Have a valid ManageEngine Identity360 login (username and password).
2. Have an access token. Click here to learn more.

Before obtaining an access token, you need to determine the data center where your data is stored.

HTTP methods

Identity360 APIs allow data manipulation and retrieval using various HTTP methods.

HTTP status codes

Identity360 uses HTTP status codes to indicate success or failure of API calls. Status codes in the 2xx range indicate success, and codes in the 5xx range indicate server-side errors. The following table lists some commonly used HTTP status codes.

General errors

When interacting with the API, various errors may occur due to issues with the request or server. The following is a list of common error codes and their descriptions. These errors help identify the nature of the issue, allowing you to troubleshoot and resolve problems efficiently.

Error response structure

{
  "error": {
    "code": <error code>
    "detail": <error message>
    "title":  <title>
 }
}

Pagination

In Identity360, you can retrieve multiple resources using listing APIs, such as list tickets, list agents, and list departments. The process of fetching and displaying these resources on end users' screens is known as pagination.

Paginated responses are retrieved as JSON objects containing a key called data, with a JSON array of resources (objects) as the value.

Previous Topic Next Topic