Enterprise Edition organizations can request access to the Retrium API to allow for easier user management.
If you do not see the Retrium API section in your Administration tab, please contact your Account Manager or email us at success@retrium.com to enable it. Additional documentation will be provided once the API is enabled for your organization in Retrium.
Table of Contents
Retrium API
Prerequisites to utilize the Retrium API:
- Active Retrium Enterprise Edition subscription
- Org Admin of the organization
- Retrium API enabled for the organization from the Administration tab
The Retrium API is based on the SCIM 2.0 specification and allows for users to be:
- Created and added to organization (users are not automatically added to Team Rooms; role will be set as Org Member)
- Updated (first and last name)
- Deactivated (removed from organization)
Okta integration
If you added the Retrium app to Okta before October 1, 2022, please delete it and the new Retrium app. You will not be able to complete the setup if you use the outdated integration.
Prerequisites to utilize Retrium/Okta integration:
- Active Retrium Enterprise Edition subscription
- Org Admin of the organization
- Retrium API enabled for the organization from the Administration tab
- Okta Admin
The Retrium/Okta integration is based on the SCIM specification and allows for users to be:
- Created and added to organization (users are not automatically added to Team Rooms; role will be set as Org Member)
- Updated (first and last name)
- Deactivated (removed from organization)