Inviting Users

This guide covers how to implement user invitations within Descope. Descope provides several mechanisms to invite users with customization options and templates for invitations.

User Invitation Settings

Configure user invitations in the Project Settings page under the Sign Ups and User Invitations section. Refer to the Project Settings doc for more information.

Invitation Expiration

When enabled, user invitations will automatically expire if not accepted within a configured time period. This helps maintain security by ensuring invitations are not left open indefinitely and provides better control over your user onboarding process.

How It Works

  1. Enable Expiration: In Project Settings, enable the Invite Expiration option under Sign Ups and User Invitations.

  2. Set Expiration Period: Configure the expiration period in hours, days, or weeks. The default is typically 1 week.

  3. Invitation Status Changes: When an invitation expires:

    • The user's status automatically changes from Invited to Invite Expired
    • The user cannot log in with the expired invitation
    • Any Magic Link tokens included in the invitation are also invalidated
  4. Re-inviting Expired Users: Users with expired invitations can be re-invited, which:

    • Resets their status back to Invited
    • Restarts the expiration timer
    • Sends a new invitation email/SMS
    • Invalidates any previous Magic Link tokens

If your invitation includes a Magic Link token (configured in Project Settings), the Magic Link expiration should always be equal to or shorter than the invitation expiration period.

User Lifecycle with Expiration

The invitation expiration feature introduces an additional user state. Users can transition between states as follows:

  • InvitedActive: When the user accepts the invitation and signs in before expiration
  • InvitedInvite Expired: When the configured expiration period passes without the user signing in
  • Invite ExpiredInvited: When an administrator re-invites the user
  • Active: Once a user becomes active, any related invitations and Magic Links are automatically expired

For more information on user states, see the User Lifecycle documentation.

Invitation Templates

When using a custom messaging connector instead of the Descope system connector, you can create custom templates for user invitations.

Invitation Methods

Descope Console

On the User Management page of the Descope Console, you can invite users individually or in bulk. You can define the following in the user invite:

  • Login IDs: Enter one or more login IDs (emails or phone numbers) for invited users
  • User Attributes: Add details for the user(s). Can include name, email, phone, and any custom attributes
  • Authorization: Define user access to tenants, and assign project and tenant-level roles. Additionally, you can define access to federated apps.
  • User Invitations: Determine whether or not to send an invitation to the user(s). This will use the messaging template configured in Project Settings.

When using bulk invite, the user information you input will be applied to all users with each login ID you set. If you need to provide different information for each user, you will have to add all users without any information and then modify each user in the user table afterwards.

To create users with multiple login IDs, select Add as Login Id when adding an email or phone number under user attributes

Invite Users from Console

Re-inviting Users

You can resend invitations to users in the following scenarios:

  • Users who have lost the original invitation email/SMS
  • Users whose invitations have expired (status: Invite Expired)
  • Users who need a fresh Magic Link token

To re-invite a user:

  1. Navigate to the Users Page of the Descope Console
  2. Click the three dots menu next to the user
  3. Select the Resend Invitation option

When you re-invite a user:

  • Their status is reset to Invited (if it was Invite Expired)
  • The invitation expiration timer restarts
  • A new invitation email/SMS is sent
  • Any previous Magic Link tokens are invalidated

The Resend Invitation option is only available for users with Invited or Invite Expired status. Active users cannot be re-invited.

Re-invite users

Descope Flows

To learn how to invite users within a Flow, refer to our User Invite Flow Action Doc

Management SDK

You can invite users programmatically using the Descope Management SDK.

Was this helpful?

On this page