Skip to main content

šŸ”— Upflex SCIM Integration Guide

Understanding SCIM Parameters within Upflex and the Integration Process

SCIM (System for Cross-domain Identity Management) is a standard protocol that automates user provisioning and de-provisioning between your organization’s Identity Provider (IdP) and the Upflex platform. This integration ensures streamlined user management: saving time, improving security, and reducing manual errors.

🧠 What SCIM Does

SCIM enables your IT team to:

āœ… Automatically create new users in Upflex

šŸ”„ Update user roles, teams, and attributes

āŒ Deactivate users who leave your organization

šŸ” Note: Upflex does not process passwords or any sensitive personally identifiable information (PII).

šŸ›  Step 1: Set Up the SCIM Endpoint

Upflex will generate and provide:

- A SCIM API URL

- A Credential Header for authentication

This information will be shared securely with your IT team.

šŸ“ž Step 2: SCIM Setup Call

Coordinate a call between your IT team and Upflex to:

- Walk through setup steps

- Review data fields and mapping

- Begin initial testing

If you'd like to schedule a UAT trial environment before going live, please let us know in advance—it will add some extra time to setup.

šŸ”„ What Upflex Receives (One-Way SCIM)

Upflex receives the following events:

- New user creation

- User attribute updates

- User deactivation

🚫 Upflex does NOT accept:

- Passwords

- Private or unnecessary personal data

āœ… Supported User Properties

- Attribute Description

- email User’s email address (required)

- firstName User’s first name (required)

- lastName User’s last name (required)

- upflexRole Role in Upflex: Manager or Team Admin. Default is User if not specified.

- upflexTeam Assigned team. If the team name doesn’t exist, it will be created automatically.

- department User’s department (optional; flexible value)

- costCenter User’s cost center (optional; flexible value)

āš ļø Primary Contact Role is not managed via SCIM. It must be assigned manually in the Upflex Admin Portal for security purposes.

šŸ‘„ Role Definitions

- User: Standard user with booking capabilities

- Manager: Can book spaces on behalf of others

- Team Admin: Can manage users within their team (must be assigned to a team)

šŸ‘Øā€šŸ’» Customer SCIM Setup & Testing

1. Add a test user or group in your IdP and push them to Upflex.

2. Upflex will confirm the users are received and properly mapped.

3. Conduct de-provisioning tests to ensure terminated users are removed from Upflex.

🚨 Troubleshooting & Important Notes

- Reach out to Upflex support if any user attribute mapping issues arise.

- The email address is the unique user identifier.

- If you plan to change your email domain, please notify Upflex before the change to avoid access issues.

Have questions or want to schedule your SCIM setup call?

šŸ“§ Reach out via CHAT and let them know and they get this scheduled.

Did this answer your question?