LoginRadius

https://www.loginradius.com/docs/
Admin
LoginRadius is a fully-managed Customer Identity and Access Management (IAM) platform that helps...
Tokens:28,062
Snippets:376
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### cURL Request Example

Source: https://www.loginradius.com/docs/api/openapi/get-email-templates

Example of how to make a GET request to the List Email Templates endpoint using cURL. Replace placeholders with your actual values.

```bash
curl -X GET \
  'https://api.loginradius.com/v2/manage/email-templates' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
```

--------------------------------

### API Request Signing Example Headers

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Example headers for API request signing, including Content-Type, API Key, Request Expiry, and the generated Digest.

```HTTP
Content-Type: application/json    
X-LoginRadius-ApiKey: <YOUR_API_KEY>    
X-Request-Expires: 2025-03-20 18:30:00    
Digest: SHA-256: <GENERATED_HASH>  
```

--------------------------------

### Error Response Example

Source: https://www.loginradius.com/docs/api/openapi/get-enabled-providers

This example shows the structure of a typical error response when access to the endpoint is forbidden. It includes a message, description, and error code.

```json
{
  "Message": "Access Unauthorized",
  "Description": "Access Unauthorized, please use valid authorization to access this endpoint.",
  "ErrorCode": 6002
}
```

--------------------------------

### Example Payload for Null Value Support

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Demonstrates how to send a null value for a specific field in the API payload when null support is enabled.

```json
{"FirstName": null}
```

--------------------------------

### Retrieve Custom OAuth Provider Keys

Source: https://www.loginradius.com/docs/api/openapi/get-custom-provider-keys

Use this endpoint to get all custom OAuth provider keys configured for your tenant. Ensure you have the necessary permissions.

```bash
GET
## /v2/manage/custom-providers/oauth/keys
```

--------------------------------

### cURL Example for Impersonation Token

Source: https://www.loginradius.com/docs/api/openapi/get-impersonation-token

This cURL command demonstrates how to request an impersonation token. Replace placeholders with your actual API key, secret, and the target user's UID.

```bash
curl -X GET \
  'https://api.loginradius.com/identity/v2/manage/account/access_token?uid=43e4417bd2de4a1fa82445274f864203' \
  -H 'X-api-key: YOUR_API_KEY' \
  -H 'X-api-secret: YOUR_API_SECRET'
```

--------------------------------

### List Supported JWT Algorithms

Source: https://www.loginradius.com/docs/api/openapi/get-jwt-client-supported-algo-list

Use this endpoint to get a list of all supported cryptographic algorithms for JWT clients. This is useful for configuring JWT-based Identity Providers.

```bash
GET
/v2/manage/jwt-clients/algo
```

--------------------------------

### Retrieve Enabled Social Providers

Source: https://www.loginradius.com/docs/api/openapi/get-enabled-providers

Use this endpoint to get a list of all social providers that are currently enabled for your tenant. This is useful for displaying available login options to your users.

```bash
GET
/v2/manage/providers/active
```

--------------------------------

### Retrieve Invitation Details

Source: https://www.loginradius.com/docs/api/openapi/get-invitation

Use this endpoint to get details for a specific invitation using its token. Ensure the invitation token is valid and exists.

```http
GET /identity/v2/auth/invitations/:invitation_token
```

```http
GET https://api.loginradius.com/identity/v2/auth/invitations/inv_aH840_snjODabaji
```

--------------------------------

### Constructing the Signing String for Request Signing

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Build the signing string by concatenating request expiry, encoded URL, and JSON payload. Leave JSON_Payload empty for GET requests.

```string
signingString = X-Request-Expires + ":" + Encoded_URL + ":" + JSON_Payload
```

--------------------------------

### Get Invitation by Invitation ID

Source: https://www.loginradius.com/docs/api/openapi/get-invitation-by-invitation-id

Fetches the details of an invitation based on its ID.

```APIDOC
## GET /v2/manage/invitations/{invitationid}

### Description
Retrieves the details of a specific invitation using its unique ID.

### Method
GET

### Endpoint
/v2/manage/invitations/{invitationid}

### Parameters
#### Path Parameters
- **invitationid** (string) - Required - The unique identifier of the invitation.

### Response
#### Success Response (200)
- **ErrorCode** (integer) - The error code, if any.

### Response Example
```json
{
  "ErrorCode": 7909
}
```
```

--------------------------------

### Get Invitation by Invitation ID

Source: https://www.loginradius.com/docs/api/openapi/get-invitation-by-invitation-id

Fetches the details of an invitation using its unique identifier.

```APIDOC
## GET /api/openapi/get-invitation-by-invitation-id

### Description
Retrieves the details of a specific invitation using its unique ID.

### Method
GET

### Endpoint
https://api.loginradius.com/api/openapi/get-invitation-by-invitation-id

### Parameters
#### Path Parameters
- **invitationId** (string) - Required - The unique identifier of the invitation.

### Authentication
APIKey + APISecret
ClientId + ClientSecret
M2M Bearer Token

### Response
#### Success Response (200)
- **invitation** (object) - Contains the invitation details.
  - **id** (string) - The unique identifier of the invitation.
  - **email** (string) - The email address associated with the invitation.
  - **status** (string) - The current status of the invitation (e.g., 'Pending', 'Accepted', 'Expired').
  - **createdAt** (string) - The timestamp when the invitation was created.
  - **expiresAt** (string) - The timestamp when the invitation will expire.
  - **invitedBy** (string) - The identifier of the user who sent the invitation.
  - **customData** (object) - Any custom data associated with the invitation.

#### Response Example
{
  "invitation": {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "email": "user@example.com",
    "status": "Pending",
    "createdAt": "2023-10-27T10:00:00Z",
    "expiresAt": "2023-11-26T10:00:00Z",
    "invitedBy": "admin_user_id",
    "customData": {
      "role": "editor"
    }
  }
}
```

--------------------------------

### Password Compliance Check Response

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Example response from a password compliance check, indicating whether the provided password meets the security policy. Prompt users to reset passwords if 'IsSecurePassword' is false.

```json
{ "IsSecurePassword": false}
```

--------------------------------

### Retrieve Impersonation Token

Source: https://www.loginradius.com/docs/api/openapi/get-impersonation-token

Use this endpoint to get an impersonation token for a specific account UID. Ensure you provide the required 'uid' parameter.

```http
GET
## /identity/v2/manage/account/access_token
```

--------------------------------

### Get Invitation by Invitation ID

Source: https://www.loginradius.com/docs/api/openapi/get-invitation-by-invitation-id

Retrieves the details of an invitation using its unique ID.

```APIDOC
## GET /invitation/{invitationId}

### Description
Retrieves the details of an invitation using its unique ID.

### Endpoint
/invitation/{invitationId}

### Parameters
#### Path Parameters
- **invitationId** (string) - Required - The unique identifier for the invitation.

### Response
#### Success Response (200)
- **Id** (string) - The unique identifier for the invitation.
- **EmailId** (string) - The Email address of the User to whom the invitation is sent.
- **Status** (string) - The status of the invitation. Possible values are `invited`, `accepted`, `expired`, and `revoked`.
- **RoleIds** (string[]) - The list of Role IDs associated with the invitation.
- **OrgId** (string) - The unique identifier for the organization associated with the invitation.
- **CreatedDate** (date-time) - The date and time when the invitation was created, UTC format.
- **ExpirationDate** (date-time) - The date and time when the invitation expires, UTC format.
- **ModifiedDate** (date-time) - The date and time when the invitation was last modified, UTC format.
- **InviterUid** (string) - The unique identifier for the User who sent the invitation.

#### Response Example
```json
{
  "Id": "inv_123456789",
  "EmailId": "user@example.com",
  "Status": "invited",
  "RoleIds": ["role_12345","role_56789"],
  "OrgId": "org_123456789",
  "CreatedDate": "2023-01-01T00:00:00Z",
  "ExpirationDate": "2023-01-01T00:00:00Z",
  "ModifiedDate": "2023-01-01T00:00:00Z",
  "InviterUid": "123456789"
}
```

### Error Handling
#### Bad Request (400)
- **Schema**: Contains `Message`, `Description`, `ErrorCode`, and `Code`.
- **Error Codes**: `INVITATION_ID_REQUIRED`, `INVALID_INVITATION_ID`, `B2B_NOT_ENABLED`.

#### Forbidden (403)
- **Schema**: Contains `Message`, `Description`, `ErrorCode`, and `Code`.
- **Error Codes**: `UNAUTHORIZED_ACCESS`, `ORGANIZATION_NOT_ACTIVE`.

#### Not Found (404)
- **Schema**: Contains `Message`, `Description`, `ErrorCode`, and `Code`.
- **Error Codes**: `INVITATION_NOT_FOUND`, `ORGANIZATION_NOT_FOUND`.

#### Internal Server Error (500)
- **Schema**: Contains `Message`, `Description`, `ErrorCode`, and `Code`.
- **Error Codes**: `OPERATION_FAILED`.
```

--------------------------------

### List JWT Data Mapping Fields

Source: https://www.loginradius.com/docs/api/openapi/get-jwt-client-data-mapping-fields-list

Use this endpoint to get a list of data mapping fields for JWT-based IdP integrations. This includes all fields supported for mapping JWT claims to User profile attributes.

```bash
GET
## /v2/manage/jwt-clients/data-mapping
```

--------------------------------

### Get Custom Object by UID and Record ID

Source: https://www.loginradius.com/docs/api/openapi/get-custom-object-by-uidnd-record-id

This snippet demonstrates how to retrieve a custom object record using the user's UID and the object's record ID.

```APIDOC
## GET /customobject/{objectName}/{uid}/{objectRecordID}

### Description
Retrieves a specific custom object record for a given user.

### Method
GET

### Endpoint
/customobject/{objectName}/{uid}/{objectRecordID}

### Parameters
#### Path Parameters
- **objectName** (string) - Required - The name of the custom object.
- **uid** (string) - Required - The unique identifier of the user.
- **objectRecordID** (string) - Required - The ID of the custom object record.

#### Query Parameters
- **customobjectid** (string) - Optional - A specific custom object ID to filter by (if different from the path parameter).

### Authentication
APIKey + APISecret OR ClientId + ClientSecret OR M2M Bearer Token + XRequestExpiresTime
```

--------------------------------

### Get Custom Object by UID and Record ID

Source: https://www.loginradius.com/docs/api/openapi/get-custom-object-by-uidnd-record-id

This operation retrieves a custom object using the user's unique identifier (UID) and the specific record ID of the custom object.

```APIDOC
## GET /api/v2/identity/{uid}/customobject/{objectName}/{id}

### Description
Retrieves a specific custom object by its unique identifier (UID) and the custom object's record ID.

### Method
GET

### Endpoint
/api/v2/identity/{uid}/customobject/{objectName}/{id}

### Parameters
#### Path Parameters
- **uid** (string) - Required - The unique identifier of the user.
- **objectName** (string) - Required - The name of the custom object.
- **id** (string) - Required - The record ID of the custom object.

### Response
#### Success Response (200)
- **IsActive** (boolean) - Indicates if the custom object is active.
- **IsDeleted** (boolean) - Indicates if the custom object is deleted.
- **CustomObject** (object) - The custom object data. Properties can be of any type.
- **Id** (string) - The record ID of the custom object.
- **Uid** (string) - The unique identifier of the user associated with the custom object.
- **DateCreated** (date-time) - The date and time when the custom object was created.
- **DateModified** (date-time) - The date and time when the custom object was last modified.

#### Response Example
```json
{
  "IsActive": true,
  "IsDeleted": false,
  "CustomObject": {
    "firstName": "John",
    "lastName": "Doe",
    "age": 30
  },
  "Id": "abc123",
  "Uid": "user456",
  "DateCreated": "2024-05-28T12:34:56Z",
  "DateModified": "2024-05-29T09:10:11Z"
}
```

#### Error Response (400)
- **ErrorCode** (integer) - The error code.
- **Message** (string) - A brief message describing the error.
- **Description** (string) - A detailed description of the error.
- **Code** (integer, nullable) - The HTTP status code associated with the error.

#### Error Response Example (API_SIGNATURE_INVALID)
```json
{
  "ErrorCode": 1208,
  "Message": "API signature is invalid",
  "Description": "The API signature is invalid, please use a valid API signature parameter in order to process this request."
}
```

#### Error Response (401)
- **ErrorCode** (integer) - The error code.
- **Message** (string) - A brief message describing the error.
- **Description** (string) - A detailed description of the error.
- **Code** (integer, nullable) - The HTTP status code associated with the error.

#### Error Response Example (API_SECRET_NOT_VALID)
```json
{
  "ErrorCode": 902,
  "Message": "The API secret is unauthorized",
  "Description": "The provided LoginRadius API secret is invalid or is not authorized, please use a valid or authorized LoginRadius API secret or check the API secret for your LoginRadius account."
}
```

#### Error Response (403)
- **ErrorCode** (integer) - The error code.
- **Message** (string) - A brief message describing the error.
- **Description** (string) - A detailed description of the error.
- **Code** (integer, nullable) - The HTTP status code associated with the error.
```

--------------------------------

### List Email Templates

Source: https://www.loginradius.com/docs/api/openapi/get-email-templates

Use this endpoint to retrieve all email templates configured for your tenant. Ensure you have the necessary permissions.

```bash
GET
## /v2/manage/email-templates
```

--------------------------------

### Get Identities

Source: https://www.loginradius.com/docs/api/openapi/get-identities

Retrieves a list of identities associated with an account.

```APIDOC
## GET /identity/v2/manage/account/identities

### Description
Retrieves a list of identities associated with an account.

### Method
GET

### Endpoint
/identity/v2/manage/account/identities

### Parameters
#### Query Parameters
- **apikey** (string) - Required - The LoginRadius API key.
- **apiversion** (string) - Optional - The API version.
- **fields** (string) - Optional - Specifies the fields to be included in the response.

### Response
#### Success Response (200)
- **Identities** (array) - A list of identity objects.
  - **Provider** (string) - The identity provider.
  - **Type** (string) - The type of identity.
  - **UserID** (string) - The user ID for the identity.
  - **Email** (array) - A list of email addresses associated with the identity.
    - **Value** (string) - The email address.
    - **Type** (string) - The type of email address.
  - **Phone** (array) - A list of phone numbers associated with the identity.
    - **Value** (string) - The phone number.
    - **Type** (string) - The type of phone number.
  - **ProfileData** (object) - Additional profile data.

#### Response Example
```json
{
  "Identities": [
    {
      "Provider": "LoginRadius",
      "Type": "Email",
      "UserID": "some-user-id",
      "Email": [
        {
          "Value": "user@example.com",
          "Type": "Primary"
        }
      ],
      "Phone": [],
      "ProfileData": {}
    }
  ]
}
```

### Error Handling
- **400 Bad Request**: Invalid request parameters.
- **401 Unauthorized**: Invalid API key or insufficient permissions.
- **403 Forbidden**: The client does not have permission to access the resource.

#### Error Codes
- **901**: API_KEY_NOT_VALID - The provided LoginRadius API key is invalid or is not authorized.
- **1077**: PHONE_NUMBER_LOGIN_ENABLED - Phone number login is enabled, so login or get Profile by email ID is unavailable.
- **1023**: EMAIL_ID_NOT_EXISTS - The provided email address does not exist.
```

--------------------------------

### Authenticate with Access Token via Query String

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Useful for testing or simple integrations. Pass the access token in the query string.

```URL
...?access_token= <ACCESS_TOKEN>&apikey=<API_KEY>
```

--------------------------------

### Get Identities

Source: https://www.loginradius.com/docs/api/openapi/get-identities

Retrieves identity information for a user based on their email.

```APIDOC
## GET /api/v2/identity

### Description
Retrieves identity information for a user based on their email.

### Method
GET

### Endpoint
https://api.loginradius.com/api/v2/identity

### Query Parameters
- **email** (string) - Required - The email address of the user.
- **fields** (string) - Optional - Specifies which fields to return in the response.

### Authentication
- APIKey + APISecret
- ClientId + ClientSecret
- M2MBearerToken
- Digest + XRequestExpiresTime

### Request Example
```
GET https://api.loginradius.com/api/v2/identity?email=test@example.com&fields=profile,email
```

### Response
#### Success Response (200)
- **profile** (object) - User profile information.
- **email** (array) - User's email addresses.

#### Response Example
```json
{
  "Profile": {
    "Email": [
      {
        "Value": "test@example.com",
        "Type": "Primary"
      }
    ],
    "FirstName": "Test",
    "LastName": "User"
  },
  "Email": [
    {
      "Value": "test@example.com",
      "Type": "Primary"
    }
  ]
}
```
```

--------------------------------

### Retrieve JWT IdP Configuration

Source: https://www.loginradius.com/docs/api/openapi/get-jwt-client-id-p-configuration-by-app-name

Use this endpoint to fetch the details of a JWT-based Identity Provider configuration for your tenant. Requires the JWT Client Name as a path parameter.

```bash
GET
/v2/manage/jwt-clients/:jwtClientName
```

--------------------------------

### GET /identity/v2/manage/account/identities

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Retrieves all identities linked to a specified email. This endpoint is useful for managing user accounts and understanding their associated identity information.

```APIDOC
## GET /identity/v2/manage/account/identities

### Description
Retrieves all identities linked to a specified email.

### Method
GET

### Endpoint
/identity/v2/manage/account/identities

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your LoginRadius API Key.
- **apisecret** (string) - Required - Your LoginRadius API Secret.
- **email** (string) - Required - The email address of the user.

### Request Example
```curl
curl -X GET "https://api.loginradius.com/identity/v2/manage/account/identities?apikey=YOUR_API_KEY&apisecret=YOUR_API_SECRET&email=user@example.com" -H "Accept: application/json"
```
```

--------------------------------

### Retrieve Duo Configuration

Source: https://www.loginradius.com/docs/api/openapi/get-duo-authenticator-configuration

Retrieves the Duo Authentication configuration for a specific Tenant.

```APIDOC
## GET /v2/manage/2fa/duo-authenticator-settings

### Description
Retrieves the Duo Authentication configuration for a specific Tenant.

### Method
GET

### Endpoint
/v2/manage/2fa/duo-authenticator-settings

### Responses
#### Success Response (200)
OK: The request was successful.

#### Error Responses
- **403** Forbidden: The client does not have permission to access the resource.
- **404** Not Found: The server cannot find the requested resource.
```

--------------------------------

### List Email Templates

Source: https://www.loginradius.com/docs/api/openapi/get-email-templates

Retrieves all Email templates configured for the Tenant.

```APIDOC
## GET /v2/manage/email-templates

### Description
Retrieves all Email templates configured for the Tenant.

### Method
GET

### Endpoint
/v2/manage/email-templates

### Responses
#### Success Response (200)
OK: The request was successful.

#### Error Responses
- **403**: Forbidden: The client does not have permission to access the resource.
- **404**: Not Found: The server cannot find the requested resource.
- **500**: Internal Server Error: The server encountered an unexpected error.
```

--------------------------------

### Domain Restriction Configuration Not Found Error Response

Source: https://www.loginradius.com/docs/api/openapi/get-domain-access-restrictions-by-app-id

This response is returned when the domain access restriction configuration is not found or the resource does not exist. Ensure the configuration has been set up.

```json
{
  "Message": "Domain access restriction configuration not found.",
  "Description": "Domain access restriction configuration is not configured or the resource does not exist.",
  "ErrorCode": 8111
}
```

--------------------------------

### Authenticate with Access Token via Header

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Recommended method for secure, server-side requests. Pass the access token in the Authorization header.

```HTTP
Authorization: Bearer <ACCESS_TOKEN>
```

--------------------------------

### Get Identities

Source: https://www.loginradius.com/docs/api/openapi/get-identities

Retrieves a list of user identities. The response includes social information but not login details. Supports standard HTTP response codes for success and errors.

```APIDOC
## Get Identities

### Description
Retrieves a list of user identities, including social information but without login details. The response includes details about the user's profile, activity status, and social connections.

### Method
GET

### Endpoint
/api/v1/identities

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of identities to return.
- **startIndex** (integer) - Optional - The starting index for pagination.

### Response
#### Success Response (200)
- **Data** (array of objects) - A list of user identities. Each object contains various boolean, integer, and string fields detailing the user's profile and activity.

**Schema for each identity object:**
- **IsPasswordBreached** (boolean) - Indicates if the Password has been breached.
- **IsActive** (boolean) - Indicates if the User Account is active.
- **IsDeleted** (boolean) - Indicates if the User Account is deleted.
- **EmailVerified** (boolean) - Indicates if the User's Email is verified.
- **IsLoginLocked** (boolean) - Indicates if the User's login is locked.
- **IsRequiredFieldsFilledOnce** (boolean) - Indicates if required fields have been filled at least once.
- **FirstLogin** (boolean, nullable) - Indicates if this is the User's first login.
- **IsProtected** (boolean) - Indicates if the User Account is protected.
- **Hireable** (boolean) - Indicates if the User is hireable.
- **IsSecurePassword** (boolean, nullable) - Indicates if the Password is secure.
- **IsCustomUid** (boolean) - Indicates if the UID is custom.
- **PhoneIdVerified** (boolean) - Indicates if the Phone ID is verified.
- **IsEmailSubscribed** (boolean) - Indicates if the User is subscribed to emails.
- **NoOfLogins** (integer) - Number of logins by the User.
- **FollowersCount** (integer) - Number of followers the User has.
- **FriendsCount** (integer) - Number of friends the User has.
- **TotalStatusesCount** (integer) - Total number of statuses posted by the User.
- **NumRecommenders** (integer) - Number of recommenders for the User.
- **TotalPrivateRepository** (integer) - Total number of private repositories.
- **PublicGists** (integer) - Total number of public gists.
- **PrivateGists** (integer) - Total number of private gists.
- **PinsCount** (integer) - Total number of PINs.
- **BoardsCount** (integer) - Total number of boards.
- **LikesCount** (integer) - Total number of likes.
- **ID** (string) - Unique identifier for the User Profile.
- **Provider** (string) - Provider of the User Profile.
- **FullName** (string, nullable) - Full name of the User.
- **FirstName** (string, nullable) - First name of the User.
- **LastName** (string, nullable) - Last name of the User.
- **PhoneId** (string, nullable) - Phone ID of the User.
- **UserName** (string, nullable) - The Username of the User.
- **Prefix** (string, nullable) - The prefix for the User's name.
- **MiddleName** (string, nullable) - The middle name of the User.
- **Suffix** (string, nullable) - The suffix for the User's name.
- **NickName** (string, nullable) - The nickname of the User.
- **ProfileName** (string, nullable) - The profile name of the User.
- **BirthDate** (string, nullable) - The birth date of the User.
- **Gender** (string, nullable) - The gender of the User.
- **Website** (string, nullable) - The website of the User.
- **ThumbnailImageUrl** (string, nullable) - The URL of the User's thumbnail image.
- **ImageUrl** (string, nullable) - The URL of the User's profile image.
- **Favicon** (string, nullable) - The URL of the User's favicon.
- **ProfileUrl** (string, nullable) - The URL of the User's profile.
- **HomeTown** (string, nullable) - The hometown of the User.
- **State** (string, nullable) - The state of the User.
- **City** (string, nullable) - The city of the User.
- **Industry** (string, nullable) - The industry of the User.
- **About** (string, nullable) - A brief description about the User.
- **TimeZone** (string, nullable) - The time zone of the User.
- **LocalLanguage** (string, nullable) - The local language of the User.
- **CoverPhoto** (string, nullable) - The URL of the User's cover photo.
- **TagLine** (string, nullable) - The tagline of the User.
- **Language** (string, nullable) - The language of the User.
- **Verified** (string, nullable) - Indicates if the User is verified.
- **UpdatedTime** (string, nullable) - The last updated time of the User's profile.
- **IsGeoEnabled** (string, nullable) - Indicates if geo-location services are enabled for the user.

#### Response Example
```json
{
  "Data": [
    {
      "IsPasswordBreached": false,
      "IsActive": true,
      "IsDeleted": false,
      "EmailVerified": true,
      "IsLoginLocked": false,
      "IsRequiredFieldsFilledOnce": true,
      "FirstLogin": true,
      "IsProtected": false,
      "Hireable": true,
      "IsSecurePassword": true,
      "IsCustomUid": false,
      "PhoneIdVerified": true,
      "IsEmailSubscribed": true,
      "NoOfLogins": 10,
      "FollowersCount": 1250,
      "FriendsCount": 458,
      "TotalStatusesCount": 2341,
      "NumRecommenders": 15,
      "TotalPrivateRepository": 8,
      "PublicGists": 23,
      "PrivateGists": 5,
      "PinsCount": 67,
      "BoardsCount": 12,
      "LikesCount": 892,
      "ID": "usr_12345abc",
      "Provider": "facebook",
      "FullName": "John Robert Smith",
      "FirstName": "John",
      "LastName": "Smith",
      "PhoneId": "+1-555-123-4567",
      "UserName": "john_doe",
      "Prefix": "Mr.",
      "MiddleName": "Robert",
      "Suffix": "Jr.",
      "NickName": "Johnny",
      "ProfileName": "johnsmith",
      "BirthDate": "1990-05-15",
      "Gender": "male",
      "Website": "https://www.johnsmith.com",
      "ThumbnailImageUrl": "https://example.com/thumbnails/john.jpg",
      "ImageUrl": "https://example.com/images/john.jpg",
      "Favicon": "https://example.com/favicon.ico",
      "ProfileUrl": "https://example.com/profile/johnsmith",
      "HomeTown": "Boston",
      "State": "Massachusetts",
      "City": "Cambridge",
      "Industry": "Technology",
      "About": "Passionate software developer with 10+ years of experience",
      "TimeZone": "America/New_York",
      "LocalLanguage": "en-US",
      "CoverPhoto": "https://example.com/cover/john.jpg",
      "TagLine": "Building the future through code",
      "Language": "English",
      "Verified": "true",
      "UpdatedTime": "2024-03-20T15:30:00Z",
      "IsGeoEnabled": "true"
    }
  ]
}
```

#### Error Responses
- **400 Bad Request**: The request was malformed or invalid.
- **401 Unauthorized**: Authentication credentials are missing or invalid.
- **403 Forbidden**: The authenticated user does not have permission to perform this action.
```

--------------------------------

### CUSTOM_OBJECT_NOT_CONFIGURED Error Response

Source: https://www.loginradius.com/docs/api/openapi/get-custom-object-by-uidnd-record-id

This error indicates that the custom object setting is not configured for the current site. Contact LoginRadius support for assistance.

```json
{
  "ErrorCode": 999,
  "Message": "Site is not configured for custom object setting",
  "Description": "The custom object setting is not configured for this site, please contact LoginRadius support."
}
```

--------------------------------

### List supported JWT algorithms

Source: https://www.loginradius.com/docs/api/openapi/get-jwt-client-supported-algo-list

Retrieves a list of all supported cryptographic algorithms that can be used by JWT clients for signing and verification when configuring a JWT-based Identity Provider (IdP) for the Tenant.

```APIDOC
## GET /v2/manage/jwt-clients/algo

### Description
Retrieves a list of all supported cryptographic algorithms that can be used by JWT clients for signing and verification when configuring a JWT-based Identity Provider (IdP) for the Tenant.

### Method
GET

### Endpoint
/v2/manage/jwt-clients/algo

### Response
#### Success Response (200)
- **Data** (string[]) - A list of supported JWT algorithms.

#### Response Example
```json
[
  "RS256",
  "RS384",
  "RS512",
  "ES256",
  "ES384",
  "ES512"
]
```
```

--------------------------------

### Referer Header for Registration Source

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Automatically set the **Registration Source** by passing the `Referer` header in registration API calls. This helps track the origin of user registrations.

```APIDOC
## Referer Header for Registration Source

### Description
Automatically sets the Registration Source based on the `Referer` header provided in registration API calls.

### Headers
- **Referer**: Indicates the source of registration (e.g., Android SDK, iOS SDK, API/Postman/Admin Console).

### Example Mapping
- **Source**: Android SDK -> **Profile Value**: Android
- **Source**: iOS SDK -> **Profile Value**: iOS
- **Source**: Identity Experience Framework -> **Profile Value**: Page URL
- **Source**: API/Postman/Admin Console -> **Profile Value**: API
```

--------------------------------

### Authenticate with API Key and Secret via Query String

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Use API Key and API Secret in the query string for backend/admin APIs. Note: This method is not recommended due to potential exposure.

```URL
https://api.loginradius.com/.../account?apikey=API_KEY&apisecret=API_SECRET
```

--------------------------------

### IP_ACCESS_DENIED Error Response

Source: https://www.loginradius.com/docs/api/openapi/get-custom-object-by-uidnd-record-id

This error signifies that access to the resource is denied due to an unauthorized IP address. Ensure your IP address is whitelisted or authorized.

```json
{
  "ErrorCode": 1206,
  "Message": "IP Access Denied",
  "Description": "Access denied to the resource due to unauthorized IP."
}
```

--------------------------------

### List Invitations by Organization ID

Source: https://www.loginradius.com/docs/api/openapi/get-invitations-by-org-id

Lists all invitations by Organization ID. Requires the organization ID as a query parameter.

```APIDOC
## GET /v2/manage/invitations

### Description
Lists all invitations by Organization ID.

### Method
GET

### Endpoint
/v2/manage/invitations

### Parameters
#### Query Parameters
- **orgid** (string) - Required - The ID of the organization to filter invitations by.
  * Example: `org_123456789`

### Responses
#### Success Response (200)
OK: The request was successful.

#### Error Responses
- **400**: Bad Request: The request could not be understood by the server due to malformed syntax.
- **403**: Forbidden: The client does not have permission to access the resource.
- **404**: Not Found: The server cannot find the requested resource.
- **500**: Internal Server Error: The server encountered an unexpected error.
```

--------------------------------

### Retrieve Enabled Social Providers

Source: https://www.loginradius.com/docs/api/openapi/get-enabled-providers

Fetches a list of all social providers that are currently enabled for the tenant.

```APIDOC
## GET /v2/manage/providers/active

### Description
Retrieves a list of all enabled social providers for the Tenant.

### Method
GET

### Endpoint
/v2/manage/providers/active

### Responses
#### Success Response (200)
- **Data** (array) - An array of enabled social provider objects.
  - **ProviderName** (string) - Name of the provider.
  - **IsActive** (boolean) - Status of the provider.

#### Error Response (403)
- **Message** (string) - Brief message describing the error.
- **Description** (string) - Detailed description of the error.
- **ErrorCode** (integer) - Error code for identifying the error type.
- **Code** (integer, nullable) - HTTP status code associated with the error.

### Request Example
(No request body or parameters are specified for this endpoint in the source.)

### Response Example (200)
```json
[
  {
    "ProviderName": "ExampleProvider",
    "IsActive": true
  }
]
```

### Response Example (403)
```json
{
  "Message": "Access Unauthorized",
  "Description": "Access Unauthorized, please use valid authorization to access this endpoint.",
  "ErrorCode": 6002
}
```
```

--------------------------------

### Enhance Analytics with Custom Headers

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Improve tracking accuracy by forwarding client environment data via custom headers. This includes IP address, User-Agent, Host, and preferred language.

```APIDOC
## Custom Headers for Analytics

### Description
Forward client environment data using custom headers to enhance tracking accuracy.

### Headers
- **X-Origin-IP**: Client's IP address
- **X-Origin-User-Agent**: User-agent string
- **X-Origin-Host**: Client host (absolute URL)
- **X-Origin-Accept-Language**: User's preferred language
- **X-Platform**: Client platform info
```

--------------------------------

### Email Address Does Not Exist Error Response

Source: https://www.loginradius.com/docs/api/openapi/get-identities

This response signifies that the email address provided does not exist in the system. Please verify and use a valid email address for the operation.

```json
{
  "ErrorCode": 1023,
  "Message": "Email address does not exist",
  "Description": "The provided email address does not exist. Please use a valid email address."
}
```

--------------------------------

### List Custom Objects

Source: https://www.loginradius.com/docs/api/openapi/get-custom-object-by-uid

Retrieves all Custom Objects associated with the UID.

```APIDOC
## GET /identity/v2/manage/account/:uid/customobject

### Description
Retrieves all Custom Objects associated with the UID.

### Method
GET

### Endpoint
/identity/v2/manage/account/:uid/customobject

### Responses
#### Success Response (200)
Status OK: The request was successful.

#### Error Responses
- **400**: Bad Request - The request could not be understood by the server due to malformed syntax.
- **401**: Unauthorized - The request requires User authentication.
- **403**: Forbidden - The server understood the request, but refuses to authorize it.
```

--------------------------------

### JWT Configuration Not Found Error Response

Source: https://www.loginradius.com/docs/api/openapi/get-jwt-client-id-p-configuration-by-app-name

This JSON response indicates that the requested JWT configuration was not found or the resource does not exist. It includes a message, description, and error code.

```json
{
  "Description": "JWT configuration not found or the resource does not exist.",
  "ErrorCode": 7958,
  "Message": "JWT configuration not found"
}
```

--------------------------------

### Using LoginRadius API with a Proxy

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

To make API requests via a proxy, configure proxy settings in your SDK/web requests or modify the SDK's HTTP layer as needed.

```APIDOC
## Using API with a Proxy

### Description
Instructions for configuring API requests to be made through a proxy server.

### Configuration
- Configure proxy settings within your SDK or web requests.
- Modify the SDK's HTTP layer if necessary.
```

--------------------------------

### Generic Authentication Failure Error Response

Source: https://www.loginradius.com/docs/api/openapi/get-identities

A general authentication failure occurred. This may indicate issues with credentials or tokens.

```json
{
  "errorCode": 1409,
  "message": "Authentication failed"
}
```

--------------------------------

### Enable Null Value Support in API Calls

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Pass nullsupport=true as a query parameter in POST or UPDATE API calls to explicitly set fields to null. This is useful for profile cleanup and precise data control. By default, nullsupport is false.

```http
POST /identity/v2/auth/account?nullsupport=true  
```

--------------------------------

### Retrieve Invitation Details

Source: https://www.loginradius.com/docs/api/openapi/get-invitation

Retrieves details about a specific invitation using the invitation token.

```APIDOC
## GET /identity/v2/auth/invitations/:invitation_token

### Description
Retrieves details about a specific invitation using the invitation token.

### Method
GET

### Endpoint
/identity/v2/auth/invitations/:invitation_token

### Parameters
#### Path Parameters
- **invitation_token** (string) - Required - The token of the invitation to retrieve.

### Responses
#### Success Response (200)
OK: The request was successful.

#### Error Responses
- **400**: Bad Request - the request is malformed or invalid.
- **403**: Forbidden - the client is not allowed to access this resource.
- **404**: Not Found - the invitation token does not exist or is invalid.
```

--------------------------------

### B2B Feature Not Enabled Error Response

Source: https://www.loginradius.com/docs/api/openapi/get-invitation-by-invitation-id

This JSON object is returned when the B2B feature is not enabled or configured for the application. It suggests contacting support for assistance.

```json
{
  "Description": "The B2B feature is not enabled or configured for your app. Please contact LoginRadius support for more information.",
  "ErrorCode": 1267,
  "Message": "B2B feature is not enabled or not configured properly"
}
```

--------------------------------

### Retrieve all custom OAuth provider keys

Source: https://www.loginradius.com/docs/api/openapi/get-custom-provider-keys

This endpoint retrieves all custom OAuth provider keys configured for the tenant. It is useful for auditing or managing your OAuth integrations.

```APIDOC
## GET /v2/manage/custom-providers/oauth/keys

### Description
Retrieves all custom OAuth provider keys for the Tenant.

### Method
GET

### Endpoint
/v2/manage/custom-providers/oauth/keys

### Responses
#### Success Response (200)
OK: The request was successful.

#### Error Responses
- **403** Forbidden: The client does not have permission to access the resource.
- **404** Not Found: The server cannot find the requested resource.
```

--------------------------------

### Retrieve invitation by ID

Source: https://www.loginradius.com/docs/api/openapi/get-invitation-by-invitation-id

Fetches invitation details using the invitation ID.

```APIDOC
## GET /v2/manage/invitations/:invitationid

### Description
Retrieves invitation details by invitation ID.

### Method
GET

### Endpoint
/v2/manage/invitations/:invitationid

### Parameters
#### Path Parameters
- **invitationid** (string) - Required - The ID of the invitation. The ID is typically in the format _inv_ <unique_id>_, where _<unique_id>_ is a string of alphanumeric characters.
  Example: `inv_123456789`
```

--------------------------------

### Retrieve Domain Access Restrictions

Source: https://www.loginradius.com/docs/api/openapi/get-domain-access-restrictions-by-app-id

Use this endpoint to fetch the current domain access restrictions for your tenant. This includes both allowed and blocked domains or emails.

```http
GET
## /v2/manage/restrictions/domain-access
```

--------------------------------

### Null Value Support

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Enables explicit setting of fields to null for profile cleanup and precise data control. Pass `nullsupport=true` as a query parameter in POST or UPDATE API calls. By default, `nullsupport` is false.

```APIDOC
## POST /identity/v2/auth/account?nullsupport=true

### Description
Allows setting fields to null. This is useful for profile cleanup and precise data control.

### Method
POST

### Endpoint
/identity/v2/auth/account?nullsupport=true

### Parameters
#### Query Parameters
- **nullsupport** (boolean) - Optional - Set to `true` to enable null value support.

### Request Body
#### Example Payload
```json
{
  "FirstName": null
}
```

### Supported Fields for Null Values
UserName, Prefix, FirstName, MiddleName, LastName, Suffix, NickName, ProfileName, BirthDate, Gender, Website, ThumbnailImageUrl, ImageUrl, Favicon, ProfileUrl, HomeTown, State, City, Industry, About, TimeZone, LocalLanguage, CoverPhoto, TagLine , Language, MainAddress, LocalCity, ProfileCity, LocalCountry, RelationshipStatus, Religion, Political, HttpsImageUrl, IsGeoEnabled, Associations, Honors, PublicRepository, RepositoryUrl, ProfessionalHeadline, Currency, StarredUrl, GistsUrl, Company, GravatarImageUrl, Languages , PlacesLived , Addresses , PhoneNumbers and Custom Fields.

**Note:** UserName can only be set to null via the LoginRadius Management API.
```

--------------------------------

### Organization Not Found Error Response (Partner)

Source: https://www.loginradius.com/docs/api/openapi/get-invitation-by-invitation-id

This JSON object indicates an error where the specified organization does not exist or is not configured. It's typically used in partner-related contexts.

```json
{
  "Description": "The entered organization or its configuration does not exist.",
  "ErrorCode": 8118,
  "Message": "Organization not found"
}
```

--------------------------------

### Credential-Based Authentication

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Authenticate backend/admin APIs using API Key and API Secret via headers or query string. Using headers is recommended for security.

```APIDOC
## Credential-Based Authentication

### Description
Authenticate backend/admin APIs (e.g., Account, Roles Management, Custom Object) using API Key and API Secret.

### Authentication Methods
- **Headers:** `X-LoginRadius-ApiKey` and `X-LoginRadius-ApiSecret`
- **Query String:** Append `apikey` and `apisecret` to the API URL. Example: `https://api.loginradius.com/.../account?apikey=API_KEY&apisecret=API_SECRET`

**Note:** Passing API credentials in the query string is not recommended due to potential exposure in logs, browser history, and network traces. Use HTTP headers instead.
```

--------------------------------

### Retrieve Impersonation Token

Source: https://www.loginradius.com/docs/api/openapi/get-impersonation-token

Retrieves an Impersonation Token for an Account using the UID.

```APIDOC
## GET /identity/v2/manage/account/access_token

### Description
Retrieves an Impersonation Token for an Account using the UID.

### Method
GET

### Endpoint
/identity/v2/manage/account/access_token

### Parameters
#### Query Parameters
- **uid** (string) - Required - The UID associated with the User.
- **prevent_webhook** (boolean) - Optional - When true, suppresses webhook events for this operation.

#### Header Parameters
- **X-PreventWebhook** (boolean) - Optional - When true, suppresses webhook events for this operation.

### Responses
#### Success Response (200)
Impersonation token retrieved successfully.

#### Error Responses
- **400**: Bad Request - Invalid or missing parameters.
- **401**: Unauthorized - The request requires User authentication.
- **403**: Forbidden - The client is not authorized to perform this action.
```

--------------------------------

### API Request Signing

Source: https://www.loginradius.com/docs/api/openapi/customer-identity-api

Implement API Request Signing for advanced security, replacing the raw API Secret with a time-sensitive, hashed signature.

```APIDOC
## API Request Signing (Optional Advanced Security)

### Description
API Request Signing is an advanced authentication method that replaces sending the raw API Secret with a time-sensitive, hashed signature for better security. Use Request Signing when you want to avoid exposing your API Secret directly, need extra protection for sensitive backend operations, or want to verify payload integrity and prevent replay attacks.

### How It Works
Instead of sending the API Secret, you send a hash (HMAC-SHA256) created from the request expiry time, the API endpoint (URL), and the payload (if any), using your API Secret as the signing key. LoginRadius will validate the hash and ensure the request has not been tampered with or reused.

### Step-by-Step Implementation
1.  **Set the Request Expiry Time:** Include a header that defines when the request should expire (in UTC). Example: `X-Request-Expires : 2018-4-18 6:15:10 PM`.
2.  **Create the Encoded URL:**
    A. Build the full URL: Join the API endpoint and query string parameters (ensure parameter values are URL-encoded).
    B. Decode this full URL.
    C. Re-encode the decoded URL.
3.  **Construct the Signing String:** `signingString = X-Request-Expires + ":" + Encoded_URL + ":" + JSON_Payload`
    *   If it’s a GET request, leave JSON_Payload empty.
    *   Use an empty string (" ") if there is no payload.
4.  **Add the Hash to the Request Header:**
    *   Sign the `signingString` using your API Secret as the key: `hashBytes = HMACSHA256(signingString)`.
    *   Get the Hash value by converting `hashBytes` into a base64 string.
    *   Pass the generated hash using the `Digest` header: `Digest: SHA-256=<hash_value>`.

### Example Headers Summary
```
Content-Type: application/json
X-LoginRadius-ApiKey: <YOUR_API_KEY>
X-Request-Expires: 2025-03-20 18:30:00
Digest: SHA-256: <GENERATED_HASH>
```

### Request Signing Modes
- **Strict:** Requests must include a valid hash.
- **Preferred:** It is validated if the hash is present; otherwise, it falls back to API Secret.
```
Tokens:
Raw