ARM web API documentation
Overview
The ARM application provides a comprehensive REST API for managing access rights, workflows, user accounts, and resources across Active Directory and other technology platforms. This document describes all available API endpoints, their parameters, and usage examples.
API Version Compatibility
The following table shows the availability of API endpoints across different ARM versions:
|
Endpoint |
Method |
Version 7.1 |
Version 7.5 |
Version 7.6 |
Version 8.0+ |
Version 9.0.737+ |
|---|---|---|---|---|---|---|
|
/Session/login |
GET |
✓ |
✓ |
✓ |
Deprecated |
Deprecated |
|
/api/v1/session/login |
POST |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/AccountRead/GetAccounts |
GET |
✓ |
✓ |
✓ |
Deprecated |
Deprecated |
|
/api/v1/account |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/account/all |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/account/parents |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/Configuration/GroupWizard |
GET |
✓ |
✓ |
✓ |
Deprecated |
Deprecated |
|
/api/v1/config/groupwizard |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/Cockpit |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/orders/GetAllOrders |
GET |
✗ |
✗ |
✓ |
✓ |
✓ |
|
/api/v1/orders/GetAllOrdersPaged |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/orders/SubmitOrder |
POST |
✗ |
✗ |
✓ |
✓ |
✓ |
|
/api/v1/orders/ApproveOrderItems |
POST |
✗ |
✗ |
✓ |
✓ |
✓ |
|
/api/v1/orders/RejectOrderItems |
POST |
✗ |
✗ |
✓ |
✓ |
✓ |
|
/api/v1/Workflow/GetWorkflows |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/Workflow/InsertWorkflow |
POST |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/Workflow/UpdateWorkflow |
PUT |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/Resources/Roots |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/Resources/Children |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/Analyze/Scenarios |
GET |
✗ |
✗ |
✗ |
✗ |
✓ |
|
/api/v1/Recertification/Resources |
GET |
✗ |
✗ |
✗ |
✗ |
✓ |
|
/api/v1/alert |
GET |
✗ |
✗ |
✗ |
✗ |
✓ |
|
/api/v1/Profiles |
GET |
✗ |
✗ |
✗ |
✓ |
✓ |
|
/api/v1/TimeLine/Events |
POST |
✗ |
✗ |
✗ |
✗ |
✓ |
Legend: - ✓ = Available - ✗ = Not Available - Deprecated = Available but deprecated, use newer endpoint