Welcome to Apex IAM Onboarding
Everything you need to integrate, configure, and deploy Apex IAM successfully.
Get Started with Apex IAM
Access onboarding guides, API references, and IAM product documentation — everything you need to take your integration from first login to production.
IAM Product
Apex Web
Web portal for administrators and users.
Explore Web PortalApex Tenant
Manage organizations, configurations, roles, and policies.
Tenant SetupApex Client
Desktop client used for secure authentication and identity management.
Open Client GuideApex Mobile
Mobile app for on-the-go identity verification and secure access.
Not yet availableAPEX API Integration Manual V1.0
Availability, Performance, Experience Platform
| Documentation History | |||
|---|---|---|---|
| Date | Version | Description | Author |
| 2025-08-21 | V1.0 | APEX API Integration Manual | Darren Ong & Maisarah Ayob |
| Table of Contents | |
|---|---|
This API Integration Manual provides a brief overview and step-by-step guidance for integrating with the APEX (Availability, Performance, Experience) platform. It describes the required configuration and authentication flow for API integration, including Postman setup, OAuth 2.0 configuration, and MyDigital ID authentication to obtain an access token from the APEX Authorization Server.
This document serves as a reference guide for developers and integration teams to understand the required setup, configuration parameters, and process for successfully connecting to and testing APIs on the APEX platform.
Before proceeding with the Postman configuration, ensure the following prerequisites are completed:
Follow the steps below to configure Postman:
APEX.APEX-integration.OAuth 2.0.| Field | Value |
|---|---|
| Callback | https://oauth.pstmn.io/v1/callback |
| Auth URL | https://api.oxs-iam.com/did/authorize/ |
| Token URL | https://api.oxs-iam.com/did/token/ |
| Client ID | <PLEASE REFER TO ONBOARDING MESSAGE> |
| Secret | <PLEASE REFER TO ONBOARDING MESSAGE> |
| Scope | openid |
| Client Auth | Send client credentials in body |
https://api.oxs-iam.com/did/token/ (or the relevant endpoint).{"test":1}.| Method | Resp. | Endpoint | Parameters / Response |
|---|---|---|---|
| GET | N/A | https://api.oxs-iam.com/did/authorize/ | response_typeclient_idscoperedirect_uristate |
| N/A | 302 | https://api.oxs-iam.com/did/authorize/ | Redirects to the QR code scanning page |
| GET | N/A | <your own callback>/?code= | codestate |
| N/A | 302 | <your own callback>/?code= | Processes the code and state; refer to /token below |
| POST | N/A | https://api.oxs-iam.com/did/token/ | grant_typeredirect_uriclient_idclient_secretcode |
| N/A | 200 | https://api.oxs-iam.com/did/token/ | JSON response: access_tokentoken_typeexpires_inrefresh_expires_inrefresh_tokennot-before-policysession_statescopeid_token |
| GET | N/A | https://api.oxs-iam.com/did/logout/ | id_token_hintstatepost_logout_redirect_uri |
| N/A | 302 | https://api.oxs-iam.com/did/logout/ | Redirects to your home page (or a specified URL) upon logout |
Download Postman — https://www.getpostman.com/
Postman Collection
Import the APEX API requests straight into Postman
The APEX-Integration.postman_collection.json file is provided as part of your onboarding package. It includes the Authorize, Token, and Logout requests pre-filled with the endpoints from the API Reference.
In Postman, go to your workspace's collections sidebar and click the Import button next to the "+" (new collection) icon.
In the Import dialog, drag the downloaded JSON file anywhere onto the window — or use select files to browse to it manually.
Once imported, the APEX-Integration collection appears in your Collections list. Add the Client ID and Secret from your onboarding message to the collection's OAuth 2.0 authorization tab, then follow the steps in the Manual to request a token.
| Requests in This Collection | |||
|---|---|---|---|
| # | Request Name | Method | Status |
| 1 | Authorize | GET | ✓ Included |
| 2 | Get Token | POST | ✓ Included |
| 3 | Logout | GET | ✓ Included |
3 of 3 API requests successfully packaged in this collection.