Frontegg User Management API

The User Management API from Frontegg — 42 operation(s) for user management.

Operations 48

POST /resources/tenants/users/v1/{userId}/disable Disable User Account (tenant) #
POST /resources/tenants/users/v1/{userId}/enable Enable User Account (tenant) #
PUT /resources/users/temporary/v1/{userId} Sets a Permanent User to Temporary #
DELETE /resources/users/temporary/v1/{userId} Sets a Temporary User to Permanent #
GET /resources/users/temporary/v1/configuration Gets Temporary Users Configuration #
GET /resources/users/emails/v1 Get All User Emails #
POST /resources/users/emails/v1 Create a User Email #
POST /resources/users/emails/v1/verify Verify User Email #
DELETE /resources/users/emails/v1/{emailId} Delete a User Email #
POST /resources/users/emails/v1/vendor/{userId} Create a User Email for Vendor #
DELETE /resources/users/emails/v1/vendor/{userId}/{emailId} Delete a User Email for Vendor #
POST /resources/users/emails/v1/vendor/{userId}/primary Mark Email as Primary for Vendor #
POST /resources/users/emails/v1/me/primary Mark Email as Primary #
GET /resources/users/emails/v1/me Get Current User`s Emails #
PUT /resources/sub-tenants/users/v1/{userId}/access Set Sub-account Access for a User #
POST /resources/users/v1/activate/reset Reset User Activation Token #
POST /resources/users/v1/invitation/reset Reset Invitation #
POST /resources/users/v1/invitation/reset/all Reset All Invitation Tokens #
GET /resources/users/v3 Get Users #
GET /resources/users/v3/roles Get Users Roles #
GET /resources/users/v3/groups Get Users Groups #
POST /resources/users/v3/me/unlock Unlock User #
POST /resources/users/v2 Invite User #
PUT /resources/users/v2/me Update User Profile #
GET /resources/users/v2/me Get User Profile #
POST /resources/users/v1 Create User #
PUT /resources/users/v1 Update User #
DELETE /resources/users/v1/{userId} Remove User #
POST /resources/users/v1/{userId}/roles Assign Roles to User #
DELETE /resources/users/v1/{userId}/roles Unassign Roles From User #
PUT /resources/users/v1/tenant Update User's Active Account (tenant) #
GET /resources/users/v1/query/phrase Get Users with Fuzzy Search #
GET /resources/usernames/v1 Get Usernames for Users #
POST /resources/usernames/v1 Create a Username for User #
DELETE /resources/usernames/v1/{username} Delete a Username for User #
GET /resources/usernames/v1/me Get Authenticated User's Username #
POST /resources/users/v1/email/me Update User Email #
POST /resources/users/v1/email/me/verify Verify User Email #
POST /resources/users/v1/activate Activate User #
POST /resources/users/v1/activate/code Activate User with Code #
GET /resources/users/v1/activate/strategy Get User Activation Strategy #
POST /resources/users/v1/invitation/accept Accept Invitation #
POST /resources/users/v1/invitation/accept/code Accept Invitation with Code #
GET /resources/users/v3/me Get User Profile #
GET /resources/users/v2/me/tenants Get User Accounts (tenants) #
GET /resources/users/v2/me/hierarchy Get User Accounts (tenants) Hierarchy #
GET /resources/users/v1/me/authorization Get User Permissions and Roles #
GET /resources/users/v1/me/tenants Get User Accounts (tenants) #

Documentation

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/frontegg-user-management-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

frontegg-user-management-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Frontegg User Management API
  version: '1.0'
  description: 'Operations tagged User Management across 2 of this provider''s published API definitions: frontegg-combined-openapi.yml, frontegg-identity-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.frontegg.com/identity
  description: EU Region
- url: https://api.us.frontegg.com/identity
  description: US Region
- url: https://api.ca.frontegg.com/identity
  description: CA Region
- url: https://api.au.frontegg.com/identity
  description: AU Region
- url: https://{domain}.frontegg.com/identity
  description: Frontegg sub-domain for use with user tokens
  variables:
    domain:
      default: app-xxx
tags:
- name: User Management
  x-displayName: User management
paths:
  /resources/tenants/users/v1/{userId}/disable:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UsersTenantsControllerV1_disableUserTenant
      summary: Disable User Account (tenant)
      description: 'Disable a user for an account (tenant).


        A disabled user cannot log in to the account (tenant) or use the system.


        Provide the user''s ID as a path parameter.'
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      - name: frontegg-tenant-id
        in: header
        description: The tenant identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
        '201':
          description: ''
        '403':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/tenants/users/v1/{userId}/enable:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UsersTenantsControllerV1_enableUserTenant
      summary: Enable User Account (tenant)
      description: 'Enable a disabled user for an account (tenant).


        An enabled user can log in and use the system.


        Provide the user''s ID as a path parameter.'
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      - name: frontegg-tenant-id
        in: header
        description: The tenant identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
        '201':
          description: ''
        '403':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/temporary/v1/{userId}:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    put:
      operationId: TemporaryUsersV1Controller_editTimeLimit
      summary: Sets a Permanent User to Temporary
      description: 'Update the settings for temporary users.


        Use this route to enable or disable temporary users for your environment'
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemporaryUserDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryUserDto'
      tags:
      - User Management
      security:
      - bearer: []
    delete:
      operationId: TemporaryUsersV1Controller_setUserPermanent
      summary: Sets a Temporary User to Permanent
      description: 'Set an existing temporary user as permanent.


        Provide the user''s ID as a path parameter.'
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/temporary/v1/configuration:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    get:
      operationId: TemporaryUsersV1Controller_getConfiguration
      summary: Gets Temporary Users Configuration
      description: 'Retrieve the settings for temporary users.


        Use this endpoint to check whether the policy is enabled or disabled.'
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryUsersConfigurationDto'
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/emails/v1:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    get:
      operationId: UserEmailsControllerV1_getAllEmails
      summary: Get All User Emails
      description: 'This route returns all user emails. '
      parameters:
      - name: _limit
        required: false
        in: query
        schema:
          minimum: 1
          type: number
      - name: _offset
        required: false
        in: query
        schema:
          minimum: 0
          type: number
        description: The page number to retrieve. For example, use 0 for the first page, 1 for the second page.
      - name: _sortBy
        required: false
        in: query
        schema:
          enum:
          - userId
          - email
          type: string
      - name: _order
        required: false
        in: query
        schema:
          enum:
          - ASC
          - DESC
          type: string
      - name: _email
        required: false
        in: query
        schema:
          type: string
      - name: userIds
        required: false
        in: query
        schema:
          type: string
      - name: frontegg-tenant-id
        in: header
        description: The tenant ID identifier
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/FronteggPaginationWrapper'
                - properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/UserEmailResponseDto'
                    _links:
                      $ref: '#/components/schemas/FronteggPaginationLinks'
                    _metadata:
                      $ref: '#/components/schemas/FronteggPaginationMetadata'
      tags:
      - User Management
      security:
      - bearer: []
    post:
      operationId: UserEmailsControllerV1_createUserEmail
      summary: Create a User Email
      description: This route creates a user email.
      parameters:
      - name: frontegg-tenant-id
        in: header
        description: The tenant identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserEmailRequestDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEmailResponseDto'
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEmailResponseDto'
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/emails/v1/verify:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UserEmailsControllerV1_verifyUserEmail
      summary: Verify User Email
      description: This route verifies a user email.
      parameters:
      - name: frontegg-tenant-id
        in: header
        description: The tenant identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserEmailVerifyRequestDto'
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/emails/v1/{emailId}:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    delete:
      operationId: UserEmailsControllerV1_deleteUserEmail
      summary: Delete a User Email
      description: This route deletes a user email.
      parameters:
      - name: emailId
        required: true
        in: path
        schema:
          type: string
      - name: frontegg-tenant-id
        in: header
        description: The tenant identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens
        required: false
        schema:
          type: string
      - name: frontegg-user-id
        in: header
        description: The user ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/emails/v1/vendor/{userId}:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UserEmailsControllerV1_createUserEmailForVendor
      summary: Create a User Email for Vendor
      description: Creates a new email address for a user.
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserEmailVendorRequestDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEmailResponseDto'
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEmailResponseDto'
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/emails/v1/vendor/{userId}/{emailId}:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    delete:
      operationId: UserEmailsControllerV1_deleteUserEmailForVendor
      summary: Delete a User Email for Vendor
      description: This route deletes a user email.
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      - name: emailId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/emails/v1/vendor/{userId}/primary:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UserEmailsControllerV1_markEmailAsPrimary
      summary: Mark Email as Primary for Vendor
      description: This route marks an email as primary.
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkEmailAsPrimaryRequestDto'
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/emails/v1/me/primary:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UserEmailsControllerV1_markEmailAsPrimaryMe
      summary: Mark Email as Primary
      description: This route marks an email as primary.
      parameters:
      - name: frontegg-tenant-id
        in: header
        description: The tenant identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkEmailAsPrimaryRequestDto'
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/emails/v1/me:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    get:
      operationId: UserEmailsControllerV1_getUserOwnEmails
      summary: Get Current User`s Emails
      description: This route returns all user emails for the current user.
      parameters:
      - name: frontegg-tenant-id
        in: header
        description: The tenant identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens
        required: false
        schema:
          type: string
      - name: frontegg-user-id
        in: header
        description: The user ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserEmailResponseDto'
      tags:
      - User Management
      security:
      - bearer: []
  /resources/sub-tenants/users/v1/{userId}/access:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    put:
      operationId: UsersControllerV1_setUserRolesFromSubTenants
      summary: Set Sub-account Access for a User
      description: 'Set sub-account access for a user.


        Use this endpoint to enable or disable sub-account access by setting the value to `true` or `false`.'
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubAccountAccessRequestDto'
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/v1/activate/reset:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UsersActivationControllerV1_resetActivationToken
      summary: Reset User Activation Token
      description: 'Reset the activation token for a user and trigger a new activation email.


        Provide the user''s ID as a path parameter.'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetActivationTokenDto'
      responses:
        '201':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/v1/invitation/reset:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UsersTenantManagementControllerV1_resetTenantInvitationToken
      summary: Reset Invitation
      description: 'Reset an invitation for a user to join a specific account (tenant).


        The response includes a new invitation link with a new token.'
      parameters:
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetTenantInvitationDto'
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/v1/invitation/reset/all:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UsersTenantManagementControllerV1_resetAllTenantsInvitationToken
      summary: Reset All Invitation Tokens
      description: 'Reset all invitations for a user to join all sub-accounts (tenants) that currently have an invitation token.


        The response includes new invitation links with new tokens.'
      parameters:
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetTenantInvitationDto'
      responses:
        '200':
          description: ''
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/v3:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    get:
      operationId: UsersControllerV3_getUsers
      summary: Get Users
      description: Retrieve all users for an account (tenant) or for the entire environment.
      parameters:
      - name: _limit
        required: false
        in: query
        description: The default limit is 50 users per request, the maximum is 200
        schema:
          type: number
      - name: _identifier
        required: false
        in: query
        description: Filter users by username prefix match. Must be provided together with _identifierType
        schema:
          type: string
      - name: _identifierType
        required: false
        in: query
        description: Filter users by username. Must be provided together with _identifier
        schema:
          enum:
          - email
          - phoneNumber
          - username
          type: string
      - name: _includeSubTenants
        required: false
        in: query
        description: when passing a user id, gives the option to include or not include sub accounts (tenants) when searching users
        schema:
          default: true
          type: boolean
      - name: _namePrefix
        required: false
        in: query
        description: Filter users by prefix name match
        schema:
          type: string
      - name: _offset
        required: false
        in: query
        schema:
          minimum: 0
          type: number
        description: The page number to retrieve. For example, use 0 for the first page, 1 for the second page.
      - name: _email
        required: false
        in: query
        schema:
          type: string
      - name: _tenantId
        required: false
        in: query
        schema:
          type: string
      - name: ids
        required: false
        in: query
        schema:
          type: string
      - name: _sortBy
        required: false
        in: query
        schema:
          enum:
          - createdAt
          - name
          - email
          - id
          - verified
          - isLocked
          - provider
          - tenantId
          type: string
      - name: _order
        required: false
        in: query
        schema:
          enum:
          - ASC
          - DESC
          type: string
      - name: _externalIds
        required: false
        in: query
        schema:
          type: string
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/FronteggPaginationWrapper'
                - properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/UserV3Dto'
                    _links:
                      $ref: '#/components/schemas/FronteggPaginationLinks'
                    _metadata:
                      $ref: '#/components/schemas/FronteggPaginationMetadata'
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/v3/roles:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    get:
      operationId: UsersControllerV3_getUsersRoles
      summary: Get Users Roles
      description: Retrieve all user roles for an account (tenant).
      parameters:
      - name: ids
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserRolesResponse'
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/v3/groups:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    get:
      operationId: UsersControllerV3_getUsersGroups
      summary: Get Users Groups
      description: Retrieve all user groups for an account (tenant).
      parameters:
      - name: ids
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: frontegg-tenant-id
        in: header
        description: The account (tenant) ID identifier
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserGroupsResponse'
      tags:
      - User Management
      security:
      - bearer: []
  /resources/users/v3/me/unlock:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UsersControllerV3_unlock
      summary: Unlock User
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnlockUserRequestDto'
      responses:
        '200':
          description: ''
      tags:
      - User Management
      description: 'Unlock your user account.


        Provide the required information in the request body to unlock the account.'
      security:
      - bearer: []
  /resources/users/v2:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: UsersControllerV2_createUser
      summary: Invite User
      description: 'Create a user for a specific account (tenant).


        Include the user''s information in the request body. The `email` and `metadata` fields are required. The `metadata` field can be empty (e.g., `{}`).'
      parameters:
      - name: frontegg-tenant-id
        in: header
        de

# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/frontegg/refs/heads/main/openapi/frontegg-user-management-api-openapi.yml