Okta SCIM Endpoint Reference for the Platform
| HTTP Method | Endpoint | Okta Action | Description & When Okta Calls It |
|---|---|---|---|
| GET | /Users?startIndex=1&count=2
|
Test Connection | Initial connectivity check. Okta sends this immediately after saving the SCIM integration to verify that the API is reachable and returns valid SCIM responses. count=2 is a constant. |
| GET | /Users?filter=userName eq "<value>"
|
Check if User Exists | Before creating a user, Okta queries by userName to determine if the user already exists. If found, Okta links to the existing user instead of creating a duplicate. |
| POST | /Users
|
Create User | Creates a new user in the Platform when a user is assigned to the SAML app in Okta. The request body includes userName, displayName, emails, active, and other mapped attributes. |
| GET | /Users/<id>
|
Read User | Retrieves a specific user by their SCIM id. Used during import and when verifying user data after updates. |
| PUT | /Users/<id>
|
Update User (AIW) | Full object replacement. AIW integrations (Method 1) always use PUT for updates. The entire user object is sent, including all attributes. Caution: if active:true is not preserved, the user may be suspended. |
| PATCH | /Users/<id>
|
Update User (OIN Template) | Partial update. OIN template integrations (Method 2) use PATCH by default. Only changed attributes are sent, reducing the risk of unintended side effects like user suspension. |
| PUT/PATCH | /Users/<id> with active:false
|
Deactivate User |
Sent when a user is unassigned from the app or deactivated in Okta. Sets Okta does NOT send a |
| GET | /Users?startIndex=<n>&count=100
|
Import Users | Paginated retrieval of all users. Used during scheduled or manual imports (Import tab → Import Now). Okta pages through results using startIndex increments of 100. |
