Outreach Capabilities
Last updated: October 8, 2024
After this article...
You'll understand the capabilities our Outreach integration provides, and how Lumos interacts with the Outreach API.
View users
The mapping between Outreach user statuses and Lumos user account statuses is below.
Outreach User Status | Lumos Account Status |
active | Active |
locked | Suspended |
deleted (Outreach no longer returns a user) | Deprovisioned |
Outreach API endpoint: https://developers.outreach.io/api/reference/tag/User/#tag/User/paths/~1users/get
View a user's entitlements
Lumos can retrieve the following user entitlements from Outreach.
Role - The work roles associated with an Outreach User.
Outreach API endpoints:
Role: https://developers.outreach.io/api/reference/tag/User/ (this data comes from the duties field)
View a user's last login
In Lumos, the Last Login value represents the last time the user logged into Outreach.
Outreach API endpoint: https://developers.outreach.io/api/reference/tag/User/ (we get the currentSignInAt value)
Suspend a user
AppStore | Offboarding | Access Reviews | License Management |
N/A | ✅ | ✅ | ✅ |
In Lumos, suspending a Outreach user marks their Account Status as "Suspended".
In Outreach, this action locks the user. This removes all licenses associated with the user and prevents them from logging in. A locked User in Outreach means the account is not active for a person/app to log into. Locked users do not count against your available number of seats for your Org.
This action reclaims a license in Outreach.
Outreach API endpoint: https://developers.outreach.io/api/reference/tag/User/ (we set the locked field to true)