Invite user

Authentication and Identity Management

Frontegg offers a comprehensive suite of authentication, user management, and security features to streamline identity management and enhance application security. This section provides an overview of all relevant API endpoints, organized into Authentication, Management, and Self-Service categories.

Authentication Endpoints: Enable secure user login, multi-factor authentication (MFA), passwordless options, and social login integrations, allowing for a flexible and robust sign-in experience.

Management Endpoints: Require environment-level authorization and provide full control over SSO (SAML and OpenID Connect) resources, user roles, permissions, and configurations. These endpoints are designed for administrative use, allowing for centralized identity and access management.

Self-Service Endpoints: Accessible with a user token (JWT), these endpoints empower users to manage their SSO connections and other account settings. Users with the necessary permissions can create, update, or delete SSO configurations directly, ensuring they have the tools to manage their access securely and independently.

Each category in this section helps you configure and extend Frontegg’s capabilities, providing the flexibility to manage user identities, authentication protocols, and access controls as per your application’s needs.

Download OpenAPI description

Users, Auth and Security

Servers

EU Region

https://api.frontegg.com/identity/

US Region

https://api.us.frontegg.com/identity/

CA Region

https://api.ca.frontegg.com/identity/

AU Region

https://api.au.frontegg.com/identity/

Frontegg sub-domain for use with user tokens

https://{domain}.frontegg.com/identity/

API token

Operations

General

Operations

MFA

Operations

Passwordless

Operations

SMS

Operations

Account invitations settings

Operations

Core settings

Operations

Data migration

Operations

Delegation

Operations

Email configuration

Operations

Email templates

Operations

M2M tokens

Operations

MFA configuration

Operations

Permissions categories

Operations

Permissions

Operations

Roles

Operations

SMS configuration

Operations

SMS templates

Operations

Sessions configuration

Operations

User pools

Operations

Users

Operations

Account invitations

Operations

Account roles

Operations

API tokens

Operations

Domain restrictions

Operations

IP restrictions

Operations

Lockout policy

Operations

Password settings

Operations

Personal tokens

Operations

Sessions management

Operations

User groups

Operations

User management

Operations

Disable user tenant

Request

This route disable a user. A disabled user cannot log in to the tenant or use the system. To disable a user, call this route and send the user’s ID as a path params.

Path

userIdstringrequired

curl -i -X POST \
  'https://api.frontegg.com/identity/resources/tenants/users/v1/{userId}/disable' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Enable user tenant

Request

This route enables a disabled user. An enabled user can log in and use the system. To enable a user, call this route and send the user’s ID as a path params.

Path

userIdstringrequired

curl -i -X POST \
  'https://api.frontegg.com/identity/resources/tenants/users/v1/{userId}/enable' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sets a permanent user to temporary

Request

This route updates the settings for temporary users, use it to enable or disable it for an environment

Path

userIdstringrequired

Bodyapplication/jsonrequired

expirationInSecondsnumber>= 300required

curl -i -X PUT \
  'https://api.frontegg.com/identity/resources/users/temporary/v1/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "expirationInSeconds": 300
  }'

Responses

Bodyapplication/json

expirationInSecondsnumber>= 300required

Response

application/json

{
  "expirationInSeconds": 300
}

Sets a temporary user to permanent

Request

This route sets an existing temporary user as permanent. Send the user’s ID as a path params.

Path

userIdstringrequired

curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/users/temporary/v1/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Gets temporary users configuration

Request

This route get the settings for temporary users, use it to check whether the policy is's enabled or disabled

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/temporary/v1/configuration \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

enabledbooleanrequired

Response

application/json

{
  "enabled": true
}

Set sub-account access for a user

Request

This route sets sub-account access for users as true or false

Path

userIdstringrequired

Bodyapplication/jsonrequired

allowAccessbooleanrequired

curl -i -X PUT \
  'https://api.frontegg.com/identity/resources/sub-tenants/users/v1/{userId}/access' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allowAccess": true
  }'

Responses

Reset user activation token

Request

This route resets the activation token for a user and triggers a new activation email being sent to the user’s email.

Bodyapplication/jsonrequired

emailstring(email)required

emailMetadataobjectrequired

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/activate/reset \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "emailMetadata": {}
  }'

Responses

Reset invitation

Request

This route resets an invitation for a user to join a specific tenant. Send the tenant’s ID in the frontegg-tenant-id header and the user's email in the POST body. It returns a new invitation link with a new token.

Headers

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired

emailstringrequired

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/invitation/reset \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "email": "string"
  }'

Responses

Reset all invitation tokens

Request

This route resets all invitation for a user to join all sub tenants which currently have invitation token. Send the tenant’s ID in the frontegg-tenant-id header and the user's email in the POST body. It returns a new invitation link with a new token.

Headers

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired

emailstringrequired

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/invitation/reset/all \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "email": "string"
  }'

Responses

Get users

Request

This route gets all users for a tenant OR environment. Send the tenant’s ID in the frontegg-tenant-id header to declare which tenant or leave it empty for all tenants' users

Query

_limitnumber

The default limit is 50 users per request, the maximum is 200

_includeSubTenantsboolean

when passing a user id, gives the option to include or not include sub tenants when searching users

Default true

_offsetnumber>= 0

_emailstring

_tenantIdstring

idsstring

_sortBystring

Enum"createdAt""name""email""id""verified""isLocked""provider""tenantId"

_orderstring

Enum"ASC""DESC"

Headers

frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

idstringrequired

emailstringrequired

namestring

profilePictureUrlstring

substringrequired

verifiedbooleanrequired

mfaEnrolledbooleanrequired

mfaBypassboolean

phoneNumberstring

providerstringrequired

tenantIdstringrequired

tenantIdsArray of stringsrequired

activatedForTenantboolean

isLockedboolean

tenantsArray of objects(UserTenantDto)required

tenants[].tenantIdstringrequired

tenants[].rolesArray of objects(RoleResponse)required

tenants[].roles[].idstringrequired

tenants[].roles[].vendorIdstringrequired

tenants[].roles[].tenantIdstringrequired

tenants[].roles[].keystringrequired

tenants[].roles[].namestringrequired

tenants[].roles[].descriptionstringrequired

tenants[].roles[].isDefaultbooleanrequired

tenants[].roles[].firstUserRolebooleanrequired

tenants[].roles[].levelnumberrequired

tenants[].roles[].createdAtstring(date-time)required

tenants[].roles[].updatedAtstring(date-time)required

tenants[].roles[].permissionsArray of stringsrequired

tenants[].temporaryExpirationDatestring(date-time)

tenants[].isDisabledboolean

invisibleboolean

superUserboolean

metadatastringrequired

vendorMetadatastringrequired

createdAtstring(date-time)required

lastLoginstring(date-time)required

subAccountAccessAllowedbooleanrequired

managedBystring

Enum"frontegg""scim2""external"

Response

application/json

{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Get users roles

Request

This route gets all users roles for a tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare which tenant.

Query

idsArray of stringsrequired

Headers

frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  'https://api.frontegg.com/identity/resources/users/v3/roles?ids=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

object(GetUserRolesResponse)

Response

application/json

{}

Get users groups

Request

This route gets all users groups for a tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare which tenant.

Query

idsArray of stringsrequired

Headers

frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  'https://api.frontegg.com/identity/resources/users/v3/groups?ids=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

object(GetUserGroupsResponse)

Response

application/json

{}

Unlock user

Request

Bodyapplication/jsonrequired

tokenstringrequired

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v3/me/unlock \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string"
  }'

Responses

Invite user

Request

This route creates a user for a specific tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare to what tenant this user is assigned. Send the user's information in the POST body. The user's email and metadata are required. The metadata can be empty, like {}.

Headers

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired

emailstring(email)required

namestring

profilePictureUrlstring<= 4095 characters

passwordstring

phoneNumberstring

providerstring

Default "local"

Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"

metadatastring

Stringified JSON object

Example: "{}"

skipInviteEmailboolean

roleIdsArray of strings

emailMetadataobject

expirationInSecondsnumber>= 300

Temporary user expiration in seconds

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v2 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "email": "user@example.com",
    "name": "string",
    "profilePictureUrl": "string",
    "password": "string",
    "phoneNumber": "string",
    "provider": "local",
    "metadata": "{}",
    "skipInviteEmail": true,
    "roleIds": [
      "string"
    ],
    "emailMetadata": {},
    "expirationInSeconds": 300
  }'

Responses

Bodyapplication/json

idstring

emailstring

verifiedboolean

namestring

profilePictureUrlstring

rolesArray of strings

permissionsArray of strings

metadatastring

createdAtstring(date-time)

lastLoginstring(date-time)

activatedForTenantboolean

temporaryExpirationDatestring(date-time)

Response

application/json

{
  "id": "string",
  "email": "string",
  "verified": true,
  "name": "string",
  "profilePictureUrl": "string",
  "roles": [
    "string"
  ],
  "permissions": [
    "string"
  ],
  "metadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "activatedForTenant": true,
  "temporaryExpirationDate": "2019-08-24T14:15:22Z"
}

Update user profile

Request

This route updates a logged-in user's profile. Send the updated values in the PUT body. Mind to use your Frontegg subdomain/custom domain as a host. A user token is required for this route. A user token can be obtained after user authentication.

Bodyapplication/jsonrequired

phoneNumberstring^\+[1-9]{1}(\-?)(([0-9])(\-?)){5,13}(([0-9]$)...

profilePictureUrlstring or null<= 4095 characters

metadatastring

Stringified JSON object

Example: "{}"

namestring

curl -i -X PUT \
  https://api.frontegg.com/identity/resources/users/v2/me \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "phoneNumber": "string",
    "profilePictureUrl": "string",
    "metadata": "{}",
    "name": "string"
  }'

Responses

Bodyapplication/json

idstringrequired

emailstringrequired

namestring

profilePictureUrlstring

substringrequired

verifiedbooleanrequired

mfaEnrolledbooleanrequired

mfaBypassboolean

phoneNumberstring

rolesArray of objects(RoleResponse)required

roles[].idstringrequired

roles[].vendorIdstringrequired

roles[].tenantIdstringrequired

roles[].keystringrequired

roles[].namestringrequired

roles[].descriptionstringrequired

roles[].isDefaultbooleanrequired

roles[].firstUserRolebooleanrequired

roles[].levelnumberrequired

roles[].createdAtstring(date-time)required

roles[].updatedAtstring(date-time)required

roles[].permissionsArray of stringsrequired

permissionsArray of objects(PermissionResponse)required

permissions[].idstringrequired

permissions[].keystringrequired

permissions[].namestringrequired

permissions[].descriptionstringrequired

permissions[].createdAtstring(date-time)required

permissions[].updatedAtstring(date-time)required

permissions[].roleIdsArray of stringsrequired

permissions[].categoryIdstringrequired

permissions[].fePermissionbooleanrequired

providerstringrequired

tenantIdstringrequired

tenantIdsArray of stringsrequired

activatedForTenantboolean

isLockedboolean

tenantsArray of objects(UserTenantDto)required

tenants[].tenantIdstringrequired

tenants[].rolesArray of objects(RoleResponse)required

tenants[].roles[].idstringrequired

tenants[].roles[].vendorIdstringrequired

tenants[].roles[].tenantIdstringrequired

tenants[].roles[].keystringrequired

tenants[].roles[].namestringrequired

tenants[].roles[].descriptionstringrequired

tenants[].roles[].isDefaultbooleanrequired

tenants[].roles[].firstUserRolebooleanrequired

tenants[].roles[].levelnumberrequired

tenants[].roles[].createdAtstring(date-time)required

tenants[].roles[].updatedAtstring(date-time)required

tenants[].roles[].permissionsArray of stringsrequired

tenants[].temporaryExpirationDatestring(date-time)

tenants[].isDisabledboolean

invisibleboolean

superUserboolean

metadatastringrequired

vendorMetadatastringrequired

createdAtstring(date-time)required

lastLoginstring(date-time)required

groupsArray of objects

subAccountAccessAllowedbooleanrequired

managedBystring

Enum"frontegg""scim2""external"

Response

application/json

{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "roles": [
    { … }
  ],
  "permissions": [
    { … }
  ],
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "groups": [
    {}
  ],
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Get user profile

Request

This route gets a logged-in user's profile. No params required. Mind to use your Frontegg subdomain/custom domain as a host. A user token is required for this route. A user token can be obtained after user authentication.

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v2/me \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

idstringrequired

emailstringrequired

namestring

profilePictureUrlstring

substringrequired

verifiedbooleanrequired

mfaEnrolledbooleanrequired

mfaBypassboolean

phoneNumberstring

rolesArray of objects(RoleResponse)required

roles[].idstringrequired

roles[].vendorIdstringrequired

roles[].tenantIdstringrequired

roles[].keystringrequired

roles[].namestringrequired

roles[].descriptionstringrequired

roles[].isDefaultbooleanrequired

roles[].firstUserRolebooleanrequired

roles[].levelnumberrequired

roles[].createdAtstring(date-time)required

roles[].updatedAtstring(date-time)required

roles[].permissionsArray of stringsrequired

permissionsArray of objects(PermissionResponse)required

permissions[].idstringrequired

permissions[].keystringrequired

permissions[].namestringrequired

permissions[].descriptionstringrequired

permissions[].createdAtstring(date-time)required

permissions[].updatedAtstring(date-time)required

permissions[].roleIdsArray of stringsrequired

permissions[].categoryIdstringrequired

permissions[].fePermissionbooleanrequired

providerstringrequired

tenantIdstringrequired

tenantIdsArray of stringsrequired

activatedForTenantboolean

isLockedboolean

tenantsArray of objects(UserTenantDto)required

tenants[].tenantIdstringrequired

tenants[].rolesArray of objects(RoleResponse)required

tenants[].roles[].idstringrequired

tenants[].roles[].vendorIdstringrequired

tenants[].roles[].tenantIdstringrequired

tenants[].roles[].keystringrequired

tenants[].roles[].namestringrequired

tenants[].roles[].descriptionstringrequired

tenants[].roles[].isDefaultbooleanrequired

tenants[].roles[].firstUserRolebooleanrequired

tenants[].roles[].levelnumberrequired

tenants[].roles[].createdAtstring(date-time)required

tenants[].roles[].updatedAtstring(date-time)required

tenants[].roles[].permissionsArray of stringsrequired

tenants[].temporaryExpirationDatestring(date-time)

tenants[].isDisabledboolean

invisibleboolean

superUserboolean

metadatastringrequired

vendorMetadatastringrequired

createdAtstring(date-time)required

lastLoginstring(date-time)required

groupsArray of objects

subAccountAccessAllowedbooleanrequired

managedBystring

Enum"frontegg""scim2""external"

Response

application/json

{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "roles": [
    { … }
  ],
  "permissions": [
    { … }
  ],
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "groups": [
    {}
  ],
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Update user

Request

This route updates a user’s information for a specific tenant. Send the frontegg-user-id and frontegg-tenant-id headers to declare which user and which tenant.

Headers

frontegg-user-idstringrequired

The user ID identifier

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired

phoneNumberstring^\+[1-9]{1}(\-?)(([0-9])(\-?)){5,13}(([0-9]$)...

profilePictureUrlstring or null<= 4095 characters

metadatastring

Stringified JSON object

Example: "{}"

namestring

curl -i -X PUT \
  https://api.frontegg.com/identity/resources/users/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -H 'frontegg-user-id: string' \
  -d '{
    "phoneNumber": "string",
    "profilePictureUrl": "string",
    "metadata": "{}",
    "name": "string"
  }'

Responses

Bodyapplication/json

idstringrequired

emailstringrequired

namestring

profilePictureUrlstring

substringrequired

verifiedbooleanrequired

mfaEnrolledbooleanrequired

mfaBypassboolean

phoneNumberstring

rolesArray of objects(RoleResponse)required

roles[].idstringrequired

roles[].vendorIdstringrequired

roles[].tenantIdstringrequired

roles[].keystringrequired

roles[].namestringrequired

roles[].descriptionstringrequired

roles[].isDefaultbooleanrequired

roles[].firstUserRolebooleanrequired

roles[].levelnumberrequired

roles[].createdAtstring(date-time)required

roles[].updatedAtstring(date-time)required

roles[].permissionsArray of stringsrequired

permissionsArray of objects(PermissionResponse)required

permissions[].idstringrequired

permissions[].keystringrequired

permissions[].namestringrequired

permissions[].descriptionstringrequired

permissions[].createdAtstring(date-time)required

permissions[].updatedAtstring(date-time)required

permissions[].roleIdsArray of stringsrequired

permissions[].categoryIdstringrequired

permissions[].fePermissionbooleanrequired

providerstringrequired

tenantIdstringrequired

tenantIdsArray of stringsrequired

activatedForTenantboolean

isLockedboolean

tenantsArray of objects(UserTenantDto)required

tenants[].tenantIdstringrequired

tenants[].rolesArray of objects(RoleResponse)required

tenants[].roles[].idstringrequired

tenants[].roles[].vendorIdstringrequired

tenants[].roles[].tenantIdstringrequired

tenants[].roles[].keystringrequired

tenants[].roles[].namestringrequired

tenants[].roles[].descriptionstringrequired

tenants[].roles[].isDefaultbooleanrequired

tenants[].roles[].firstUserRolebooleanrequired

tenants[].roles[].levelnumberrequired

tenants[].roles[].createdAtstring(date-time)required

tenants[].roles[].updatedAtstring(date-time)required

tenants[].roles[].permissionsArray of stringsrequired

tenants[].temporaryExpirationDatestring(date-time)

tenants[].isDisabledboolean

invisibleboolean

superUserboolean

metadatastringrequired

vendorMetadatastringrequired

createdAtstring(date-time)required

lastLoginstring(date-time)required

groupsArray of objects

subAccountAccessAllowedbooleanrequired

managedBystring

Enum"frontegg""scim2""external"

Response

application/json

{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "roles": [
    { … }
  ],
  "permissions": [
    { … }
  ],
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "groups": [
    {}
  ],
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Remove user

Request

This route removes a user globally or from a specific tenant. To remove the user globally, no need to send a frontegg-tenant-id. To remove the user from only a specific tenant, send the tenant’s ID in the frontegg-tenant-id header. Send the user's ID as a path params to declare which user you are removing. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Path

userIdstringrequired

Headers

frontegg-tenant-idstring

The tenant ID identifier (optional)

curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/users/v1/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Assign roles to user

Request

This route associates roles to a specific user for a specific tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare which tenant. Send the role IDs in the POST body. The role IDs need to be an array of strings. Also send the user's ID as a path params.

Path

userIdstringrequired

Headers

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired

roleIdsArray of stringsrequired

curl -i -X POST \
  'https://api.frontegg.com/identity/resources/users/v1/{userId}/roles' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "roleIds": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

tenantIdstringrequired

userIdstringrequired

rolesArray of objects(IRole)required

roles[].idstringrequired

roles[].keystringrequired

roles[].namestringrequired

roles[].descriptionstringrequired

roles[].isDefaultbooleanrequired

roles[].levelnumberrequired

roles[].createdAtstring(date-time)required

Response

application/json

{
  "tenantId": "string",
  "userId": "string",
  "roles": [
    { … }
  ]
}

Unassign roles from user

Request

This route disassociates roles from a specific user for a specific tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare which tenant. Send the role IDs in the POST body. The role IDs need to be an array of strings. Also send the user's ID as a path params.

Path

userIdstringrequired

Headers

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired

roleIdsArray of stringsrequired

curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/users/v1/{userId}/roles' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "roleIds": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

tenantIdstringrequired

userIdstringrequired

rolesArray of objects(IRole)required

roles[].idstringrequired

roles[].keystringrequired

roles[].namestringrequired

roles[].descriptionstringrequired

roles[].isDefaultbooleanrequired

roles[].levelnumberrequired

roles[].createdAtstring(date-time)required

Response

application/json

{
  "tenantId": "string",
  "userId": "string",
  "roles": [
    { … }
  ]
}

Update user's active tenant

Request

This route updates the logged in user’s tenant. The user uses it when they have multiple tenants and they want to change the current tenant they log in to. Send the frontegg-user-id and frontegg-tenant-id headers to declare which user and which tenant to update when the request is sent with a vendor token. Send the tenant ID in the PUT body.

Headers

frontegg-user-idstringrequired

The user ID identifier

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired

tenantIdstringrequired

Desired tenant to set as active tenant for user

curl -i -X PUT \
  https://api.frontegg.com/identity/resources/users/v1/tenant \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -H 'frontegg-user-id: string' \
  -d '{
    "tenantId": "string"
  }'

Responses

Bodyapplication/json

idstringrequired

emailstringrequired

namestring

profilePictureUrlstring

substringrequired

verifiedbooleanrequired

mfaEnrolledbooleanrequired

mfaBypassboolean

phoneNumberstring

rolesArray of objects(RoleResponse)required

roles[].idstringrequired

roles[].vendorIdstringrequired

roles[].tenantIdstringrequired

roles[].keystringrequired

roles[].namestringrequired

roles[].descriptionstringrequired

roles[].isDefaultbooleanrequired

roles[].firstUserRolebooleanrequired

roles[].levelnumberrequired

roles[].createdAtstring(date-time)required

roles[].updatedAtstring(date-time)required

roles[].permissionsArray of stringsrequired

permissionsArray of objects(PermissionResponse)required

permissions[].idstringrequired

permissions[].keystringrequired

permissions[].namestringrequired

permissions[].descriptionstringrequired

permissions[].createdAtstring(date-time)required

permissions[].updatedAtstring(date-time)required

permissions[].roleIdsArray of stringsrequired

permissions[].categoryIdstringrequired

permissions[].fePermissionbooleanrequired

providerstringrequired

tenantIdstringrequired

tenantIdsArray of stringsrequired

activatedForTenantboolean

isLockedboolean

tenantsArray of objects(UserTenantDto)required

tenants[].tenantIdstringrequired

tenants[].rolesArray of objects(RoleResponse)required

tenants[].roles[].idstringrequired

tenants[].roles[].vendorIdstringrequired

tenants[].roles[].tenantIdstringrequired

tenants[].roles[].keystringrequired

tenants[].roles[].namestringrequired

tenants[].roles[].descriptionstringrequired

tenants[].roles[].isDefaultbooleanrequired

tenants[].roles[].firstUserRolebooleanrequired

tenants[].roles[].levelnumberrequired

tenants[].roles[].createdAtstring(date-time)required

tenants[].roles[].updatedAtstring(date-time)required

tenants[].roles[].permissionsArray of stringsrequired

tenants[].temporaryExpirationDatestring(date-time)

tenants[].isDisabledboolean

invisibleboolean

superUserboolean

metadatastringrequired

vendorMetadatastringrequired

createdAtstring(date-time)required

lastLoginstring(date-time)required

groupsArray of objects

subAccountAccessAllowedbooleanrequired

managedBystring

Enum"frontegg""scim2""external"

Response

application/json

{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "roles": [
    { … }
  ],
  "permissions": [
    { … }
  ],
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "groups": [
    {}
  ],
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Get users with fuzzy search

Request

This route retrieves all users for a specific tenant or environment. To filter by tenant, include the tenant's ID in the frontegg-tenant-id header; otherwise, leave it empty to retrieve users from all tenants. In addition to all standard Get users query params, this route supports phrase search, allowing for complex queries using parameters such as contains, excludes, optional and approximate matching.

Query

_limitnumber

The default limit is 50 users per request, the maximum is 200

_includeSubTenantsboolean

when passing a user id, gives the option to include or not include sub tenants when searching users

Default true

_phraseSearchContainsArray of strings

Pass a list of strings, separated by comma, to search for users that contain all of the strings in the list

_phraseSearchExcludesArray of strings

Pass a list of strings, separated by comma, to search for users that do not contain any of the strings in the list

_phraseSearchOptionalArray of strings

Pass a list of strings, separated by comma, to search for users that contain at least one of the strings in the list

_phraseSearchApproximateboolean

When true, the search will be approximate (fuzzy), meaning it will include similar characters to the ones in the search string

Default false

_offsetnumber>= 0

_emailstring

_tenantIdstring

idsstring

_sortBystring

Enum"createdAt""name""email""id""verified""isLocked""provider""tenantId"

_orderstring

Enum"ASC""DESC"

Headers

frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v1/query/phrase \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

idstringrequired

emailstringrequired

namestring

profilePictureUrlstring

substringrequired

verifiedbooleanrequired

mfaEnrolledbooleanrequired

mfaBypassboolean

phoneNumberstring

providerstringrequired

tenantIdstringrequired

tenantIdsArray of stringsrequired

activatedForTenantboolean

isLockedboolean

tenantsArray of objects(UserTenantDto)required

tenants[].tenantIdstringrequired

tenants[].rolesArray of objects(RoleResponse)required

tenants[].roles[].idstringrequired

tenants[].roles[].vendorIdstringrequired

tenants[].roles[].tenantIdstringrequired

tenants[].roles[].keystringrequired

tenants[].roles[].namestringrequired

tenants[].roles[].descriptionstringrequired

tenants[].roles[].isDefaultbooleanrequired

tenants[].roles[].firstUserRolebooleanrequired

tenants[].roles[].levelnumberrequired

tenants[].roles[].createdAtstring(date-time)required

tenants[].roles[].updatedAtstring(date-time)required

tenants[].roles[].permissionsArray of stringsrequired

tenants[].temporaryExpirationDatestring(date-time)

tenants[].isDisabledboolean

invisibleboolean

superUserboolean

metadatastringrequired

vendorMetadatastringrequired

createdAtstring(date-time)required

lastLoginstring(date-time)required

subAccountAccessAllowedbooleanrequired

managedBystring

Enum"frontegg""scim2""external"

Response

application/json

{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Activate user

Request

This route activates a non-activated user. You can use it to create your own activation flow. Send the frontegg-vendor-host as a header to declare which vendor. This is your domain name in the Frontegg Portal ➜ Workspace Settings ➜ Domains ➜ Domain Name. Send the required userId and activation token in the POST body. For generating an activation token, see the route under users for generating an activation token. If the vendor's sign in flow requires a password or recaptcha, send those values in the POST body. Instead of this route, consider using our email template for user activation.

Headers

frontegg-vendor-hoststringrequired

Bodyapplication/jsonrequired

userIdstringrequired

tokenstringrequired

passwordstring

recaptchaTokenstring

lastTermsCheckstring

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/activate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-vendor-host: string' \
  -d '{
    "userId": "string",
    "token": "string",
    "password": "string",
    "recaptchaToken": "string",
    "lastTermsCheck": "string"
  }'

Responses

Bodyapplication/json

tokenTypestring

Default "bearer"

mfaRequiredbooleanrequired

mfaTokenstring

mfaEnrolledboolean

mfaDevicesobject(UserMFADevicesResponse)

mfaStrategiesobject

qrCodestring

recoveryCodestring

accessTokenstringrequired

refreshTokenstringrequired

expiresInnumberrequired

expiresstringrequired

userIdstring

userEmailstring

emailVerifiedboolean

isBreachedPasswordboolean

Response

application/json

{
  "tokenType": "bearer",
  "mfaRequired": true,
  "mfaToken": "string",
  "mfaEnrolled": true,
  "mfaDevices": {
    "webauthn": [ … ],
    "phones": [ … ],
    "authenticators": [ … ],
    "emails": [ … ]
  },
  "mfaStrategies": {},
  "qrCode": "string",
  "recoveryCode": "string",
  "accessToken": "string",
  "refreshToken": "string",
  "expiresIn": 0,
  "expires": "string",
  "userId": "string",
  "userEmail": "string",
  "emailVerified": true,
  "isBreachedPassword": true
}

Activate user with code

Request

This route activates a non-activated user. You can use it to create your own activation flow. Send the frontegg-vendor-host as a header to declare which vendor. This is your domain name in the Frontegg Portal ➜ Workspace Settings ➜ Domains ➜ Domain Name. Send the required userId, activation token and code in the POST body. For generating an activation token, see the route under users for generating an activation token. If the vendor's sign in flow requires a password or recaptcha, send those values in the POST body. Instead of this route, consider using our email template for user activation.

Headers

frontegg-vendor-hoststringrequired

Bodyapplication/jsonrequired

userIdstringrequired

tokenstringrequired

passwordstring

recaptchaTokenstring

lastTermsCheckstring

codestringrequired

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/activate/code \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-vendor-host: string' \
  -d '{
    "userId": "string",
    "token": "string",
    "password": "string",
    "recaptchaToken": "string",
    "lastTermsCheck": "string",
    "code": "string"
  }'

Responses

Bodyapplication/json

tokenTypestring

Default "bearer"

mfaRequiredbooleanrequired

mfaTokenstring

mfaEnrolledboolean

mfaDevicesobject(UserMFADevicesResponse)

mfaStrategiesobject

qrCodestring

recoveryCodestring

accessTokenstringrequired

refreshTokenstringrequired

expiresInnumberrequired

expiresstringrequired

userIdstring

userEmailstring

emailVerifiedboolean

isBreachedPasswordboolean

Response

application/json

{
  "tokenType": "bearer",
  "mfaRequired": true,
  "mfaToken": "string",
  "mfaEnrolled": true,
  "mfaDevices": {
    "webauthn": [ … ],
    "phones": [ … ],
    "authenticators": [ … ],
    "emails": [ … ]
  },
  "mfaStrategies": {},
  "qrCode": "string",
  "recoveryCode": "string",
  "accessToken": "string",
  "refreshToken": "string",
  "expiresIn": 0,
  "expires": "string",
  "userId": "string",
  "userEmail": "string",
  "emailVerified": true,
  "isBreachedPassword": true
}

Get user activation strategy

Request

This route gets a user’s activation strategy. The activation strategy tells the vendor whether the user needs to set a password. Send the required userId and activation token in the POST body. For the activation token, see the route under users for generating an activation token. The route returns a Boolean called shouldSetPassword. If it is true, the user needs to to set a password. If it is false, the user does not need to set a password. For instance, SSO users do not set passwords.

Query

userIdstringrequired

tokenstringrequired

curl -i -X GET \
  'https://api.frontegg.com/identity/resources/users/v1/activate/strategy?token=string&userId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

shouldSetPasswordbooleanrequired

Response

application/json

{
  "shouldSetPassword": true
}

Accept invitation

Request

This route accepts an invitation for a user to join a specific tenant. Send the required userId and invitation token in the POST body. The userId and invitation token appear as a query params in the url Frontegg sends to the user in the activation email.

Bodyapplication/jsonrequired

userIdstringrequired

tokenstringrequired

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/invitation/accept \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "string",
    "token": "string"
  }'

Responses

Accept invitation with code

Request

Bodyapplication/jsonrequired

userIdstringrequired

tokenstringrequired

codestringrequired

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/invitation/accept/code \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "string",
    "token": "string",
    "code": "string"
  }'

Responses

Signup user

Request

This route is for signing up a new user and new tenant. Send the frontegg-vendor-host header. This is your domain name in the Frontegg Portal ➜ Workspace Settings ➜ Domains ➜ Domain Name. Send the user's information in the POST body. The user's email, provider, companyName, and metadata are required. The provider is the authentication provider, like local, saml, google, github. See the dropdown for available values. The metadata can be empty, like {}. You also can send in the POST body additional information as shown in the example. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Headers

frontegg-vendor-hoststringrequired

frontegg-application-idstringrequired

The application id

Bodyapplication/jsonrequired

providerstringrequired

Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"

metadatastring

Stringified JSON object. Use the JSON.stringify() method.

emailstringrequired

namestring

profilePictureUrlstring<= 4095 characters

passwordstring

phoneNumberstring

skipInviteEmailboolean

roleIdsArray of strings

emailMetadataobject

companyNamestringrequired

recaptchaTokenstring

invitationTokenstring

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/signUp \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-application-id: string' \
  -H 'frontegg-vendor-host: string' \
  -d '{
    "provider": "local",
    "metadata": "string",
    "email": "string",
    "name": "string",
    "profilePictureUrl": "string",
    "password": "string",
    "phoneNumber": "string",
    "skipInviteEmail": true,
    "roleIds": [
      "string"
    ],
    "emailMetadata": {},
    "companyName": "string",
    "recaptchaToken": "string",
    "invitationToken": "string"
  }'

Responses

Response

application/json

{
  "shouldActivate": true,
  "userId": "string",
  "tenantId": "string",
  "authResponse": {
    "tokenType": "bearer",
    "mfaRequired": true,
    "mfaToken": "string",
    "mfaEnrolled": true,
    "mfaDevices": { … },
    "mfaStrategies": {},
    "qrCode": "string",
    "recoveryCode": "string",
    "accessToken": "string",
    "refreshToken": "string",
    "expiresIn": 0,
    "expires": "string",
    "userId": "string",
    "userEmail": "string",
    "emailVerified": true,
    "isBreachedPassword": true
  }
}

Get user profile

Request

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v3/me \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

idstringrequired

emailstringrequired

namestring

profilePictureUrlstring

substringrequired

verifiedbooleanrequired

mfaEnrolledbooleanrequired

mfaBypassboolean

phoneNumberstring

providerstringrequired

tenantIdstringrequired

tenantIdsArray of stringsrequired

activatedForTenantboolean

isLockedboolean

tenantsArray of objects(UserTenantDto)required

tenants[].tenantIdstringrequired

tenants[].rolesArray of objects(RoleResponse)required

tenants[].roles[].idstringrequired

tenants[].roles[].vendorIdstringrequired

tenants[].roles[].tenantIdstringrequired

tenants[].roles[].keystringrequired

tenants[].roles[].namestringrequired

tenants[].roles[].descriptionstringrequired

tenants[].roles[].isDefaultbooleanrequired

tenants[].roles[].firstUserRolebooleanrequired

tenants[].roles[].levelnumberrequired

tenants[].roles[].createdAtstring(date-time)required

tenants[].roles[].updatedAtstring(date-time)required

tenants[].roles[].permissionsArray of stringsrequired

tenants[].temporaryExpirationDatestring(date-time)

tenants[].isDisabledboolean

invisibleboolean

superUserboolean

metadatastringrequired

vendorMetadatastringrequired

createdAtstring(date-time)required

lastLoginstring(date-time)required

subAccountAccessAllowedbooleanrequired

managedBystring

Enum"frontegg""scim2""external"

Response

application/json

{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Get user tenants

Request

This route gets the list of tenants that a logged-in user belongs to. No params required. Mind to use your Frontegg subdomain/custom domain as a host. A user token is required for this route. A user token can be obtained after user authentication.

Headers

frontegg-user-idstringrequired

The user ID identifier

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v2/me/tenants \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'frontegg-user-id: string'

Responses

Bodyapplication/jsonArray [

tenantIdstringrequired

namestringrequired

]

Response

application/json

[
  {
    "tenantId": "string",
    "name": "string"
  }
]

Get user tenants' hierarchy

Request

This route gets the list of tenants with hierarchy metadata that a logged-in user belongs to. If the user is a member of several tenants in a tree some might be reduced. No params required. Mind to use your Frontegg subdomain/custom domain as a host. A user token is required for this route. A user token can be obtained after user authentication.

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v2/me/hierarchy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

object(GetUserTenantsHierarchyResponseDto)

Response

application/json

{}

Get user permissions and roles

Request

This route gets the list of permissions and roles that a logged-in user has. No params required. Mind to use your Frontegg subdomain/custom domain as a host. A user token is required for this route. A user token can be obtained after user authentication.

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v1/me/authorization \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

rolesArray of objects(RoleResponse)required

roles[].idstringrequired

roles[].vendorIdstringrequired

roles[].tenantIdstringrequired

roles[].keystringrequired

roles[].namestringrequired

roles[].descriptionstringrequired

roles[].isDefaultbooleanrequired

roles[].firstUserRolebooleanrequired

roles[].levelnumberrequired

roles[].createdAtstring(date-time)required

roles[].updatedAtstring(date-time)required

roles[].permissionsArray of stringsrequired

permissionsArray of objects(PermissionResponse)required

permissions[].idstringrequired

permissions[].keystringrequired

permissions[].namestringrequired

permissions[].descriptionstringrequired

permissions[].createdAtstring(date-time)required

permissions[].updatedAtstring(date-time)required

permissions[].roleIdsArray of stringsrequired

permissions[].categoryIdstringrequired

permissions[].fePermissionbooleanrequired

Response

application/json

{
  "roles": [
    { … }
  ],
  "permissions": [
    { … }
  ]
}

Get user tenants

Request

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v1/me/tenants \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

object(GetUserTenantsResponseDto)

Response

application/json

{}

Create userDeprecated

Request

Use the V2 route for Invite User. This route is no longer relevant.

Headers

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired

emailstring(email)required

namestring

profilePictureUrlstring<= 4095 characters

passwordstring

phoneNumberstring

providerstring

Default "local"

Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"

metadatastring

Stringified JSON object

Example: "{}"

skipInviteEmailboolean

roleIdsArray of strings

emailMetadataobject

expirationInSecondsnumber>= 300

Temporary user expiration in seconds

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "email": "user@example.com",
    "name": "string",
    "profilePictureUrl": "string",
    "password": "string",
    "phoneNumber": "string",
    "provider": "local",
    "metadata": "{}",
    "skipInviteEmail": true,
    "roleIds": [
      "string"
    ],
    "emailMetadata": {},
    "expirationInSeconds": 300
  }'

Responses

Bodyapplication/json

idstring

emailstring

verifiedboolean

namestring

profilePictureUrlstring

rolesArray of strings

permissionsArray of strings

metadatastring

createdAtstring(date-time)

lastLoginstring(date-time)

activatedForTenantboolean

temporaryExpirationDatestring(date-time)

Response

application/json

{
  "id": "string",
  "email": "string",
  "verified": true,
  "name": "string",
  "profilePictureUrl": "string",
  "roles": [
    "string"
  ],
  "permissions": [
    "string"
  ],
  "metadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "activatedForTenant": true,
  "temporaryExpirationDate": "2019-08-24T14:15:22Z"
}

User sessions

Operations

Users-applications management

Operations

Authentication and Identity Management

API token

General

MFA

Passwordless

SMS

Account invitations settings

Core settings

Custom social OAuth provider

Data migration

Delegation

Email configuration

Email templates

M2M tokens

MFA configuration

Permissions categories

Permissions

Roles

SMS configuration

SMS templates

Sessions configuration

User pools

Users

Account invitations

Account roles

API tokens

Domain restrictions

IP restrictions

Lockout policy

Password settings

Personal tokens

Sessions management

User groups

User management

Disable user tenant

Request

Responses

How useful was this page?

Enable user tenant

Request

Responses

How useful was this page?

Sets a permanent user to temporary

Request

Responses

How useful was this page?

Sets a temporary user to permanent

Request

Responses

How useful was this page?

Gets temporary users configuration

Request

Responses

How useful was this page?

Set sub-account access for a user

Request

Responses

How useful was this page?

Reset user activation token

Request

Responses

How useful was this page?

Reset invitation

Request

Responses

How useful was this page?

Reset all invitation tokens

Request

Responses

How useful was this page?

Get users

Request

Responses

How useful was this page?

Get users roles

Request

Responses

How useful was this page?

Get users groups

Request