Skip to main content
Skip table of contents

How to use the SSO User Mapping

Overview

This feature allows you to configure how users are automatically assigned roles when they are created through SSO (Single Sign-On).

Important Notes

  • This feature applies only to new user creation, not existing user updates

  • If a user's group membership changes later, their permissions will not automatically update

  • User mappings are based on attributes such as display name, tenant ID, object identifier, or groups

Step-by-Step Instructions

1. Set Up Default Mapping

  • Navigate to the SSO configuration section

  • Configure the default mapping that applies to any user who doesn't match specific criteria

  • Example default mapping: "transfer user" + "basic auth" + "SSO auth"

image-20250321-150742.png

2. Create Custom Role Mappings

  1. Select "Create another mapping"

  2. Choose which user attribute to map (options include):

    • Display name

    • Tenant ID

    • Object identifier

    • Groups

  3. Enter the specific value to match

  4. Select which role(s) to assign when this attribute matches

  5. Click "Save"

image-20250321-150847.png
image-20250321-151012.png
image-20250321-151332.png

3. Testing the Configuration

  1. Delete any test users if needed

  2. Log out of your account

  3. Click the SSO button to authenticate

  4. The system will create a new user with appropriate permissions based on your mappings

  5. Verify the user creation timestamp and assigned roles

4. Understanding Role Assignment Logic

  • Users can receive multiple sets of permissions if they match multiple mapping criteria

  • The default mapping applies to all users, plus any specific mappings they match

  • Example: A user matching a custom mapping for "instance admin" will receive both those permissions and the default "transfer user" permissions

5. Troubleshooting

  • If SAML is not configured for a customer code, you will receive an error message

  • Check the Admin section to verify user creation timestamps and assigned roles

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.