Overview

This article explains how administrators can utilize PostBeyond's API to automate the archiving of inactive users, particularly when they are deactivated in an organization's Active Directory. It outlines the steps to request API access through a Customer Success Manager (CSM), including the necessary information to provide and the importance of GDPR compliance. Additionally, it offers resources for further assistance.

Information

How to Automatically Archive Users with APIs

As an administrator, you are tasked with creating content, managing users, and ensuring the success of your program. It can be challenging to monitor which users are active on your platform and determine which accounts should be archived from your company's PostBeyond platform. This is where APIs become valuable. By leveraging our API, you can automate the process of archiving users from your PostBeyond site when they are deactivated in your Active Directory. For instance, when an individual leaves the organization and their SSO is deactivated, they also lose access to company tools, including PostBeyond.

How to Request APIs

Please reach out to your Customer Success Manager (CSM) and share the following information with them:

Tool

What is the name of the tool you are leveraging for team management or Active Directory?

Desired Outcome

What exactly do you want to achieve with the API in terms of archiving or de-provisioning users from your company's PostBeyond platform? For example, "I want my users to be archived in PostBeyond when they are no longer with the organization."

3rd Party Software Contact (if applicable)

This isn’t always necessary, but if you are working with a team at the software you're trying to integrate with PostBeyond, feel free to introduce us so we can communicate directly with them.

Information and Security Contact at Your Company

We require an email address when any customer is leveraging our APIs to ensure we stay GDPR compliant.

Your CSM will follow up with the relevant API documentation for your IT team to review for implementation.

Helpful Resources

FAQ

How can I automate the archiving of users on PostBeyond?

You can automate the archiving of users by leveraging PostBeyond's API, which can be set up to archive users from your PostBeyond site when they are deactivated in your Active Directory.

What information do I need to provide to request API access?

You need to provide the name of the tool you use for team management or Active Directory, the desired outcome you wish to achieve with the API, any third-party software contact details if applicable, and an information and security contact at your company to ensure GDPR compliance.

Who should I contact to get started with using PostBeyond's API for user archiving?

You should reach out to your Customer Success Manager (CSM) with the required information to get the relevant API documentation and begin the implementation process.