Skip to content

Users

Overview

A user is someone who has logged in to XPKit using the XPKit SSO. Typically this will be either:

  • users logging into XPKit Portal to configure your XPKit installation
  • users logging into your applications

Users are assigned one or more groups which grants them access to XPKit resources.

Profiles vs users

A user is different to a profile. Profiles are used to store information about visitors to an experience whereas a user is an authenticated person who can make XPKit API calls.

A person can be represented as both a profile and user in XPKit if required.

User registration

The Auth API provides an invitation endpoint. Calling it will send an invite link to a user to register for an XPKit account. Use this if you have enabled XPKit as an authentication provider in XPKit Portal.

Please note that registration is not required when authenticating via social providers (such as Google and Apple). No invitations should be sent and you can add social login buttons directly to your apps. See the integration guide for more details.