{ "opencollection": "1.0.0", "info": { "name": "Authentication and Identity Management", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "API Token", "type": "folder" }, "items": [ { "info": { "name": "Authenticate Using API Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v2/api-token", "body": { "type": "json", "data": "{}" } }, "docs": "Authenticates using an account (tenant) or user API token. Obtain your `clientId` and `secret` from Admin Portal → API Tokens, then provide them in the request body. Send the request to your Frontegg environment (e.g., `https://.frontegg.com`).\n\n**Note:** By default, this endpoint enforces refresh token rotation. Each API token is limited to 100 active refresh tokens. When authenticating with the same API token for the 101st time, the oldest refresh token is automatically invalid" }, { "info": { "name": "Refresh API Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v2/api-token/token/refresh", "body": { "type": "json", "data": "{}" } }, "docs": "Refreshes a JWT access token using a refresh token. If the refresh token is valid, returns a new JWT and refresh token pair. This maintains an authenticated session without requiring the user to log in again.\n\nIf the refresh token is invalid, expired, or has been revoked due to rotation limits, the request will fail with an authentication error." } ] }, { "info": { "name": "API Tokens", "type": "folder" }, "items": [ { "info": { "name": "Get Account (tenant) Access Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/tenants/access-tokens/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve all access tokens for a specific account (tenant)." }, { "info": { "name": "Create Account (tenant) Access Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/access-tokens/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an access token for a specific account (tenant)." }, { "info": { "name": "Delete Account (tenant) Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/tenants/access-tokens/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an account (tenant) access token." }, { "info": { "name": "Get Client Credentials Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/tenants/api-tokens/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve all API tokens for a specific account (tenant)." }, { "info": { "name": "Create Client Credentials Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/api-tokens/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Do not use. Instead, use v2 of this route." }, { "info": { "name": "Update Client Credentials Token", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/tenants/api-tokens/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an account (tenant) API token." }, { "info": { "name": "Delete Client Credentials Token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/tenants/api-tokens/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an account (tenant) API token." }, { "info": { "name": "Create Client Credentials Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/api-tokens/v2", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an account (tenant) API token.\n\nYou can retrieve roles and permissions via the API." } ] }, { "info": { "name": "Account Invitations", "type": "folder" }, "items": [ { "info": { "name": "Get Account (tenant) Invite of User", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1/user", "headers": [ { "name": "frontegg-user-id", "value": "" }, { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve an invitation for a specific user to join an account (tenant)." }, { "info": { "name": "Create Account (tenant) Invite for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1/user", "headers": [ { "name": "frontegg-user-id", "value": "" }, { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an invitation for a specific user to join an account (tenant).\n\nTo create a general invitation, use the general invitation route." }, { "info": { "name": "Update Account (tenant) Invite of User", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1/user", "headers": [ { "name": "frontegg-user-id", "value": "" }, { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an invitation for a specific user to join an account (tenant).\n\nTo set a specific expiration time, use the `expiresInMinutes` parameter to define when the invitation will be invalidated. Use the `shouldSendEmail` Boolean parameter to control whether an invitation email is sent.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Delete Account (tenant) Invite of User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1/user", "headers": [ { "name": "frontegg-user-id", "value": "" }, { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Delete an invitation for a specific user to join an account (tenant).\n\nTo delete a general invitation, use the general invitation route." }, { "info": { "name": "Verify Account (tenant) Invite", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verify an account (tenant) invitation.\n\nPass the invitation token as the `token` parameter.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Get Account (tenant) Invite Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1/configuration" }, "docs": "Check whether account (tenant) invitations are enabled and whether notifications are active for your environment.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Create Tenant Invite with Roles for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v2/user", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an invitation with assigned roles for a specific user to join an account (tenant). Provide the user's ID via the `frontegg-user-id` header and the account ID via the `frontegg-tenant-id` header. For general invitations without a specific user, use the general invitation endpoint instead." } ] }, { "info": { "name": "Account Invitations Settings", "type": "folder" }, "items": [ { "info": { "name": "Create Account (tenant) Invite", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Create a general or account (tenant)-specific invitation token.\n\nUse this endpoint to generate invitation tokens for accounts (tenants) or individual users.\n\nTo create a general invitation token, send the request without specifying an account (tenant) or user. To create an account (tenant)-specific token, include the account (tenant) ID in the request body. To create a token for a specific user of an account (tenant), also include the user ID in the body parameters. If a user ID is provided, you" }, { "info": { "name": "Get All Account (tenant) Invites", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1/all" }, "docs": "Retrieve all invitation tokens across all accounts (tenants).\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Delete an Account (tenant) Invite", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/tenants/invites/v1/token/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an invitation for an account (tenant) using the invitation ID.\n\nUse this endpoint to delete a specific invitation by providing its invitation ID as a path parameter. You can obtain the invitation ID via the **Get all account (tenant) invites** API.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Get Activation Strategies", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/activation/strategies" }, "docs": "Get Activation Strategies" }, { "info": { "name": "Create or Update Activation Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/activation/strategies", "body": { "type": "json", "data": "{}" } }, "docs": "Create or Update Activation Strategy" }, { "info": { "name": "Get Invitation Strategies", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/invitation/strategies" }, "docs": "Get Invitation Strategies" }, { "info": { "name": "Create or Update Invitation Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/invitation/strategies", "body": { "type": "json", "data": "{}" } }, "docs": "Create or Update Invitation Strategy" } ] }, { "info": { "name": "Account Roles", "type": "folder" }, "items": [ { "info": { "name": "Get Roles V2", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/roles/v2", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query" }, { "name": "_sortBy", "value": "", "type": "query" }, { "name": "_levels", "value": "", "type": "query" }, { "name": "_tenantIds", "value": "", "type": "query" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_order", "value": "", "type": "query" }, { "name": "_filter", "value": "", "type": "query" } ] }, "docs": "Retrieve all roles for your environment.\n\nEach role object includes the name, permissions, and other defining information." }, { "info": { "name": "Create a New Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/roles/v2", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new role for a specific account (tenant).\n\nInclude the required permissions in the request body to customize the role." }, { "info": { "name": "Get Distinct Levels of Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/roles/v2/distinct-levels", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve all role levels for your environment." }, { "info": { "name": "Get Distinct Assigned Accounts (tenants) of Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/roles/v2/distinct-tenants" }, "docs": "Retrieve all assigned account (tenant) IDs from roles for your environment." } ] }, { "info": { "name": "Approval Flows", "type": "folder" }, "items": [ { "info": { "name": "Get Approval Flows", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1" }, "docs": "Get Approval Flows" }, { "info": { "name": "Create Approval Flow", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Create Approval Flow" }, { "info": { "name": "Get Approval Flow by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Approval Flow by ID" }, { "info": { "name": "Update Approval Flow", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Approval Flow" }, { "info": { "name": "Delete Approval Flow", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete Approval Flow" }, { "info": { "name": "Approver Action", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1/approver-action", "body": { "type": "json", "data": "{}" } }, "docs": "Approver Action" }, { "info": { "name": "Get Approval Flow Execution Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1/execution-data", "params": [ { "name": "approvalFlowExecutionId", "value": "", "type": "query" }, { "name": "approverId", "value": "", "type": "query" }, { "name": "approvalFlowStepId", "value": "", "type": "query" } ] }, "docs": "Get Approval Flow Execution Data" }, { "info": { "name": "Execute Approval Flow", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1/:id/execute", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Execute Approval Flow" }, { "info": { "name": "Execute Step up Approval Flow", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/approval-flows/v1/step-up/execute", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Execute Step up Approval Flow" } ] }, { "info": { "name": "Core Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Identity Management Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1" }, "docs": "Retrieve the identity management configuration for your environment.\n\nUse this endpoint to get the current identity management settings configured in your environment." }, { "info": { "name": "Update Identity Management Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Update the identity management configuration for your environment.\n\nUse this endpoint to add or update identity management parameters by sending the desired values in the request body.\n\nRefer to the parameter documentation for the list of supported values." }, { "info": { "name": "Get Captcha Policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/captcha-policy" }, "docs": "Retrieve the CAPTCHA policy for your environment.\n\nThe response includes the policy ID, `siteKey`, `secretKey`, `minimumScore`, list of ignored emails, and whether the policy is enabled." }, { "info": { "name": "Create Captcha Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/captcha-policy", "body": { "type": "json", "data": "{}" } }, "docs": "Create a CAPTCHA policy for all accounts (tenants).\n\nProvide the required settings in the request body. To enable the policy, set the `enabled` parameter to `true`, and provide the `siteKey` and `secretKey` obtained from reCAPTCHA. You can also set the `minimumScore` parameter to a value between `0` and `1` to define the minimum score threshold." }, { "info": { "name": "Update Captcha Policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/configurations/v1/captcha-policy", "body": { "type": "json", "data": "{}" } }, "docs": "Update the CAPTCHA policy for all accounts (tenants).\n\nProvide the desired settings in the request body. To enable the policy, set the `enabled` parameter to `true`, and provide the `siteKey` and `secretKey` obtained from reCAPTCHA. You can also set the `minimumScore` parameter to a value between `0` and `1` to define the minimum score threshold." }, { "info": { "name": "Get JWT Template Targeting Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/jwt-template-targeting" }, "docs": "Retrieves the JWT template targeting configuration for your environment. Note: This feature must be enabled by request." }, { "info": { "name": "Create JWT Template Targeting Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/jwt-template-targeting", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new JWT template targeting configuration for your environment. Note: This feature must be enabled by request." }, { "info": { "name": "Update or Create JWT Template Targeting Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/configurations/v1/jwt-template-targeting", "body": { "type": "json", "data": "{}" } }, "docs": "Updates or creates a JWT template targeting configuration for your environment. Note: This feature must be enabled by request." }, { "info": { "name": "Update JWT Template Targeting Configuration by ID", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/configurations/v1/jwt-template-targeting/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific JWT template targeting configuration by ID. Note: This feature must be enabled by request." }, { "info": { "name": "Delete JWT Template Targeting Configuration by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/configurations/v1/jwt-template-targeting/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes a specific JWT template targeting configuration by ID. Note: This feature must be enabled by request." }, { "info": { "name": "Get All JWT Templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/jwt-templates/v1", "params": [ { "name": "keys", "value": "", "type": "query", "description": "Filter by template keys" }, { "name": "ids", "value": "", "type": "query", "description": "Filter by template IDs" }, { "name": "_limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_sortBy", "value": "", "type": "query", "description": "Field to sort by" }, { "name": "_order", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Retrieves all JWT templates for your environment. Note: This feature must be enabled by request." }, { "info": { "name": "Create JWT Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/jwt-templates/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new JWT template for your environment. Note: This feature must be enabled by request." }, { "info": { "name": "Get JWT Template by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/jwt-templates/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieves a specific JWT template by ID. Note: This feature must be enabled by request." }, { "info": { "name": "Update JWT Template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/jwt-templates/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing JWT template. Note: This feature must be enabled by request." }, { "info": { "name": "Delete JWT Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/jwt-templates/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes an existing JWT template. Note: This feature must be enabled by request." }, { "info": { "name": "Get Identity Management Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/basic" }, "docs": "Retrieve the identity management configuration for your environment." } ] }, { "info": { "name": "Custom Social OAuth Provider", "type": "folder" }, "items": [ { "info": { "name": "Get Custom Oauth Provider", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/sso/custom/v1" }, "docs": "Retrieve the custom social login providers configured in your environment." }, { "info": { "name": "Create Custom Oauth Provider", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/sso/custom/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Create a custom social login provider using the OAuth details of the identity provider.\n\nProvide the required OAuth parameters in the request body." }, { "info": { "name": "Update Custom Oauth Provider", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/sso/custom/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a custom social login provider in your environment by ID.\n\nProvide the ID of the custom social login provider and the desired OAuth parameters in the request body." }, { "info": { "name": "Delete Custom Oauth Provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/sso/custom/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a custom social login provider in your environment by ID.\n\nProvide the ID of the custom social login provider to delete." } ] }, { "info": { "name": "Data Migration", "type": "folder" }, "items": [ { "info": { "name": "Migrate From Auth0", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/migrations/v1/auth0", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate users from Auth0 into your environment.\n\nProvide the `domain`, `clientId`, `secret`, and `tenantIdFieldName` parameters in the request body. These values can be obtained from your Auth0 account (tenant) configuration." }, { "info": { "name": "Migrate a Single User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/migrations/v1/local", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate a user into your environment.\n\nProvide the required fields: user's email, `tenantId`, and metadata. You can also include additional properties such as the user's name, phone number, hashed password, and other optional attributes." }, { "info": { "name": "Migrate Users in Bulk", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/migrations/v1/local/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate users in bulk into your environment.\n\nProvide an array of `users` in the request body. Each user object must include the user's `email` and `tenantId`, which specifies the user's parent account. You can include additional fields as needed to store more information. If you need to store custom data, use the `metadata` property." }, { "info": { "name": "Check Status of Bulk Migration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/migrations/v1/local/bulk/status/:migrationId", "params": [ { "name": "migrationId", "value": "", "type": "path" } ] }, "docs": "Retrieve the status of a pending or completed migration.\n\nThe response includes the migration's `state`, the number of migrated users, and any errors that occurred during the migration. The response payload is limited to 1,000 users." }, { "info": { "name": "Migrate Vendor Users in Bulk", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/migrations/v2/local/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate users in bulk to your environment. Provide an array of user objects, each containing `email` and `tenantId`. Use the `metadata` property to store custom information for each user." } ] }, { "info": { "name": "Delegation", "type": "folder" }, "items": [ { "info": { "name": "Get Delegation Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/delegation" }, "docs": "Retrieve the delegation configuration for your environment.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Create or Update Delegation Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/delegation", "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable delegation in the token exchange flow.\n\nUse this endpoint to update the delegation configuration by enabling or disabling delegation for the token exchange flow.\n\nA valid environment token is required to call this endpoint." } ] }, { "info": { "name": "Domain Restrictions", "type": "folder" }, "items": [ { "info": { "name": "Get Domain Restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain" }, "docs": "Retrieve the domain restrictions for an account (tenant)." }, { "info": { "name": "Create Domain Restriction", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new email domain restriction for an account (tenant). Provide the restriction configuration in the request body. See the schema below for available parameters and values." }, { "info": { "name": "Get Domain Restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain/config" }, "docs": "Retrieve the domain restrictions for an account (tenant)." }, { "info": { "name": "Change Domain Restrictions Config List Type and Toggle It Off/on", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain/config", "body": { "type": "json", "data": "{}" } }, "docs": "Update the domain restrictions configuration.\n\nYou can toggle the domain restriction check on or off." }, { "info": { "name": "Delete Domain Restriction", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a domain restriction." }, { "info": { "name": "Replace Bulk Domain Restriction", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain/replace-bulk", "body": { "type": "json", "data": "{}" } }, "docs": "Replace all domain restrictions with the domains provided in the request body." } ] }, { "info": { "name": "Email Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/mail/v1/configurations" }, "docs": "Retrieve the mail configuration for your SendGrid account.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Create or Update Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/mail/v1/configurations", "body": { "type": "json", "data": "{}" } }, "docs": "Configure your SendGrid account to send emails from your environment.\n\nProvide your SendGrid secret key in the request body.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Delete Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/mail/v1/configurations" }, "docs": "Delete the mail configuration for your SendGrid account.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Create or Update Configuration V2", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/mail/v2/configurations", "body": { "type": "json", "data": "{}" } }, "docs": "Configure email settings for your environment, supporting SES, Mailgun, and SendGrid.\n\nProvide the email provider, sender details, and any additional parameters in the request body.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." } ] }, { "info": { "name": "Email Templates", "type": "folder" }, "items": [ { "info": { "name": "Get Template", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/mail/v1/configs/templates", "params": [ { "name": "type", "value": "", "type": "query" } ] }, "docs": "Retrieve all email templates for your environment.\n\nTo retrieve a specific template, pass its `type` as a query parameter.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Add or Update Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/mail/v1/configs/templates", "body": { "type": "json", "data": "{}" } }, "docs": "Create or update an email template for your environment.\n\nSpecify the email template using the `type` parameter. The value of `type` must match one of the predefined Frontegg email templates. Set the sender using the `senderEmail` parameter, and optionally include values for the other available body parameters. Provide the template information in the request body.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Delete Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/mail/v1/configs/templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path" } ] }, "docs": "Delete a specified email template.\n\nProvide the ID of the template to delete. You can obtain the template ID via the **Get template** API.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Get Default Template by Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/mail/v1/configs/:type/default", "params": [ { "name": "type", "value": "", "type": "path", "description": "The email template type" } ] }, "docs": "Retrieve the default email template by type.\n\nPass the required `type` as a query parameter." } ] }, { "info": { "name": "General", "type": "folder" }, "items": [ { "info": { "name": "Authenticate User with Password", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user", "headers": [ { "name": "frontegg-vendor-host", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Authenticate a local user using their email and password.\n\nInclude the user's login credentials in the request body. This endpoint supports optional parameters such as an invitation token (for sign-up flows via invitation) and a reCAPTCHA token (if reCAPTCHA is enabled for login).\n\nIf the credentials are valid, the response includes a signed JWT and a refresh token that can be used for future authenticated requests." }, { "info": { "name": "Refresh User JWT Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/token/refresh", "headers": [ { "name": "frontegg-vendor-host", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refresh a JWT based on the refresh token's expiration time.\n\nThis endpoint returns a new JWT and refresh token if the existing refresh token is valid and not expired. The request must include the refresh token cookie for the currently logged-in user.\n\nEnsure your JWT settings are properly configured in the Frontegg Portal to support this flow." }, { "info": { "name": "Logout User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/logout", "headers": [ { "name": "frontegg-vendor-host", "value": "" } ] }, "docs": "Log out a user by invalidating their refresh token.\n\nThis endpoint logs out the currently authenticated user by invalidating the refresh token provided in the refresh token cookie.\n\nThis route is intended for applications using Frontegg's embedded login experience or for integrations that interact exclusively with Frontegg APIs." }, { "info": { "name": "Signup User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/signUp", "headers": [ { "name": "frontegg-vendor-host", "value": "" }, { "name": "frontegg-application-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sign up a new user and create a new account (tenant).\n\nThis endpoint registers a user with authentication details such as `email`, `password`, and the `provider` used for authentication (e.g., `local`, `saml`, `google`, `github`). Refer to the documentation or dropdown menu for the full list of supported provider values.\n\nAdditional optional fields such as user metadata may also be included. If not needed, `metadata` can be passed as an empty object (e.g., `{}`).\n\nThis endpoint is typically used" }, { "info": { "name": "Signup User with Username", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/signUp/username", "headers": [ { "name": "frontegg-vendor-host", "value": "" }, { "name": "frontegg-application-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sign up a new user and create a new account (tenant). Include the `frontegg-vendor-host` header (your domain name from Portal → Workspace Settings → Domains). Required fields: `email`, `provider` (authentication method: local, saml, google, github), `companyName`, and `metadata` (can be empty `{}`). Requires an environment authentication token." } ] }, { "info": { "name": "IP Restrictions", "type": "folder" }, "items": [ { "info": { "name": "Get IP Restriction Configuration (ALLOW/BLOCK)", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/restrictions/ip/config", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve the IP restriction configuration for an account (tenant).\n\nThe configuration defines whether IP restrictions are set to ALLOW or BLOCK." }, { "info": { "name": "Create or Update IP Restriction Configuration (ALLOW/BLOCK)", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/restrictions/ip/config", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the IP restriction configuration.\n\nYou can configure IP restrictions as either ALLOW or BLOCK." }, { "info": { "name": "Get All IP Restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/restrictions/ip", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_filter", "value": "", "type": "query" } ] }, "docs": "Retrieve the IP restrictions for an account (tenant)." }, { "info": { "name": "Create IP Restriction", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/restrictions/ip", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update an IP restriction for an account (tenant).\n\nProvide the required values as objects in the request body. Refer to the parameter documentation for the list of supported values." }, { "info": { "name": "Test Current IP", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/restrictions/ip/verify", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Check if the current IP is allowed based on the IP restriction configuration." }, { "info": { "name": "Test Current IP Is in Allow List", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/restrictions/ip/verify/allow", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Verifies if the current IP address is in the allow list for your environment." }, { "info": { "name": "Delete IP Restriction by IP", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/configurations/v1/restrictions/ip/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an IP restriction.\n\nProvide the IP restriction ID as a path parameter." } ] }, { "info": { "name": "Lockout Policy", "type": "folder" }, "items": [ { "info": { "name": "Get Lockout Policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/lockout-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve the lockout policy for all accounts (tenants) or for a specific account (tenant)." }, { "info": { "name": "Create Lockout Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/lockout-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a lockout policy for all accounts (tenants).\n\nTo enable the lockout policy, set the `enabled` parameter to `true` and configure the `maximumAttempts` value as desired." }, { "info": { "name": "Update Lockout Policy", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/configurations/v1/lockout-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the lockout policy for all accounts (tenants).\n\nTo disable the lockout policy, set the `enabled` parameter to `false`. You can also update the `maximumAttempts` value as desired." } ] }, { "info": { "name": "M2M Tokens", "type": "folder" }, "items": [ { "info": { "name": "Get Active Access Tokens List", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/vendor-only/users/access-tokens/v1/active", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve the list of active access tokens for a specified account (tenant).\n\nPass the account's `frontegg-tenant-id` as a query parameter." }, { "info": { "name": "Get User Access Token Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/vendor-only/users/access-tokens/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve data for a specific user access token.\n\nPass the account's `frontegg-tenant-id` as a query parameter and the access token `id` as a path parameter." }, { "info": { "name": "Get Account (tenant) Access Token Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/vendor-only/tenants/access-tokens/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve data for a specific account (tenant) access token.\n\nPass the account's `frontegg-tenant-id` as a query parameter and the access token `id` as a path parameter." } ] }, { "info": { "name": "MFA", "type": "folder" }, "items": [ { "info": { "name": "Recover MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/recover", "body": { "type": "json", "data": "{}" } }, "docs": "Recover multi-factor authentication (MFA) for a non-logged-in user.\n\nThis endpoint verifies a user's identity using a backup recovery code, typically generated by the user's MFA authenticator app during initial setup.\n\nUse this when a user cannot access their MFA device and needs to authenticate with their recovery code." }, { "info": { "name": "Disable Authenticator App MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/disable", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable MFA enrollment for a logged-in user within a specific account (tenant).\n\nThis endpoint disables multi-factor authentication for a user, using the `mfaToken` obtained from the user's authenticator app.\n\nUse this endpoint to programmatically disable MFA when managing authentication settings at the account (tenant) level." }, { "info": { "name": "Disable Authenticator App MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/authenticator/:deviceId/disable/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable multi-factor authentication (MFA) enrollment for a logged-in user within a specific account (tenant).\n\nThis endpoint removes MFA for a user, typically used in administrative contexts where a backend system or admin manages user security settings.\n\nThe request must include the `mfaToken`, which is the time-based one-time password (TOTP) generated by the user's authenticator app.\n\nUse this endpoint to programmatically disable MFA for a specific user within an account (tenant)." }, { "info": { "name": "Pre-disable SMS MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/sms/:deviceId/disable", "headers": [ { "name": "frontegg-user-id", "value": "" }, { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate the process of disabling SMS-based multi-factor authentication (MFA) for a specific device.\n\nProvide the target `deviceId` in the request path to mark the SMS MFA device for pre-disablement. This action prepares the device for subsequent steps required to complete the removal.\n\nUse this route as part of the MFA management flow for disabling SMS-based MFA on a per-device basis." }, { "info": { "name": "Disable SMS MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/sms/:deviceId/disable/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Complete the process of disabling SMS-based multi-factor authentication (MFA) for a specific device.\n\nThis step finalizes MFA deactivation for the given `deviceId` after a prior pre-disable action.\n\nThe request must include:\n- `otcToken`: The one-time challenge token obtained during the pre-disable step.\n- `code`: The SMS verification code received by the user.\n\nUse this endpoint as the second step in the SMS MFA removal flow to verify the user's identity and confirm the disable action." }, { "info": { "name": "Verify MFA Using Code From Authenticator App", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verify a multi-factor authentication (MFA) code generated by an authenticator app during the authentication process.\n\nThis endpoint completes the MFA step by validating the provided code.\n\nThe request must include:\n- `value`: The MFA service name (e.g., `authenticator`), as configured in your Authentication Settings.\n- `mfaToken`: The time-based one-time password (TOTP) generated by the user's authenticator app.\n\nUse this endpoint to verify the user's MFA code during an authentication challenge," }, { "info": { "name": "Request Verify MFA Using Email Code", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/emailcode", "body": { "type": "json", "data": "{}" } }, "docs": "Verify multi-factor authentication (MFA) using a code sent to the user's email.\n\nThis endpoint completes the email-based MFA verification step.\n\nThe request must include:\n- `mfaToken`: The token provided after the user initiates MFA via email.\n\nUse this endpoint to confirm the email-based MFA challenge and finalize the login or authentication process." }, { "info": { "name": "Verify MFA Using Email Code", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/emailcode/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verify a multi-factor authentication (MFA) challenge using a code sent to the user's email address.\n\nThis endpoint finalizes the email-based MFA verification and completes the authentication process.\n\nThe request must include:\n- `otcToken`: One-time challenge token received during the email MFA initiation.\n- `code`: The MFA code sent to the user's email.\n- `mfaToken`: Token returned from the original MFA setup or step-up authentication request.\n- `rememberDevice` (optional): If set to `true`, th" }, { "info": { "name": "Pre Enroll MFA Using Authenticator App", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/authenticator/enroll", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate enrollment in multi-factor authentication (MFA) using an authenticator app (e.g., Google Authenticator, Authy).\n\nThis endpoint begins the MFA setup process and returns the necessary data for configuring an authenticator app, such as a QR code or secret key.\n\nThe request must include:\n- `mfaToken`: A token received from the initial authentication flow that authorizes the MFA setup.\n\nUse this endpoint to generate the configuration required for linking an authenticator app before completin" }, { "info": { "name": "Enroll MFA Using Authenticator App", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/authenticator/enroll/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Complete enrollment in multi-factor authentication (MFA) using an authenticator app.\n\nThis endpoint verifies the MFA setup by validating the time-based one-time password (TOTP) generated by the authenticator app.\n\nThe request must include:\n- `token`: The 6-digit TOTP code generated by the authenticator app.\n- `mfaToken`: Token from the initial MFA enrollment initiation.\n- `rememberDevice` (optional): If set to `true`, the device will be remembered and may skip MFA on future logins from the same " }, { "info": { "name": "Verify MFA Using Authenticator App", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/authenticator/:deviceId/verify", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify multi-factor authentication (MFA) during the authentication process.\n\nThis endpoint is typically used after a primary login attempt when MFA is enabled for the user or account (tenant).\n\nThe request must include:\n- `value`: The MFA service name (e.g., `authenticator`, `email`, `sms`) configured under Authentication Settings.\n- `mfaToken`: The token or code provided by the user's MFA method (e.g., code from an authenticator app).\n\nUse this endpoint to complete the MFA verification step as " }, { "info": { "name": "Pre-enroll MFA Using Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate multi-factor authentication (MFA) enrollment using SMS.\n\nThis endpoint begins the SMS-based MFA setup by sending a verification code to the provided phone number.\n\nThe request must include:\n- `phoneNumber`: The user's mobile phone number in international format. It must match the format defined in your organization's phone number validation pattern (`phoneNumberRegexp`).\n\nUse this endpoint as the first step in enabling SMS-based MFA for a user." }, { "info": { "name": "Enroll MFA Using Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Complete enrollment in multi-factor authentication (MFA) using SMS.\n\nThis endpoint finalizes the SMS-based MFA setup for the user by verifying the code sent to their phone number.\n\nThe request must include:\n- `otcToken`: Token received from the initial SMS MFA enrollment step.\n- `code`: The numeric code sent via SMS to the user's registered phone number.\n\nUse this endpoint to verify the user's phone number and activate SMS-based MFA on their account." }, { "info": { "name": "Request to Verify MFA Using Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/:deviceId", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify multi-factor authentication (MFA) using an SMS-based device.\n\nThis endpoint confirms the SMS MFA challenge as part of the authentication or step-up verification process for a specific registered device.\n\nPath parameters:\n- `deviceId`: The unique identifier of the SMS MFA device being verified.\n\nRequest body must include:\n- `mfaToken`: Token provided during the authentication or challenge flow.\n\nUse this endpoint to complete SMS-based MFA verification for the specified device." }, { "info": { "name": "Verify MFA Using Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/:deviceId/verify", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify a multi-factor authentication (MFA) challenge using an SMS code for a specific registered device.\n\nThis endpoint finalizes the MFA step by validating the SMS code and may mark the device as trusted if specified.\n\nPath parameters:\n- `deviceId`: The unique identifier of the SMS MFA device being verified.\n\nRequest body must include:\n- `otcToken`: Token received from the SMS MFA challenge initiation.\n- `code`: The verification code sent to the user's phone via SMS.\n- `mfaToken`: MFA token iss" }, { "info": { "name": "Pre Enroll MFA Using WebAuthN", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate multi-factor authentication (MFA) enrollment using WebAuthn (e.g., security keys, biometrics).\n\nThis endpoint begins the WebAuthn MFA setup by returning a browser-based challenge needed to link a trusted device, such as a biometric reader or hardware security key.\n\nThe request must include:\n- `mfaToken`: Token issued during the authentication flow to authorize MFA setup.\n\nUse this endpoint as the first step when enrolling a user in WebAuthn-based MFA." }, { "info": { "name": "Enroll MFA Using WebAuthN", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Complete enrollment in multi-factor authentication (MFA) using WebAuthn.\n\nThis endpoint verifies and registers a WebAuthn device, such as a biometric sensor (Platform) or hardware security key (CrossPlatform), finalizing the setup after the initial challenge.\n\nThe request must include:\n- `deviceType`: Type of device being enrolled. Accepts `Platform` (e.g., fingerprint scanner) or `CrossPlatform` (e.g., USB security key).\n- `webauthnToken`: Token received during the WebAuthn pre-enrollment step." }, { "info": { "name": "Request Verify MFA Using WebAuthN", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/:deviceId", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify a multi-factor authentication (MFA) challenge using a registered WebAuthn device.\n\nThis endpoint completes WebAuthn-based MFA verification, typically following primary authentication when WebAuthn is required as a second factor.\n\nPath parameters:\n- `deviceId`: The unique identifier of the WebAuthn device to be verified.\n\nRequest body must include:\n- `mfaToken`: Token issued during the login or step-up authentication flow.\n\nUse this endpoint to validate a WebAuthn device and complete the M" }, { "info": { "name": "Verify MFA Using Webauthn", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/:deviceId/verify", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify a multi-factor authentication (MFA) challenge using a WebAuthn device.\n\nThis endpoint completes MFA verification using a previously registered WebAuthn device such as a biometric sensor or hardware security key.\n\nPath parameters:\n- `deviceId`: The unique identifier of the registered WebAuthn device to be verified.\n\nRequest body must include:\n- `webauthnToken`: Token received from the server to initiate the WebAuthn challenge.\n- `options`: WebAuthn authentication response returned by the b" }, { "info": { "name": "Check if Remember Device Allowed", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy/allow-remember-device", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "mfaToken", "value": "", "type": "query", "description": "MFA token from the response body of the first factor authentication" } ] }, "docs": "Check whether the 'remember device' feature is allowed for MFA verification.\n\nThis endpoint returns whether device remembering is enabled globally or for a specific account (tenant), based on the request context.\n\nQuery parameters:\n- `mfaToken`: Token generated from the authenticator app or MFA challenge step.\n\nUse this endpoint to determine whether the user should be prompted with the option to remember their device during MFA verification." }, { "info": { "name": "Enroll Authenticator App MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/enroll", "headers": [ { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Enroll a logged-in user in multi-factor authentication (MFA) for a specific account (tenant).\n\nThis endpoint initiates MFA enrollment on behalf of a user within a specific account (tenant) context.\n\nUse this route to programmatically trigger MFA enrollment, typically as part of an administrative or backend workflow." }, { "info": { "name": "Enroll Authenticator App MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll", "headers": [ { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Enroll a logged-in user in multi-factor authentication (MFA) for a specific account (tenant).\n\nThis endpoint initiates MFA enrollment on behalf of a user within a specific account (tenant) context.\n\nUse this route to programmatically trigger MFA enrollment, typically as part of an administrative or backend workflow." }, { "info": { "name": "Verify Authenticator App MFA Enrollment", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/enroll/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify multi-factor authentication (MFA) enrollment using a QR code for a specific user.\n\nThis endpoint completes MFA setup after the user scans a QR code with their authenticator app (e.g., Google Authenticator, Authy).\n\nRequest body must include:\n- `mfaToken`: The time-based one-time password (TOTP) generated by the user's authenticator app after scanning the QR code.\n\nUse this endpoint to confirm that the user has successfully linked their authenticator app and to activate MFA for their accou" }, { "info": { "name": "Verify Authenticator App MFA Enrollment", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify multi-factor authentication (MFA) enrollment using a QR code for a specific user within an account (tenant).\n\nThis endpoint completes MFA enrollment after the user scans a QR code with an authenticator app (e.g., Google Authenticator, Authy).\n\nRequest body must include:\n- `mfaToken`: The time-based one-time password (TOTP) generated by the authenticator app after scanning the QR code.\n\nUse this endpoint to confirm that the user has successfully registered their authenticator app and to ac" }, { "info": { "name": "Enroll SMS MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/sms/enroll", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enroll a user in SMS-based multi-factor authentication (MFA).\n\nThis endpoint initiates SMS MFA enrollment by sending a verification code to the user's phone number.\n\nRequest body must include:\n- `phoneNumber`: The user's mobile number in international format. Must match the validation pattern defined by `phoneNumberRegexp`.\n\nUse this endpoint to begin the SMS MFA setup process for a specific user. The next step is to verify the SMS code to complete enrollment." }, { "info": { "name": "Verify MFA Enrollment", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/mfa/sms/enroll/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Complete SMS-based multi-factor authentication (MFA) enrollment for a user.\n\nThis endpoint finalizes SMS MFA setup by verifying the code sent to the user's phone.\n\nRequest body must include:\n- `otcToken`: One-time challenge token received from the initial enrollment step.\n- `code`: The verification code sent to the user's phone via SMS.\n\nUse this endpoint to verify the user's phone number and activate SMS-based MFA for their account." } ] }, { "info": { "name": "MFA Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get MFA Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa" }, "docs": "Retrieve the MFA configuration for your environment." }, { "info": { "name": "Update MFA Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa", "body": { "type": "json", "data": "{}" } }, "docs": "Update the MFA configuration for your environment.\n\nProvide the desired configuration values as objects in the request body. Refer to the parameter documentation for the list of supported values." } ] }, { "info": { "name": "MFA Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Security Policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "This route gets the MFA policy for all accounts (tenants)." }, { "info": { "name": "Create MFA Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an MFA policy globally or for a specific account (tenant)." }, { "info": { "name": "Upsert Security Policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the MFA policy for all accounts (tenants)." }, { "info": { "name": "Update Security Policy", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the MFA policy for all accounts (tenants)." }, { "info": { "name": "Get MFA Strategies", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa/strategies" }, "docs": "Retrieve the MFA strategies configured for your environment." }, { "info": { "name": "Create or Update MFA Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/mfa/strategies", "body": { "type": "json", "data": "{}" } }, "docs": "Create or update an MFA strategy.\n\nProvide the desired strategy configuration in the request body." } ] }, { "info": { "name": "Password Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Password Policy Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/password", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve the password policy for all accounts (tenants)." }, { "info": { "name": "Create or Update Password Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/password", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the password policy for the entire environment." }, { "info": { "name": "Get Password History Policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/password-history-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve the password history policy for all accounts (tenants) or for a specific account (tenant)." }, { "info": { "name": "Create Password History Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/password-history-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a password history policy for all accounts (tenants).\n\nTo enable the password history policy, set the `enabled` parameter to `true` and specify the `passwordHistorySize` as a number between 1 and 10." }, { "info": { "name": "Update Password History Policy", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/configurations/v1/password-history-policy", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the password history policy for all accounts (tenants).\n\nTo disable the password history policy, set the `enabled` parameter to `false`. You can also update the `passwordHistorySize` value to a number between 1 and 10." }, { "info": { "name": "Reset Password", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/passwords/reset", "body": { "type": "json", "data": "{}" } }, "docs": "Send a reset password email to a user.\n\nProvide the user's email in the request body. If your email template uses metadata, include the email metadata in the request body as well." }, { "info": { "name": "Verify Password", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/passwords/reset/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verify a user's password using a verification token.\n\nProvide the `userId`, `token`, and `password` in the request body. The `token` can be obtained using the route for generating a user password reset token." }, { "info": { "name": "Change Password", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/passwords/change", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the password for a logged-in user.\n\nInclude the current and new passwords in the request body." }, { "info": { "name": "Get Strictest Password Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v1/passwords/config", "params": [ { "name": "userId", "value": "", "type": "query" } ] }, "docs": "Retrieve the user's strictest password configuration.\n\nThis is useful when a user belongs to multiple accounts (tenants) with varying password complexity requirements. The route returns the strictest setting the user is subject to." }, { "info": { "name": "Reset Password via Email", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v2/passwords/reset/email", "body": { "type": "json", "data": "{}" } }, "docs": "Sends a password reset email to the user. Provide the user's email address in the request body to initiate the reset process." }, { "info": { "name": "Reset Password via SMS", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v2/passwords/reset/sms", "body": { "type": "json", "data": "{}" } }, "docs": "Sends a password reset SMS with a one-time code (OTP) to the user. Provide the user's phone number in the request body to initiate the reset process." }, { "info": { "name": "Verify Password Reset Code Sent via SMS", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v2/passwords/reset/sms/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verifies the one-time code (OTP) sent via SMS for password reset. Provide the OTP in the request body. If valid, returns the user ID and reset token." }, { "info": { "name": "Get Password Expiration Period Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/password-rotation" }, "docs": "Retrieve the password expiration period configuration for your environment or for a specific account (tenant)." }, { "info": { "name": "Manage Password Expiration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/password-rotation", "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the configuration for the password expiration policy.\n\nIf no configuration exists, a default policy will be applied." }, { "info": { "name": "Get Environment Configuration for Password Expiration Period.", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/password-rotation/vendor" }, "docs": "Retrieve the password expiration period configuration for your environment or for a specific account (tenant)." } ] }, { "info": { "name": "Passwordless", "type": "folder" }, "items": [ { "info": { "name": "SMS Code Prelogin", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/passwordless/smscode/prelogin", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate SMS-based passwordless authentication by sending a one-time code (OTC) to the user's phone.\n\nThis is the first step in the SMS OTC passwordless login flow. The system sends an SMS to the user associated with the provided email address.\n\nRequest body must include:\n- `email`: The email address of the user initiating the login.\n- `invitationToken` (optional): Include if the user is signing up through an invitation.\n- `recaptchaToken` (optional): Required if reCAPTCHA is enabled for login.\n" }, { "info": { "name": "SMS Code Postlogin", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/passwordless/smscode/postlogin", "body": { "type": "json", "data": "{}" } }, "docs": "Complete passwordless authentication using a one-time code (OTC) sent via SMS.\n\nThis is the second step in the SMS OTC passwordless login flow. After the user receives the code, this endpoint finalizes authentication and returns a valid JWT and refresh cookie.\n\nRequest body must include:\n- `token`: The token ID associated with the SMS OTC sent to the user.\n- `invitationToken` (optional): Include if the user is signing up through an invitation.\n- `recaptchaToken` (optional): Required if reCAPTCHA" }, { "info": { "name": "Magic Link Prelogin", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/prelogin", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate passwordless authentication by sending a magic link to the user's email address.\n\nThis is the first step in the magic link passwordless login flow for local users. The system sends an email containing a secure login link to the provided address.\n\nRequest body must include:\n- `email`: The email address of the user initiating the login.\n- `invitationToken` (optional): Include if the user is signing up through an invitation.\n- `recaptchaToken` (optional): Required if reCAPTCHA is enabled f" }, { "info": { "name": "Magic Link Postlogin", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/postlogin", "body": { "type": "json", "data": "{}" } }, "docs": "Complete passwordless authentication using a magic link.\n\nThis is the second step in the magic link passwordless login flow for local users. After the user clicks the link in their email, this endpoint validates the token and authenticates the user.\n\nRequest body must include:\n- `token`: The token ID extracted from the magic link.\n- `invitationToken` (optional): Include if the user is signing up through an invitation.\n- `recaptchaToken` (optional): Required if reCAPTCHA is enabled for login.\n\nUs" }, { "info": { "name": "OTC (One-Time Code) Prelogin", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/passwordless/code/prelogin", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate passwordless authentication by sending a one-time code (OTC) to the user's email address.\n\nThis is the first step in the email OTC (one-time code) passwordless login flow for local users. The system sends a time-sensitive code to the specified email address.\n\nRequest body must include:\n- `email`: The email address of the user initiating the login.\n- `invitationToken` (optional): Include if the user is signing up through an invitation.\n- `recaptchaToken` (optional): Required if reCAPTCHA" }, { "info": { "name": "OTC (One-Time Code) Postlogin", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/auth/v1/passwordless/code/postlogin", "body": { "type": "json", "data": "{}" } }, "docs": "Complete passwordless authentication using a one-time code (OTC) sent to the user's email.\n\nThis is the second step in the email OTC passwordless login flow. After the user receives and enters the code, this endpoint validates the token and finalizes authentication.\n\nRequest body must include:\n- `token`: The token ID associated with the email OTC sent to the user.\n- `invitationToken` (optional): Include if the user is signing up via an invitation.\n- `recaptchaToken` (optional): Required if reCAP" } ] }, { "info": { "name": "Permissions", "type": "folder" }, "items": [ { "info": { "name": "Get Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/permissions/v1" }, "docs": "Retrieve all permissions configured for your environment.\n\nEach permission object includes the name, description, assigned roles, categories, and other defining information." }, { "info": { "name": "Create Permissions", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/permissions/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new permission.\n\nProvide the permission information in the request body.\n\nThis route does not associate permissions with roles. Use the associate permission to roles route to manage role associations." }, { "info": { "name": "Update Permission", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/permissions/v1/:permissionId", "params": [ { "name": "permissionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing permission.\n\nProvide the permission ID as a path parameter to specify which permission to update, and send the updated permission information in the request body.\n\nThis route does not update role associations for the permission. Use the associate permission to roles route to manage role associations." }, { "info": { "name": "Delete Permission", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/permissions/v1/:permissionId", "params": [ { "name": "permissionId", "value": "", "type": "path" } ] }, "docs": "Delete a permission.\n\nProvide the permission ID as a path parameter to specify which permission to delete. You can obtain the permission ID using the **Get permissions** API." }, { "info": { "name": "Set a Permission to Multiple Roles", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/permissions/v1/:permissionId/roles", "params": [ { "name": "permissionId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a permission with multiple roles.\n\nProvide the permission ID as a path parameter and include the role IDs in the request body as an array of strings. Any pre-existing role associations will remain.\n\nYou can obtain role IDs using the **Get roles** API." }, { "info": { "name": "Set Permissions Classification", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/permissions/v1/classification", "body": { "type": "json", "data": "{}" } }, "docs": "Classify permissions for self-service usage.\n\nProvide an array of `permissionIds` and the classification `type` in the request body. This allows you to segregate which permissions will be used for self-service." } ] }, { "info": { "name": "Permissions Categories", "type": "folder" }, "items": [ { "info": { "name": "Get Permissions Categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/permissions/v1/categories" }, "docs": "Retrieves all permission categories for your environment. Each category includes its name, description, associated permissions, and metadata." }, { "info": { "name": "Create Category", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/permissions/v1/categories", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new permissions category.\n\nProvide the category information in the request body. Note that categories are not associated with permissions in this route — you can associate permissions by sending the category ID in the add or update permission routes." }, { "info": { "name": "Update Category", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/permissions/v1/categories/:categoryId", "params": [ { "name": "categoryId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing permissions category.\n\nProvide the category ID as a path parameter to specify which category to update, and send the updated category information in the request body.\n\nThis route does not update the permissions associated with the category. Use the add or update permissions routes to manage permission associations." }, { "info": { "name": "Delete Category", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/permissions/v1/categories/:categoryId", "params": [ { "name": "categoryId", "value": "", "type": "path" } ] }, "docs": "Delete a permissions category.\n\nProvide the category ID as a path parameter to specify which category to delete. You can obtain the category ID using the **Get categories** API." } ] }, { "info": { "name": "Personal Tokens", "type": "folder" }, "items": [ { "info": { "name": "Get User Access Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/access-tokens/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Retrieve all access tokens for a specific user." }, { "info": { "name": "Create User Access Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/access-tokens/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an access token for a specific user." }, { "info": { "name": "Delete User Access Token by Token ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/access-tokens/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a user access token." }, { "info": { "name": "Get User Client Credentials Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/api-tokens/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Retrieve a user-specific API token." }, { "info": { "name": "Create User Client Credentials Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/api-tokens/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a user-specific API token." }, { "info": { "name": "Delete User Client Credentials Token by Token ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/api-tokens/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a user-specific API token." } ] }, { "info": { "name": "Roles", "type": "folder" }, "items": [ { "info": { "name": "Get Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/roles/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve all roles across all accounts (tenants).\n\nEach role object includes the name, permissions, and other defining information." }, { "info": { "name": "Create Roles", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/roles/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new role across all accounts (tenants).\n\nThis route does not assign permissions to the role. Use the attach permissions to role route to manage role permissions." }, { "info": { "name": "Update Role", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/roles/v1/:roleId", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "roleId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing role.\n\nProvide the role ID as a path parameter to specify which role to update, and send the updated role information in the request body.\n\nThis route does not update permissions for the role. Use the attach permissions to role route to manage role permissions.\n\nYou can obtain the role ID using the **Get roles** API." }, { "info": { "name": "Delete Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/roles/v1/:roleId", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "roleId", "value": "", "type": "path" } ] }, "docs": "Delete a role.\n\nProvide the role ID as a path parameter to specify which role to delete." }, { "info": { "name": "Assign Permissions to a Role", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/roles/v1/:roleId/permissions", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "roleId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign permissions to a role.\n\nProvide the role ID as a path parameter and include the permission IDs in the request body as an array of strings. Any pre-existing permissions will be overridden by the new permissions.\n\nYou can obtain role IDs using the **Get roles** API and permission IDs using the **Get permissions** API." }, { "info": { "name": "Update Role Tenant", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/roles/v1/:roleId/tenant", "params": [ { "name": "roleId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the account (tenant) ID for a specific role. This is a management-only endpoint." } ] }, { "info": { "name": "SMS", "type": "folder" }, "items": [ { "info": { "name": "Get All Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1", "params": [ { "name": "_limit", "value": "", "type": "query" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_sortBy", "value": "", "type": "query" }, { "name": "_order", "value": "", "type": "query" }, { "name": "_phoneNumber", "value": "", "type": "query" } ] }, "docs": "Retrieve a paginated list of all user phone numbers associated with your environment.\n\nThis endpoint returns user phone numbers along with pagination metadata and navigation links. It supports filtering, sorting, and offset-based pagination for efficient querying.\n\nQuery parameters (optional):\n- `_limit` (number ≥ 1): Maximum number of items to return per page.\n- `_offset` (number ≥ 0): The page number to retrieve. For example, use 0 for the first page, 1 for the second page.\n- `_sortBy` (string" }, { "info": { "name": "Set Phone Number for a User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Assign a new phone number to a user and optionally trigger a verification code.\n\nBy default, the system sends an SMS verification code to the provided phone number. To skip verification (e.g., for internal setup), set the `verify` field to `false`.\n\nRequest body must include:\n- `phoneNumber`: The new phone number to assign to the user. Must follow international format.\n- `verify` (optional): Whether to send an SMS verification code. Defaults to `true` if not provided.\n\nUse this endpoint to set o" }, { "info": { "name": "Pre-verify User's Phone Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1/preverify", "body": { "type": "json", "data": "{}" } }, "docs": "Send a one-time code (OTC) to the specified phone number to initiate verification.\n\nThis endpoint is used to pre-verify a phone number before associating it with a user account. It sends an SMS-based one-time code to the provided number.\n\nRequest body must include:\n- `phoneNumber`: The phone number to verify, in international format.\n\nUse this endpoint to validate ownership of a phone number by sending a one-time code for user input during onboarding or account setup." }, { "info": { "name": "Verify Creation of Phone Number for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verify a user's phone number using a one-time code (OTC) that was sent via SMS.\n\nThis is the final step in the phone number verification process. After initiating verification via the pre-verification route, use this endpoint to confirm the phone number by submitting the OTC and code.\n\nRequest body must include:\n- `otcToken`: The token issued when the OTC was sent.\n- `code`: The one-time code the user received on their phone.\n\nUse this endpoint to validate the user's ownership of the phone numbe" }, { "info": { "name": "Delete User's Phone Number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Initiate the deletion process for a user's phone number.\n\nThis endpoint begins the phone number removal workflow by sending a verification code to the user. The phone number will not be deleted until the verification step is completed.\n\nPath parameters:\n- `id`: The unique identifier of the phone number to be deleted.\n\nUse this endpoint to trigger the secure deletion process for a user's phone number. A follow-up verification step is required to finalize the removal." }, { "info": { "name": "Verify Delete User's Phone Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1/:id/delete/verify", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify the deletion of a user's phone number using a one-time code (OTC).\n\nThis is the final step in the phone number deletion process. After initiating deletion, the system sends a verification code to the user's phone. This endpoint confirms the deletion by validating the OTC and code.\n\nPath parameters:\n- `id`: The unique identifier of the phone number to delete.\n\nRequest body must include:\n- `otcToken`: The token issued during the deletion request.\n- `code`: The one-time code sent to the user" }, { "info": { "name": "Get Current User's Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1/me", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Retrieve all phone numbers associated with the current user.\n\nThis endpoint returns a list of phone numbers linked to the authenticated user, including verification status and timestamps.\n\nThe response includes metadata such as verification status and timestamps for creation and last update.\n\nUse this endpoint to display or manage the user's registered phone numbers in your application." }, { "info": { "name": "Get All Phone Numbers V2", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v2", "params": [ { "name": "_limit", "value": "", "type": "query" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_sortBy", "value": "", "type": "query" }, { "name": "_order", "value": "", "type": "query" }, { "name": "_phoneNumber", "value": "", "type": "query" }, { "name": "userIds", "value": "", "type": "query" } ] }, "docs": "This route returns all user phone numbers." } ] }, { "info": { "name": "SMS Configuration", "type": "folder" }, "items": [ { "info": { "name": "Gets a Vendor SMS Config", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms" }, "docs": "Retrieve the SMS configuration for your environment." }, { "info": { "name": "Creates or Updates a Vendor SMS Config", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms", "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the SMS configuration for your environment.\n\nProvide the desired SMS configuration values in the request body." }, { "info": { "name": "Deletes a Vendor SMS Config", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms" }, "docs": "Delete the SMS configuration for your environment." } ] }, { "info": { "name": "SMS Templates", "type": "folder" }, "items": [ { "info": { "name": "Gets Vendor SMS Templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms/templates" }, "docs": "Retrieve the SMS templates configured for your environment." }, { "info": { "name": "Gets Vendor SMS Template by Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms/templates/:type", "params": [ { "name": "type", "value": "", "type": "path" } ] }, "docs": "Retrieve an SMS template by type.\n\nProvide the `type` as a path parameter to specify which SMS template to retrieve." }, { "info": { "name": "Create or Update a Vendor SMS Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms/templates/:type", "params": [ { "name": "type", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update an SMS template by type.\n\nProvide the `type` as a path parameter and include the SMS template details in the request body." }, { "info": { "name": "Deletes Vendor SMS Template by Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms/templates/:type", "params": [ { "name": "type", "value": "", "type": "path" } ] }, "docs": "Delete an SMS template by type.\n\nProvide the `type` as a path parameter to specify which SMS template to delete." }, { "info": { "name": "Gets Vendor Default SMS Template by Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms/templates/:type/default", "params": [ { "name": "type", "value": "", "type": "path" } ] }, "docs": "Retrieve the default SMS template by type.\n\nProvide the `type` as a path parameter to specify which default SMS template to retrieve." }, { "info": { "name": "Gets All Vendor Default SMS Templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/sms/templates/default/all" }, "docs": "Gets All Vendor Default SMS Templates" } ] }, { "info": { "name": "Sessions Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get Environment Session Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/sessions/v1/vendor" }, "docs": "Retrieve the session configuration for your environment." } ] }, { "info": { "name": "Sessions Management", "type": "folder" }, "items": [ { "info": { "name": "Get Account (tenant) or Vendor Default Session Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/sessions/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ] }, "docs": "Retrieve the session configuration for the entire environment or for a specific account (tenant)." }, { "info": { "name": "Create or Update Account (tenant) or Vendor Default Session Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/sessions/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the session configuration for the entire environment or for a specific account (tenant)." } ] }, { "info": { "name": "User Emails Policy", "type": "folder" }, "items": [ { "info": { "name": "Get User Emails Policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/configurations/v1/user-emails-policy" }, "docs": "Get information about the user emails policy. An environment token is required for this route." }, { "info": { "name": "Create or Update User Emails Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/configurations/v1/user-emails-policy", "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable the ability to change user emails. An environment token is required for this route." } ] }, { "info": { "name": "User Groups", "type": "folder" }, "items": [ { "info": { "name": "Get All Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/groups/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "_groupsRelations", "value": "", "type": "query" } ] }, "docs": "Retrieve all user groups for an account (tenant)." }, { "info": { "name": "Create Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/groups/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a user group for an account (tenant).\n\nProvide the group details in the request body." }, { "info": { "name": "Get Groups by Ids", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/groups/v1/bulkGet", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "_groupsRelations", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve user groups by given IDs for an account (tenant).\n\nProvide the group IDs in the request body." }, { "info": { "name": "Get Group by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/groups/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_groupsRelations", "value": "", "type": "query" } ] }, "docs": "Retrieve a user group by ID for an account (tenant).\n\nProvide the group ID as a path parameter." }, { "info": { "name": "Update Group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/groups/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a user group by ID for an account (tenant).\n\nProvide the group ID as a path parameter and the updated group details in the request body." }, { "info": { "name": "Delete Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/groups/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a user group by ID for an account (tenant).\n\nProvide the group ID as a path parameter." }, { "info": { "name": "Get Groups Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/groups/v1/config" }, "docs": "Retrieve the user group configuration for your environment." }, { "info": { "name": "Create or Update Groups Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/groups/v1/config", "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the user group configuration for your environment.\n\nProvide the configuration details in the request body." }, { "info": { "name": "Add Roles to Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/groups/v1/:groupId/roles", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add roles to an existing user group.\n\nA user can assign only roles that are lower than their own." }, { "info": { "name": "Remove Roles From Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/groups/v1/:groupId/roles", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove roles from an existing user group.\n\nProvide the roles to remove in the request body." }, { "info": { "name": "Add Users to Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/groups/v1/:groupId/users", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add users to an existing user group.\n\nOnly users with higher roles than the group's roles are allowed to perform this action." }, { "info": { "name": "Remove Users From Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/groups/v1/:groupId/users", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove users from an existing user group.\n\nProvide the users to remove in the request body." }, { "info": { "name": "Get All Groups Paginated", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/groups/v2", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "_groupsRelations", "value": "", "type": "query" }, { "name": "_limit", "value": "", "type": "query" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_sortBy", "value": "", "type": "query" }, { "name": "_order", "value": "", "type": "query" } ] }, "docs": "Retrieve all user groups for an account (tenant), with pagination.\n\nUse query parameters to control pagination and optionally include related group data." } ] }, { "info": { "name": "User Management", "type": "folder" }, "items": [ { "info": { "name": "Disable User Account (tenant)", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/users/v1/:userId/disable", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Disable a user for an account (tenant).\n\nA disabled user cannot log in to the account (tenant) or use the system.\n\nProvide the user's ID as a path parameter." }, { "info": { "name": "Enable User Account (tenant)", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/tenants/users/v1/:userId/enable", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Enable a disabled user for an account (tenant).\n\nAn enabled user can log in and use the system.\n\nProvide the user's ID as a path parameter." }, { "info": { "name": "Sets a Permanent User to Temporary", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/temporary/v1/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the settings for temporary users.\n\nUse this route to enable or disable temporary users for your environment" }, { "info": { "name": "Sets a Temporary User to Permanent", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/temporary/v1/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Set an existing temporary user as permanent.\n\nProvide the user's ID as a path parameter." }, { "info": { "name": "Gets Temporary Users Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/temporary/v1/configuration" }, "docs": "Retrieve the settings for temporary users.\n\nUse this endpoint to check whether the policy is enabled or disabled." }, { "info": { "name": "Get All User Emails", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/emails/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_sortBy", "value": "", "type": "query" }, { "name": "_order", "value": "", "type": "query" }, { "name": "_email", "value": "", "type": "query" }, { "name": "userIds", "value": "", "type": "query" } ] }, "docs": "This route returns all user emails. " }, { "info": { "name": "Create a User Email", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/emails/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This route creates a user email." }, { "info": { "name": "Verify User Email", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/emails/v1/verify", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This route verifies a user email." }, { "info": { "name": "Delete a User Email", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/emails/v1/:emailId", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "emailId", "value": "", "type": "path" } ] }, "docs": "This route deletes a user email." }, { "info": { "name": "Create a User Email for Vendor", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/emails/v1/vendor/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new email address for a user." }, { "info": { "name": "Delete a User Email for Vendor", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/emails/v1/vendor/:userId/:emailId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "emailId", "value": "", "type": "path" } ] }, "docs": "This route deletes a user email." }, { "info": { "name": "Mark Email as Primary for Vendor", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/emails/v1/vendor/:userId/primary", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This route marks an email as primary." }, { "info": { "name": "Mark Email as Primary", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/emails/v1/me/primary", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This route marks an email as primary." }, { "info": { "name": "Get Current User`s Emails", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/emails/v1/me", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ] }, "docs": "This route returns all user emails for the current user." }, { "info": { "name": "Set Sub-account Access for a User", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/sub-tenants/users/v1/:userId/access", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set sub-account access for a user.\n\nUse this endpoint to enable or disable sub-account access by setting the value to `true` or `false`." }, { "info": { "name": "Reset User Activation Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/activate/reset", "body": { "type": "json", "data": "{}" } }, "docs": "Reset the activation token for a user and trigger a new activation email.\n\nProvide the user's ID as a path parameter." }, { "info": { "name": "Reset Invitation", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/invitation/reset", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reset an invitation for a user to join a specific account (tenant).\n\nThe response includes a new invitation link with a new token." }, { "info": { "name": "Reset All Invitation Tokens", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/invitation/reset/all", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reset all invitations for a user to join all sub-accounts (tenants) that currently have an invitation token.\n\nThe response includes new invitation links with new tokens." }, { "info": { "name": "Get Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v3", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "The default limit is 50 users per request, the maximum is 200" }, { "name": "_identifier", "value": "", "type": "query", "description": "Filter users by username prefix match. Must be provided together with _identifierType" }, { "name": "_identifierType", "value": "", "type": "query", "description": "Filter users by username. Must be provided together with _identifier" }, { "name": "_includeSubTenants", "value": "", "type": "query", "description": "when passing a user id, gives the option to include or not include sub accounts (tenants) when searching users" }, { "name": "_namePrefix", "value": "", "type": "query", "description": "Filter users by prefix name match" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_email", "value": "", "type": "query" }, { "name": "_tenantId", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query" }, { "name": "_sortBy", "value": "", "type": "query" }, { "name": "_order", "value": "", "type": "query" }, { "name": "_externalIds", "value": "", "type": "query" } ] }, "docs": "Retrieve all users for an account (tenant) or for the entire environment." }, { "info": { "name": "Get Users Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v3/roles", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "ids", "value": "", "type": "query" } ] }, "docs": "Retrieve all user roles for an account (tenant)." }, { "info": { "name": "Get Users Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v3/groups", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "ids", "value": "", "type": "query" } ] }, "docs": "Retrieve all user groups for an account (tenant)." }, { "info": { "name": "Unlock User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v3/me/unlock", "body": { "type": "json", "data": "{}" } }, "docs": "Unlock your user account.\n\nProvide the required information in the request body to unlock the account." }, { "info": { "name": "Invite User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v2", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a user for a specific account (tenant).\n\nInclude the user's information in the request body. The `email` and `metadata` fields are required. The `metadata` field can be empty (e.g., `{}`)." }, { "info": { "name": "Get User Profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v2/me" }, "docs": "Retrieve the profile of a logged-in user.\n\nNo parameters are required.\n\nUse your Frontegg subdomain or custom domain as the host. A user token is required for this route and can be obtained after user authentication." }, { "info": { "name": "Update User Profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v2/me", "body": { "type": "json", "data": "{}" } }, "docs": "Update the profile of a logged-in user.\n\nProvide the updated values in the request body.\n\nUse your Frontegg subdomain or custom domain as the host. A user token is required for this route and can be obtained after user authentication." }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use the V2 route for Invite User. This route is no longer relevant." }, { "info": { "name": "Update User", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "TUpdate a user's information for a specific account (tenant).\n\nInclude the updated user information in the request body." }, { "info": { "name": "Remove User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Remove a user globally or from a specific account (tenant).\n\nAn environment token is required for this route and can be obtained from the environment authentication route." }, { "info": { "name": "Assign Roles to User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/roles", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate roles to a specific user for a specific account (tenant)." }, { "info": { "name": "Unassign Roles From User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/roles", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disassociate roles from a specific user for a specific account (tenant).\n\nInclude the role IDs in the request body as an array of strings." }, { "info": { "name": "Update User's Active Account (tenant)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v1/tenant", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the current account (tenant) for a logged-in user.\n\nUse this endpoint when a user belongs to multiple accounts (tenants) and wants to change the active account (tenant).\n\nInclude the target account (tenant) ID in the request body." }, { "info": { "name": "Get Users with Fuzzy Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v1/query/phrase", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "The default limit is 50 users per request, the maximum is 200" }, { "name": "_identifier", "value": "", "type": "query", "description": "Filter users by username prefix match. Must be provided together with _identifierType" }, { "name": "_identifierType", "value": "", "type": "query", "description": "Filter users by username. Must be provided together with _identifier" }, { "name": "_includeSubTenants", "value": "", "type": "query", "description": "when passing a user id, gives the option to include or not include sub accounts (tenants) when searching users" }, { "name": "_namePrefix", "value": "", "type": "query", "description": "Filter users by prefix name match" }, { "name": "_phraseSearchContains", "value": "", "type": "query", "description": "Pass a list of strings, separated by comma, to search for users that contain all of the strings in the list" }, { "name": "_phraseSearchExcludes", "value": "", "type": "query", "description": "Pass a list of strings, separated by comma, to search for users that do not contain any of the strings in the list" }, { "name": "_phraseSearchOptional", "value": "", "type": "query", "description": "Pass a list of strings, separated by comma, to search for users that contain at least one of the strings in the list" }, { "name": "_phraseSearchApproximate", "value": "", "type": "query", "description": "When true, the search will be approximate (fuzzy), meaning it will include similar characters to the ones in the search string" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_email", "value": "", "type": "query" }, { "name": "_tenantId", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query" }, { "name": "_sortBy", "value": "", "type": "query" }, { "name": "_order", "value": "", "type": "query" }, { "name": "_externalIds", "value": "", "type": "query" } ] }, "docs": "Retrieve all users for a specific account (tenant) or for the entire environment.\n\nIn addition to all standard Get users query parameters, this route supports phrase search, enabling complex queries with options such as `contains`, `excludes`, `optional`, and approximate matching." }, { "info": { "name": "Get Usernames for Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/usernames/v1", "params": [ { "name": "_limit", "value": "", "type": "query" }, { "name": "_offset", "value": "", "type": "query", "description": "The page number to retrieve. For example, use 0 for the first page, 1 for the second page." }, { "name": "_sortBy", "value": "", "type": "query" }, { "name": "_order", "value": "", "type": "query" }, { "name": "_usernamePrefix", "value": "", "type": "query" }, { "name": "userIds", "value": "", "type": "query" }, { "name": "usernames", "value": "", "type": "query" } ] }, "docs": "This route gets usernames for users." }, { "info": { "name": "Create a Username for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/usernames/v1", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This route creates a username for a user." }, { "info": { "name": "Delete a Username for User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/usernames/v1/:username", "params": [ { "name": "username", "value": "", "type": "path" } ] }, "docs": "This route deletes a username for a user." }, { "info": { "name": "Get Authenticated User's Username", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/usernames/v1/me", "headers": [ { "name": "frontegg-tenant-id", "value": "" }, { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Get Authenticated User's Username" }, { "info": { "name": "Update User Email", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/email/me", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This route updates the email for a user." }, { "info": { "name": "Verify User Email", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/email/me/verify", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This route verifies the email for a user." }, { "info": { "name": "Activate User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/activate", "headers": [ { "name": "frontegg-vendor-host", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate a non-activated user.\n\nInclude the `userId` and `activationToken` in the request body. If required by your environment's sign-in flow, also include the user's password and reCAPTCHA values.\n\nYou can generate an activation token using the route under Users → Generate Activation Token.\n\nAlternatively, you can use the built-in email template for user activation." }, { "info": { "name": "Activate User with Code", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/activate/code", "headers": [ { "name": "frontegg-vendor-host", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate a non-activated user.\n\nUse this endpoint to implement a custom activation flow.\n\nInclude the `userId`, `activationToken`, and `code` in the request body. If required by your environment's sign-in flow, also include the user's password and reCAPTCHA values.\n\nYou can generate an activation token using the route under Users → Generate Activation Token.\n\nAlternatively, you can use the built-in email template for user activation." }, { "info": { "name": "Get User Activation Strategy", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v1/activate/strategy", "params": [ { "name": "userId", "value": "", "type": "query" }, { "name": "token", "value": "", "type": "query" } ] }, "docs": "Retrieve a user's activation strategy.\n\nThe activation strategy indicates whether the user needs to set a password.\n\nInclude the `userId` and `activationToken` in the request body. You can generate an activation token using the route under Users → Generate Activation Token.\n\nThe response returns a Boolean field `shouldSetPassword`. If `true`, the user needs to set a password. If `false`, the user does not need to set a password (for example, SSO users do not set passwords)." }, { "info": { "name": "Accept Invitation", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/invitation/accept", "body": { "type": "json", "data": "{}" } }, "docs": "Accept an invitation for a user to join a specific account (tenant).\n\nInclude the `userId` and `invitationToken` in the request body. These values appear as query parameters in the URL that Frontegg sends to the user in the activation email." }, { "info": { "name": "Accept Invitation with Code", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/invitation/accept/code", "body": { "type": "json", "data": "{}" } }, "docs": "Accept an invitation to join a specific account (tenant) using an invitation code.\n\nInclude the required `userId`, `invitationToken`, and `code` in the request body." }, { "info": { "name": "Get User Profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v3/me" }, "docs": "Retrieve the profile of a logged-in user.\n\nNo parameters are required.\n\nUse your Frontegg subdomain or custom domain as the host. A user token is required for this route and can be obtained after user authentication." }, { "info": { "name": "Get User Accounts (tenants)", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v2/me/tenants", "headers": [ { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Retrieve the list of accounts (tenants) that a logged-in user belongs to.\n\nNo parameters are required.\n\nUse your Frontegg subdomain or custom domain as the host. A user token is required for this route and can be obtained after user authentication." }, { "info": { "name": "Get User Accounts (tenants) Hierarchy", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v2/me/hierarchy" }, "docs": "Retrieve the list of accounts (tenants) with hierarchy metadata that a logged-in user belongs to.\n\nIf the user is a member of multiple accounts (tenants) in a hierarchy, some entries may be reduced based on the hierarchy structure.\n\nNo parameters are required.\n\nUse your Frontegg subdomain or custom domain as the host. A user token is required for this route and can be obtained after user authentication." }, { "info": { "name": "Get User Permissions and Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v1/me/authorization" }, "docs": "Retrieve the list of permissions and roles that a logged-in user has.\n\nNo parameters are required.\n\nUse your Frontegg subdomain or custom domain as the host. A user token is required for this route and can be obtained after user authentication." }, { "info": { "name": "Get User Accounts (tenants)", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v1/me/tenants" }, "docs": "Retrieve the list of accounts (tenants) that a logged-in user belongs to.\n\nNo parameters are required.\n\nUse your Frontegg subdomain or custom domain as the host. A user token is required for this route and can be obtained after user authentication." } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Set Temporary Users Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/temporary/v1/configuration", "body": { "type": "json", "data": "{}" } }, "docs": "This route updates the settings for temporary users, use it to enable or disable it for an environment" }, { "info": { "name": "Update User (global)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user’s information globally. Provide the user ID as a path parameter and include the fields to update in the request body. The route supports partial updates—only the provided fields are changed. For identifier fields such as `emails` or `phones`, new items are added instead of replacing existing ones." }, { "info": { "name": "Get User", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/vendor-only/users/v1/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Retrieve a user by ID, regardless of account (tenant).\n\nProvide the user's ID as a path parameter.\n\nThis route is for management use only." }, { "info": { "name": "Unenroll User From MFA Globally", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/vendor-only/users/v1/:userId/mfa/unenroll", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Unenroll a user from MFA, regardless of account (tenant).\n\nProvide the user's ID as a path parameter.\n\nThis route is for manag use only." }, { "info": { "name": "Verify User's Password", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/vendor-only/users/v1/passwords/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verify a user's email and password.\n\nProvide the user's email and password in the request body. The response will indicate `true` or `false`.\n\nThis route is for management use only." }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/vendor-only/users/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Create a user and set the `mfaBypass` property for testing purposes.\n\nThis route is for management use only." }, { "info": { "name": "Get Users Account (tenant) Statuses", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/tenants/users/v1/statuses", "params": [ { "name": "userIds", "value": "", "type": "query", "description": "User IDs" }, { "name": "userTenantStatuses", "value": "", "type": "query", "description": "Account (tenant) Statuses" } ] }, "docs": "Retrieve the account (tenant) statuses of vendor users.\n\nProvide an array of `userIds` (maximum 200) and optionally an array of `userTenantStatuses` as query parameters. There is a limit of 2000 account (tenant) statuses per user." }, { "info": { "name": "Create User Phone Number Verified by Default", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1/vendor/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new phone number for a user. Phone numbers added via this management endpoint are automatically verified." }, { "info": { "name": "Delete User Phone Number on an Environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/phone-numbers/v1/vendor/:userId/:phoneId", "params": [ { "name": "phoneId", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Delete a user phone number without verification." }, { "info": { "name": "Invite Users to an Account (tenant) in Bulk", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/bulk/v1/invite", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite users to an account (tenant) in bulk.\n\nProvide an array of `users` in the request body. Each entry must include a user's `email`." }, { "info": { "name": "Get Status of Bulk Invite Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/bulk/v1/status/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Invite users to an account (tenant) in bulk.\n\nProvide an array of `users` in the request body. Each entry must include a user's `email`." }, { "info": { "name": "Bulk Update User Roles Across All Tenants", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.frontegg.com/identity/resources/vendor-only/users/v1/:userId/roles/bulk", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update User Roles Across All Tenants" }, { "info": { "name": "Get Status of Bulk Roles Update Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/vendor-only/users/v1/bulk-roles/status/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path" } ] }, "docs": "Get Status of Bulk Roles Update Task" }, { "info": { "name": "Get User by Email", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v1/email", "params": [ { "name": "email", "value": "", "type": "query" } ] }, "docs": "Retrieve a user by email.\n\nProvide the user's `email` as a query parameter." }, { "info": { "name": "Get User by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/v1/:id", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a specific user from an account (tenant).\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Verify User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/verify", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Mark a user as verified.\n\nProvide the user's ID as a path parameter.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Make User Invisible", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/invisible", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set whether a user is invisible or visible.\n\nAn invisible user remains part of the account (tenant) but will not appear in the list of users in the admin box. The user data remains in the system.\n\nProvide the user's ID as a path parameter and a Boolean `invisible` value in the request body (`true` for invisible, `false` for visible).\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Make User Super-user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/superuser", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set a user as a super-user.\n\nSuper-user functionality is no longer maintained due to incompatibility with newer features. A super-user has access to all accounts (tenants) within the workspace.\n\nProvide the user's ID as a path parameter and a Boolean `superUser` value in the request body (`true` for super-user, `false` for regular user).\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Add User to Account (tenant)", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/tenant", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user to an account (tenant).\n\nProvide the user's ID as a path parameter and the account (tenant) ID as a `tenantId` value in the request body. To skip sending an invite email, include the optional `skipInviteEmail` parameter in the request body and set it to `true`.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Set User's Account (tenant)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/tenant", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the active account (tenant) of a user.\n\nThe active account (tenant) is the account (tenant) the user will see in their admin portal and the account (tenant) used by default for account (tenant)-specific API routes.\n\nProvide the user's ID as a path parameter and the account (tenant) ID as a `tenantId` value in the request body. If a non-existing account (tenant) ID is provided, an account (tenant) will be created for that ID.\n\nA valid environment token is required to call this endpoint. You c" }, { "info": { "name": "Update User Email", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/email", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a user's email address globally, regardless of account (tenant).\n\nProvide the user's ID as a path parameter and the new email address as an `email` value in the request body." }, { "info": { "name": "Generate Activation Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/links/generate-activation-token", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Generate a new activation token for a user.\n\nProvide the user's ID as a path parameter. This route does not send the activation email but returns the activation link and token. It can be used in combination with the routes under **Users Activation**.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Generate Password Reset Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/links/generate-password-reset-token", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Generate a password reset token for a user.\n\nProvide the user's ID as a path parameter. This route does not send the reset password email but returns the reset link and token. It can be used in combination with the routes under **Users Passwords**.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Unlock User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/unlock", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Unlock a locked user.\n\nAn unlocked user can sign in and use the system globally, regardless of account (tenant). Provide the user's ID as a path parameter.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Lock User", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/users/v1/:userId/lock", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Lock a user.\n\nA locked user cannot sign in or use the system globally, regardless of account (tenant). Provide the user's ID as a path parameter.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." }, { "info": { "name": "Move All Users From One Account (tenant) to Another", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/users/v1/tenants/migrate", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate all users from a source account (tenant) to a target account (tenant).\n\nSpecify `srcTenantId` (source account (tenant) ID) and `targetTenantId` (target account (tenant) ID) in the request body.\n\nA valid environment token is required to call this endpoint. You can obtain it from the environment authentication route." } ] }, { "info": { "name": "User Pools", "type": "folder" }, "items": [ { "info": { "name": "Get Vendor User Sources", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/user-sources/v1" }, "docs": "Retrieve all user sources configured for your environment.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Get Vendor User Source", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a user source by ID.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Delete User Source", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Create Auth0 External User Source", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/external/auth0", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new external user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Create Cognito External User Source", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/external/cognito", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new external user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Create Firebase External User Source", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/external/firebase", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new external user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Create Custom-Code External User Source", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/external/custom-code", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new external user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Create Federation User Source", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/federation", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new federation user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Update Auth0 External User Source", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/external/auth0/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an external user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Update Cognito External User Source", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/external/cognito/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an external user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Update Firebase External User Source", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/external/firebase/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an external user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Update Custom-Code External User Source", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/external/custom-code/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an external user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Update Federation User Source", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/federation/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a federation user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Assign Applications to a User Source", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/assign", "body": { "type": "json", "data": "{}" } }, "docs": "Assign applications to a user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Unassign Applications From a User Source", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/unassign", "body": { "type": "json", "data": "{}" } }, "docs": "Unassign applications from a user source.\n\nA valid environment token is required to call this endpoint." }, { "info": { "name": "Get User Source Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/user-sources/v1/:id/users", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve all users of a user source.\n\nA valid environment token is required to call this endpoint." } ] }, { "info": { "name": "User Sessions", "type": "folder" }, "items": [ { "info": { "name": "Get User's Active Sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/users/sessions/v1/me", "headers": [ { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Retrieve all active sessions for a user." }, { "info": { "name": "Delete All User Sessions", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/sessions/v1/me/all", "headers": [ { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Delete all active sessions for a user." }, { "info": { "name": "Delete Single User's Session", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/users/sessions/v1/me/:id", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a specific active session for a user." } ] }, { "info": { "name": "Users-applications Management", "type": "folder" }, "items": [ { "info": { "name": "Get Users for Application", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/applications/v1/:appId/users", "params": [ { "name": "appId", "value": "", "type": "path" } ] }, "docs": "Retrieve users for an application.\n\nProvide the application ID as a path parameter." }, { "info": { "name": "Get Applications for User", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/applications/v1/:userId/apps", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Retrieve applications for a user.\n\nProvide the user's ID as a path parameter" }, { "info": { "name": "Assign Users to Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/identity/resources/applications/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Assign users to an application.\n\nProvide the application ID as a path parameter and the user IDs in the request body." }, { "info": { "name": "Unassign Users From Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.frontegg.com/identity/resources/applications/v1", "body": { "type": "json", "data": "{}" } }, "docs": "Unassign users from an application.\n\nProvide the application ID as a path parameter and the user IDs in the request body." }, { "info": { "name": "Get User Active Accounts (tenants) in Applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/identity/resources/applications/user-tenants/active/v1", "headers": [ { "name": "frontegg-user-id", "value": "" } ] }, "docs": "Retrieve the active accounts (tenants) of a user for an application.\n\nProvide the application ID and the user ID as path parameters." }, { "info": { "name": "Switch Users Active Account (tenant) in Applications", "type": "http" }, "http": { "method": "PUT", "url": "https://api.frontegg.com/identity/resources/applications/user-tenants/active/v1", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the active accounts (tenants) of a user for an application.\n\nProvide the application ID and the user ID as path parameters and the updated list of account (tenant) IDs in the request body." } ] } ], "bundled": true }