Admin Console APIs

Introduction

Admin Console API is a REST API and provides capabilies at platform level. Requests and responses are in JSON notation.

API documentation as Swagger

A detailed API description is also available as Swagger UI. Refer here to get the reference of Swagger UI.

---

Host URL for Optima Gateway environments will be as given below:

Environment	{host-url}
Dev	optima-dev.optumrx.com/admin-console

---

Endpoints

Get Users

This API is used to get users for the particular instance.

GET - https://{host-url}//admin-console/v2/getUsers

Response:

{
  "id": "string",
  "username": "string",
  "name": "string",
  "mail": "string",
}

Get user roles by Id

This API is used to get user roles based on the Id. i.e. the user is having access to which modules.

GET - https://{host-url}//admin-console/v2/getUserRolesById/{GetuserId}

Provide the Id in the query, which you received from the Get user API Response.

Response:

  {
    "userId": "String",
    "moduleDetails": {
        "Tasklist": "Boolean",
        "Operate": "Boolean",
        "Identity": "Boolean",
        "Optimize": "Boolean"
    }

}

Update User Roles

This API is used to update the user roles for the particular User Id. i.e. Roles or access to the modules can be revoked and granted based on the user Id.

POST - https://{host-url}/admin-console/v2/updateUserRoles

Request Body:

{
    "userId": "String",
    "toBeRevokedModules": ["Module Name"],
    "toBeGrantedModules": []
}

Response:

{
    "message": "Successfully Updated User Roles"
}

Get Unified Clients

This API is used to get the list of Unified clients.

GET - https://{host-url}//admin-console/v2/getUnifiedClients.

Response:

{
  {
        "id": "string",
        "clientId": "string",
        "name": "string",
        "description": "string"
    },
    {
        "id": "string",
        "clientId": "string",
        "name": "string",
        "description": "string"
    }
}

Get Application details by Id

This API is used to cancel an existing process instance by processInstanceKey.

GET - https://{host-url}/admin-console/v2/getApplicationDetailsById/{Unified Client Id}

Provide Unified Client Id in the query to get the Application details.

Response:

{
    "realmId": "string",
    "unifiedClientId": "string",
    "apiDetails": {
        "GET/operate/v2/process-definitions/key": true,
        "GET/zeebe/v2/cancel-process-instance/processInstanceKey": true,
        "POST/operate/v2/process-definitions/search": true,
        "GET/operate/v2/flownode-instances": false,
    }
}

Update Application Details

This API is used to get the zeebe cluster topology, which gives the result regarding the zeebe broker's leaders and followers.

PUT - https://{host-url}/admin-console/v2/updateApplicationDetails

Request:

{
    "realmId": "string",
    "unifiedClientId": "string",
    "toBeRevokedApis": ["api to be revoked"],
    "toBeGrantedApis": []
}

e.g.

{
    "realmId": "optima-internal",
    "unifiedClientId": "optima-client-1",
    "toBeRevokedApis": [],
    "toBeGrantedApis": ["POST/tasklist/v2/tasks/search"]
}

Response:

{
    "message": "Successfully Updated Application Roles"
}