Identity Management (1.0)

Download OpenAPI description

Users, Auth and Security

SCIM Provisioning

Entitlements Agent

Accounts (Tenants)

Overview

Servers

EU Region

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

US Region

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

CA Region

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

AU Region

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

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

API token

Operations

General

Operations

MFA

Operations

Users

Operations

Get user profile

Request

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

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

Responses

Bodyapplication/json

idstringrequired

emailstringrequired

namestring

profilePictureUrlstring

substringrequired

verifiedbooleanrequired

mfaEnrolledbooleanrequired

mfaBypassboolean

phoneNumberstring

providerstringrequired

tenantIdstringrequired

tenantIdsArray of stringsrequired

activatedForTenantboolean

isLockedboolean

tenantsArray of objects(UserTenantDto)required

tenants[].tenantIdstringrequired

tenants[].rolesArray of objects(RoleResponse)required

tenants[].roles[].idstringrequired

tenants[].roles[].vendorIdstringrequired

tenants[].roles[].tenantIdstringrequired

tenants[].roles[].keystringrequired

tenants[].roles[].namestringrequired

tenants[].roles[].descriptionstringrequired

tenants[].roles[].isDefaultbooleanrequired

tenants[].roles[].firstUserRolebooleanrequired

tenants[].roles[].levelnumberrequired

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

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

tenants[].roles[].permissionsArray of stringsrequired

tenants[].temporaryExpirationDatestring(date-time)

invisibleboolean

superUserboolean

metadatastringrequired

vendorMetadatastringrequired

createdAtstring(date-time)required

lastLoginstring(date-time)required

subAccountAccessAllowedbooleanrequired

managedBystring

Enum"frontegg""scim2""external"

Response

application/json

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