openapi: 3.0.1
info:
  title: LoginRadius API
  description: This is a LoginRadius API server. Which you can use to authenticate and manage the user.
  version: 1.0.0
  contact:
    name: API Support
    url: https://www.loginradius.com
    email: support@loginradius.com
servers:
  - url: https://api.loginradius.com
    description: LoginRadius Prod Server
  - url: https://{domain}.hub.loginradius.com
    description: LoginRadius Default HostedPage Server
    variables:
      domain:
        default: example
        description: LoginRadius Tenant Name
  - url: https://{customDomain}
    description: Custom Domain Hosted By LoginRadius
    variables:
      customDomain:
        default: example.com
        description: Custom domain
security:
  - APIKey: []
  - ClientId: []
tags:
  - name: Registration
    description: Registeration API's
  - name: Login
    description: Login API's
  - name: User
    description: User Actions APIs
  - name: Password
    description: Password API's
  - name: Security
    description: User Security API's
  - name: Session
    description: Session Management APIs
  - name: Custom Object
    description: Custom Object APIs
  - name: Accounts
    description: Account Management APIs
  - name: Account Session
    x-displayName: Session Management
    description: Access Token APIs
  - name: Account Security
    x-displayName: Security Management
    description: Account Security APIs
  - name: Account Custom Object
    x-displayName: Custom Object Management
    description: Account Custom Object APIs
  - name: Multipurpose Tokens
    description: Multipurpose Tokens API
  - name: Roles Management
    description: APIs for managing roles for B2C Tenant.
  - name: Organization
    description: Manage Organizations and their settings
  - name: Organization User Roles
    description: Manage role assignments for users within Organizations
  - name: Organization Connections
    description: Manage identity provider connections for Organizations
  - name: Organization Connection Group Roles
    description: Manage group to role mappings for Organization connections
  - name: Organization Domains
    description: Manage domains associated with Organizations
  - name: Organization Invitations
    description: API's for managing Organization invitations
  - name: Permissions
    description: Manage permissions that can be assigned to roles
  - name: Roles
    description: Manage roles that can be assigned to users
  - name: SOTT
    description: SOTT actions
  - name: Custom Fields
    description: Custom Fields actions
  - name: Webhooks
    description: Webhooks actions
  - name: Workflows
    description: Workflows actions
  - name: SMS Templates
    description: SMS Templates actions
  - name: Passkey Configuration
    description: Passkey Configuration actions
  - name: Push Notification Configuration
    description: Push Notification Configuration actions
  - name: Security Questions
    description: Security Questions actions
  - name: Domain Access Restrictions
    description: Domain Access Restrictions actions
  - name: Email Templates
    description: Email Templates actions
  - name: Social Providers
    description: Social Providers actions
  - name: Second Factor Configuration
    description: Second Factor Configuration actions
  - name: Captcha Configuration
    description: Captcha Configuration actions
  - name: IP Access Restrictions
    description: IP Access Restrictions actions
  - name: JWT Clients
    description: JWT Clients actions
  - name: SAML Clients
    description: SAML Clients actions
  - name: OAuth Clients
    description: OAuth Clients actions
  - name: OAuth Custom Providers
    description: OAuth Custom Providers actions
  - name: JWT Custom Providers
    description: JWT Custom Providers actions
  - name: SAML Custom Providers
    description: SAML Custom Providers actions
  - name: Password Policy
    description: Password Policy actions
  - name: Identity
    description: Identity Analytics APIs
  - name: Custom Objects
    description: Custom Object Analytics APIs
  - name: Insights
    description: Aggregation Analytics APIs
  - name: SAML
    description: Federated SSO SAML APIs
  - name: JWT
    description: Federated SSO JWT APIs
  - name: Cross Device SSO
    description: Cross Device SSO APIs
  - name: OAuth M2M
    description: OAuth M2M APIs
  - name: OAuth
    description: OAuth APIs
  - name: OIDC
    description: OpenId Connect
  - name: User Migration
    description: Bulk Migration APIs
  - name: Consent
    description: Consent actions
  - name: BigCommerce SSO
    description: BigCommerce SSO integration APIs
  - name: Shopify SSO
    description: Shopify SSO integration APIs
  - name: PerfectMind SSO
    description: PerfectMind SSO integration APIs
paths:
  /identity/v2/auth/password:
    post:
      summary: Forgot Password
      description: Initiates the Password recovery process using Username or Email.
      operationId: ForgotPassword
      tags:
        - Password
      parameters:
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/ResetPasswordUrl'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/EmailUserNameModel'
                - $ref: '#/components/schemas/CaptchaModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                USERNAME_REQUIRED:
                  $ref: '#/components/examples/USERNAME_REQUIRED'
                EMAIL_ID_OR_USER_REQUIRED:
                  $ref: '#/components/examples/EMAIL_ID_OR_USER_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                RESET_PASSWORD_URL_INVALID:
                  $ref: '#/components/examples/RESET_PASSWORD_URL_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
    put:
      tags:
        - Password
      operationId: ResetPasswordByResetToken
      summary: Reset Password with token and OTP
      description: Sets a new Password for the specified Account using a reset token and OTP.
      parameters:
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/QQCaptchaTicket'
        - $ref: '#/components/parameters/QQCaptchaRandstr'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPassword'
            examples:
              ResetPasswordByEmailAndOTP:
                $ref: '#/components/examples/ResetPasswordByEmailAndOTP'
              ResetPasswordByUsernameAndOTP:
                $ref: '#/components/examples/ResetPasswordByUsernameAndOTP'
              ResetPasswordByResetToken:
                $ref: '#/components/examples/ResetPasswordByResetToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetPasswordResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                API_KEY_AND_RESET_TOKEN_REQUIRED:
                  $ref: '#/components/examples/API_KEY_AND_RESET_TOKEN_REQUIRED'
                API_KEY_AND_PASSWORD_REQUIRED:
                  $ref: '#/components/examples/API_KEY_AND_PASSWORD_REQUIRED'
                PASSWORD_AND_RESET_TOKEN_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_AND_RESET_TOKEN_REQUIRED'
                RESET_TOKEN_REQUIRED:
                  $ref: '#/components/examples/RESET_TOKEN_REQUIRED'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
                USERNAME_REQUIRED:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                VERIFICATION_OTP_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_OTP_NOT_VALID'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                LINK_ALREADY_VERIFIED:
                  $ref: '#/components/examples/LINK_ALREADY_VERIFIED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
  /identity/v2/auth/password/change:
    put:
      tags:
        - Password
      summary: Update Password
      operationId: ChangePassword
      description: Updates the Account Password using the current Password for verification.
      parameters:
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/QQCaptchaTicket'
        - $ref: '#/components/parameters/QQCaptchaRandstr'
        - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/changePassword'
      responses:
        '200':
          description: Password change successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                OLD_PASSWORD_REQUIRED:
                  $ref: '#/components/examples/OLD_PASSWORD_REQUIRED'
                NEW_PASSWORD_REQUIRED:
                  $ref: '#/components/examples/NEW_PASSWORD_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_PASSWORD:
                  $ref: '#/components/examples/INVALID_PASSWORD'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/password/reset:
    put:
      tags:
        - Password
      operationId: ResetPassword
      summary: Reset Password with token and OTP
      description: Sets a new Password for the specified Account using a reset token and OTP.
      parameters:
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/QQCaptchaTicket'
        - $ref: '#/components/parameters/QQCaptchaRandstr'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPassword'
            examples:
              ResetPasswordByEmailAndOTP:
                $ref: '#/components/examples/ResetPasswordByEmailAndOTP'
              ResetPasswordByUsernameAndOTP:
                $ref: '#/components/examples/ResetPasswordByUsernameAndOTP'
              ResetPasswordByResetToken:
                $ref: '#/components/examples/ResetPasswordByResetToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetPasswordResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                API_KEY_AND_RESET_TOKEN_REQUIRED:
                  $ref: '#/components/examples/API_KEY_AND_RESET_TOKEN_REQUIRED'
                API_KEY_AND_PASSWORD_REQUIRED:
                  $ref: '#/components/examples/API_KEY_AND_PASSWORD_REQUIRED'
                PASSWORD_AND_RESET_TOKEN_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_AND_RESET_TOKEN_REQUIRED'
                RESET_TOKEN_REQUIRED:
                  $ref: '#/components/examples/RESET_TOKEN_REQUIRED'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
                USERNAME_REQUIRED:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                VERIFICATION_OTP_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_OTP_NOT_VALID'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                LINK_ALREADY_VERIFIED:
                  $ref: '#/components/examples/LINK_ALREADY_VERIFIED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
  /identity/v2/auth/password/otp:
    put:
      tags:
        - Password
      summary: Reset Password with Phone and OTP
      description: Resets the Password using OTP and Phone number verification.
      operationId: ResetPasswordWithOTP
      parameters:
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/QQCaptchaTicket'
        - $ref: '#/components/parameters/QQCaptchaRandstr'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPasswordWithOTP'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetPasswordResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
                OTP_ALREADY_USED:
                  $ref: '#/components/examples/OTP_ALREADY_USED'
                OTP_EXPIRED:
                  $ref: '#/components/examples/OTP_EXPIRED'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
    post:
      summary: Retrieve Password reset OTP
      description: Requests an OTP for resetting the Password using the User's Phone number.
      operationId: RequestOTPForPasswordReset
      tags:
        - Password
      parameters:
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/QQCaptchaTicket'
        - $ref: '#/components/parameters/QQCaptchaRandstr'
        - $ref: '#/components/parameters/IsVoiceOtp'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgotPasswordPhoneModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                OTP_LIMIT_REACHED:
                  $ref: '#/components/examples/OTP_LIMIT_REACHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
  /identity/v2/auth/password/securityanswer:
    put:
      summary: Reset Password with security question
      description: Resets the Password using a security question and Email, Username, or Phone.
      operationId: ResetPasswordSecurityAnswer
      tags:
        - Password
      parameters:
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPasswordBySecurityAnswer'
            examples:
              SecurityAnswerAndEmail:
                $ref: '#/components/examples/ResetPasswordBySecurityAnswerAndEmail'
              SecurityAnswerAndPhone:
                $ref: '#/components/examples/ResetPasswordBySecurityAnswerAndPhone'
              SecurityAnswerAndUserId:
                $ref: '#/components/examples/ResetPasswordBySecurityAnswerAndUserId'
              SecurityAnswerAndUsername:
                $ref: '#/components/examples/ResetPasswordBySecurityAnswerAndUsername'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetPasswordResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                SECUREITY_ANSWER_REQUIRED_VALIDATION:
                  $ref: '#/components/examples/SECUREITY_ANSWER_REQUIRED_VALIDATION'
                PASSWORD_REQUIRED_VALIDATION:
                  $ref: '#/components/examples/PASSWORD_REQUIRED_VALIDATION'
                EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED'
                USERNAME_REQUIRED:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                EMAIL_ID_OR_USER_REQUIRED:
                  $ref: '#/components/examples/EMAIL_ID_OR_USER_REQUIRED'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                SECURITY_QUESTION_NOT_SAVED_IN_PROFILE:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_SAVED_IN_PROFILE'
  /identity/v2/auth/register:
    post:
      summary: Registration by Email/Phone/Username via SOTT
      description: Registers a new User using Email, Phone, or Username via a Secure One Time Token (SOTT).
      operationId: UserRegistrationBySottEmailPhoneUserName
      tags:
        - Registration
      parameters:
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/Sott'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/X-LoginRadius-Sott'
        - $ref: '#/components/parameters/Options'
        - $ref: '#/components/parameters/InvitationToken'
        - $ref: '#/components/parameters/IsVoiceOtp'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileRequestModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
                SOTT_REQUIRED:
                  $ref: '#/components/examples/SOTT_REQUIRED'
                PHONE_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_REQUIRED_PARAM'
                PHONE_OR_EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_OR_EMAIL_REQUIRED_PARAM'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
                EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_REQUIRED_PARAM'
                USERNAME_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                EMAIL_PHONE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_PHONE_REQUIRED_PARAM'
                USERNAME_EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_EMAIL_REQUIRED_PARAM'
                EMAIL_TYPE_REQUIRED:
                  $ref: '#/components/examples/EMAIL_TYPE_REQUIRED'
                GENDER_INVALID:
                  $ref: '#/components/examples/GENDER_INVALID'
                BIRTH_DATE_INVALID:
                  $ref: '#/components/examples/BIRTH_DATE_INVALID'
                ADDRESS_TYPE_REQUIRED:
                  $ref: '#/components/examples/ADDRESS_TYPE_REQUIRED'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                ADDRESS_TYPE_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/ADDRESS_TYPE_CAN_NOT_BE_SAME'
                EMAIL_ID_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/EMAIL_ID_CAN_NOT_BE_SAME'
                PRIMARY_EMAIL_CAN_BE_ONLY_ONE:
                  $ref: '#/components/examples/PRIMARY_EMAIL_CAN_BE_ONLY_ONE'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                EMAIL_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_VALUE_REQUIRED_PARAM'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                SECURED_ONE_TIME_TOKEN_IS_INVALID:
                  $ref: '#/components/examples/SECURED_ONE_TIME_TOKEN_IS_INVALID'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                TRADITIONAL_REGISTRATION_DISABLED:
                  $ref: '#/components/examples/TRADITIONAL_REGISTRATION_DISABLED'
                CUSTOM_FIELD_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_VALID'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/ACCOUNT_NOT_ALLOWED_TO_LOGIN'
                PIN_REQUIRED:
                  $ref: '#/components/examples/PIN_REQUIRED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                PRIVACY_POLICY_NOT_ACCEPTED:
                  $ref: '#/components/examples/PRIVACY_POLICY_NOT_ACCEPTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                AGE_UNDERAGE:
                  $ref: '#/components/examples/AGE_UNDERAGE'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED'
                USERNAME_ALREADY_REGISTERED:
                  $ref: '#/components/examples/USERNAME_ALREADY_REGISTERED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    put:
      tags:
        - User
      summary: Resend verification Email
      operationId: ResendEmailVerification
      description: Resends the verification Email to the User to confirm their Email address.
      parameters:
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/EmailTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailModel'
      responses:
        '200':
          description: User registration successful and verification Email sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - Invalid parameters or missing required fields
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Status Forbidden- Insufficient permissions to perform this action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_ALLREADY_VERIFIED:
                  $ref: '#/components/examples/EMAIL_ALLREADY_VERIFIED'
                EMAILID_VERIFICATION_DISABLE:
                  $ref: '#/components/examples/EMAILID_VERIFICATION_DISABLE'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
  /identity/v2/auth/register/captcha:
    post:
      tags:
        - Registration
      summary: Registration by Email/Phone/Username via Captcha
      description: Registers a new User using Email, Phone, or Username with Captcha verification.
      operationId: UserRegistrationByReCaptchaEmailPhoneUserName
      parameters:
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/Options'
        - $ref: '#/components/parameters/IsVoiceOtp'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/InvitationToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/CaptchaModel'
                - $ref: '#/components/schemas/ProfileRequestModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
                PHONE_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_REQUIRED_PARAM'
                PHONE_OR_EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_OR_EMAIL_REQUIRED_PARAM'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
                EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_REQUIRED_PARAM'
                USERNAME_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                EMAIL_PHONE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_PHONE_REQUIRED_PARAM'
                USERNAME_EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_EMAIL_REQUIRED_PARAM'
                EMAIL_TYPE_REQUIRED:
                  $ref: '#/components/examples/EMAIL_TYPE_REQUIRED'
                GENDER_INVALID:
                  $ref: '#/components/examples/GENDER_INVALID'
                BIRTH_DATE_INVALID:
                  $ref: '#/components/examples/BIRTH_DATE_INVALID'
                ADDRESS_TYPE_REQUIRED:
                  $ref: '#/components/examples/ADDRESS_TYPE_REQUIRED'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                ADDRESS_TYPE_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/ADDRESS_TYPE_CAN_NOT_BE_SAME'
                EMAIL_ID_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/EMAIL_ID_CAN_NOT_BE_SAME'
                PRIMARY_EMAIL_CAN_BE_ONLY_ONE:
                  $ref: '#/components/examples/PRIMARY_EMAIL_CAN_BE_ONLY_ONE'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                EMAIL_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_VALUE_REQUIRED_PARAM'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                TRADITIONAL_REGISTRATION_DISABLED:
                  $ref: '#/components/examples/TRADITIONAL_REGISTRATION_DISABLED'
                CUSTOM_FIELD_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_VALID'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/ACCOUNT_NOT_ALLOWED_TO_LOGIN'
                PIN_REQUIRED:
                  $ref: '#/components/examples/PIN_REQUIRED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                PRIVACY_POLICY_NOT_ACCEPTED:
                  $ref: '#/components/examples/PRIVACY_POLICY_NOT_ACCEPTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                AGE_UNDERAGE:
                  $ref: '#/components/examples/AGE_UNDERAGE'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED'
                USERNAME_ALREADY_REGISTERED:
                  $ref: '#/components/examples/USERNAME_ALREADY_REGISTERED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/register/passkey/begin:
    get:
      tags:
        - Registration
      summary: Initiate Registration with Passkey
      operationId: beginPasskeyRegistration
      description: Begins the registration process using a Passkey.
      parameters:
        - $ref: '#/components/parameters/PasskeyIdentifier'
      responses:
        '200':
          description: Successfully initiated credential registration
          content:
            application/json:
              schema:
                type: object
                description: Response object returned to initiate Passkey registration (WebAuthn)
                properties:
                  RegisterBeginCredential:
                    type: object
                    description: OpenAPI schema for protocol.PublicKeyCredentialCreationOptions
                    properties:
                      publicKey:
                        $ref: '#/components/schemas/PublicKeyCredentialCreationOptions'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
  /identity/v2/auth/register/passkey/finish:
    post:
      tags:
        - Registration
      summary: Complete Registration with Passkey
      operationId: finishPasskeyRegistration
      description: Completes the registration process using a Passkey.
      parameters:
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/Options'
        - $ref: '#/components/parameters/InvitationToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasskeyRegisterFinish'
      responses:
        '200':
          description: Successfully finish credential registration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                EMAIL_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_VALUE_REQUIRED_PARAM'
                EMAIL_TYPE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_TYPE_REQUIRED_PARAM'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
                GENDER_INVALID:
                  $ref: '#/components/examples/GENDER_INVALID'
                BIRTH_DATE_INVALID:
                  $ref: '#/components/examples/BIRTH_DATE_INVALID'
                ADDRESS_TYPE_REQUIRED:
                  $ref: '#/components/examples/ADDRESS_TYPE_REQUIRED'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                ADDRESS_TYPE_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/ADDRESS_TYPE_CAN_NOT_BE_SAME'
                EMAIL_ID_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/EMAIL_ID_CAN_NOT_BE_SAME'
                PRIMARY_EMAIL_CAN_BE_ONLY_ONE:
                  $ref: '#/components/examples/PRIMARY_EMAIL_CAN_BE_ONLY_ONE'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                TRADITIONAL_REGISTRATION_DISABLED:
                  $ref: '#/components/examples/TRADITIONAL_REGISTRATION_DISABLED'
                CUSTOM_FIELD_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_VALID'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
                ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/ACCOUNT_NOT_ALLOWED_TO_LOGIN'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                PIN_REQUIRED:
                  $ref: '#/components/examples/PIN_REQUIRED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                PRIVACY_POLICY_NOT_ACCEPTED:
                  $ref: '#/components/examples/PRIVACY_POLICY_NOT_ACCEPTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                AGE_UNDERAGE:
                  $ref: '#/components/examples/AGE_UNDERAGE'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login:
    post:
      summary: Login with credentials
      description: Authenticates a User using Email, Username, or Phone, providing an Access Token for further API interactions.
      operationId: EmailByLoginUserNamePhone
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/LoginUrl'
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/IsVoiceOtp'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/BreachedPasswordEmailTemplate'
        - $ref: '#/components/parameters/BreachedPasswordSmsTemplate'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/Options'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaOneClickEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaOtpSMSTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
        - $ref: '#/components/parameters/InvitationToken'
        - $ref: '#/components/parameters/EmailTemplate2FA'
        - $ref: '#/components/parameters/DuoRedirectUri'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/LoginByEmailRequest'
                - $ref: '#/components/schemas/LoginByUsernameRequest'
                - $ref: '#/components/schemas/LoginByPhone'
            examples:
              LoginByEmailRequest:
                $ref: '#/components/examples/LoginByEmailRequest'
              LoginByUserNameRequest:
                $ref: '#/components/examples/LoginByUserNameRequest'
              LoginByPhoneRequest:
                $ref: '#/components/examples/LoginByPhoneRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AuthResponseOptionalMfa'
                  - $ref: '#/components/schemas/AuthResponseRequiredMfa'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                DUO_REDIRECT_URI_REQUIRED:
                  $ref: '#/components/examples/DUO_REDIRECT_URI_REQUIRED'
                USERNAME_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                USERNAME_PASSWORD_REQUIRED:
                  $ref: '#/components/examples/USERNAME_PASSWORD_REQUIRED'
                PHONE_OR_EMAIL_OR_USER_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_OR_EMAIL_OR_USER_REQUIRED_PARAM'
                PHONE_OR_EMAIL_OR_USER_REQUIRED_PASSWORD_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_OR_EMAIL_OR_USER_REQUIRED_PASSWORD_REQUIRED_PARAM'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                USERNAME_OR_PASSWORD_WRONG:
                  $ref: '#/components/examples/USERNAME_OR_PASSWORD_WRONG'
                USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT:
                  $ref: '#/components/examples/USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT'
                USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT:
                  $ref: '#/components/examples/USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                USER_NAME_AUTHENTICATION_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED'
                LOGIN_WITH_PASSWORD_NOT_ENABLED:
                  $ref: '#/components/examples/LOGIN_WITH_PASSWORD_NOT_ENABLED'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/ACCOUNT_NOT_ALLOWED_TO_LOGIN'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                BREACHED_PASSWORD_LOGIN:
                  $ref: '#/components/examples/BREACHED_PASSWORD_LOGIN'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED'
                PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/PHONE_NOT_VERIFIED'
                EMAIL_OR_PHONE_NUMBER_REQUIRED_VERIFIED:
                  $ref: '#/components/examples/EMAIL_OR_PHONE_NUMBER_REQUIRED_VERIFIED'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK'
                RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK'
                RBA_EMAIL_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_CITY_RISK'
                RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK'
                RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK'
                RBA_EMAIL_VERIFICATION_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_IP_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK'
                RBA_SMS_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_BROWSER_RISK'
                RBA_SMS_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_CITY_RISK'
                RBA_SMS_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_COUNTRY_RISK'
                RBA_SMS_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_DEVICE_RISK'
                RBA_SMS_VERIFICATION_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_IP_RISK'
                PIN_IS_REQUIRED:
                  $ref: '#/components/examples/PIN_IS_REQUIRED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                TWO_FACTOR_AUTHENTICATION_PUSH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PUSH_CONFIG_INVALID'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                DUO_AUTHENTICATOR_REDIRECT_URI_INVALID:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_INVALID'
                DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/email:
    post:
      summary: Add Email
      description: Adds an Email to a User's account, either as a primary or additional Email.
      operationId: AddEmail
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddEmailModel'
      responses:
        '200':
          description: Status OK:The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                EMAIL_TYPE_CAN_NOT_NULL:
                  $ref: '#/components/examples/EMAIL_TYPE_CAN_NOT_NULL'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                CANNOT_ADD_EMAIL_ADDRESS:
                  $ref: '#/components/examples/CANNOT_ADD_EMAIL_ADDRESS'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
    put:
      tags:
        - User
      operationId: UpdateEmail
      summary: Verify Email
      description: Verifies the User's Email when OTP Email Verification is enabled, requiring LoginRadius activation.
      parameters:
        - $ref: '#/components/parameters/Url'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/VerifyEmailModel'
                - $ref: '#/components/schemas/CaptchaModel'
      responses:
        '200':
          description: Email existence check response
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AuthResponse'
                  - $ref: '#/components/schemas/AuthResponseEmailVerification'
                  - $ref: '#/components/schemas/AuthResponseForgotReset'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                EMAIL_UUID_OTP_REQUIRED:
                  $ref: '#/components/examples/EMAIL_UUID_OTP_REQUIRED'
                EMAIL_UUID_REQUIRED:
                  $ref: '#/components/examples/EMAIL_UUID_REQUIRED'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                INVALID_UUID:
                  $ref: '#/components/examples/INVALID_UUID'
                EMAIL_OTP_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_OTP_NOT_EXISTS'
                EMAIL_OTP_ALREADY_USED:
                  $ref: '#/components/examples/EMAIL_OTP_ALREADY_USED'
                EMAIL_OTP_EXPIRED:
                  $ref: '#/components/examples/EMAIL_OTP_EXPIRED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                APP_NOT_EXISTS:
                  $ref: '#/components/examples/APP_NOT_EXISTS'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                EMAIL_ALREADY_USED:
                  $ref: '#/components/examples/EMAIL_ALREADY_USED'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - BearerToken: []
          APIKey: []
    get:
      tags:
        - User
      operationId: CheckEmailAvailability
      summary: Check Email availability
      description: Verifies Email availability or checks Email using a Verification Token or OTP.
      parameters:
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/VerificationToken'
        - $ref: '#/components/parameters/Otp'
        - $ref: '#/components/parameters/Uuid'
        - $ref: '#/components/parameters/Url'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
      responses:
        '200':
          description: Email existence check response
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/IsExist'
                  - $ref: '#/components/schemas/AuthResponse'
                  - $ref: '#/components/schemas/AuthResponseEmailVerification'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                VERIFICATION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/VERIFICATION_TOKEN_REQUIRED'
                EMAIL_UUID_OTP_REQUIRED:
                  $ref: '#/components/examples/EMAIL_UUID_OTP_REQUIRED'
                EMAIL_UUID_REQUIRED:
                  $ref: '#/components/examples/EMAIL_UUID_REQUIRED'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                VERIFICATION_LINK_INVALID:
                  $ref: '#/components/examples/VERIFICATION_LINK_INVALID'
                EMAIL_OTP_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_OTP_NOT_EXISTS'
                LINK_ALREADY_VERIFIED:
                  $ref: '#/components/examples/LINK_ALREADY_VERIFIED'
                EMAIL_OTP_ALREADY_USED:
                  $ref: '#/components/examples/EMAIL_OTP_ALREADY_USED'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                EMAIL_OTP_EXPIRED:
                  $ref: '#/components/examples/EMAIL_OTP_EXPIRED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                CONSENT_FORM_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_AVAILABLE'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                INVALID_UUID:
                  $ref: '#/components/examples/INVALID_UUID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
    delete:
      tags:
        - User
      summary: Remove Email
      description: Removes additional Emails from a User's account.
      operationId: deleteemailbyaccesstoken
      parameters:
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ONE_EMAILID_IS_REQUIRED:
                  $ref: '#/components/examples/ONE_EMAILID_IS_REQUIRED'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/AccessTokenInBody'
                - $ref: '#/components/schemas/DeleteEmailRequest'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/login/passkey/begin:
    get:
      tags:
        - Login
      summary: Initiate Login with Passkey
      operationId: beginPasskeyLogin
      description: Begins the login process using a Passkey.
      parameters:
        - $ref: '#/components/parameters/PasskeyIdentifier'
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/EmailTemplate'
      responses:
        '200':
          description: Successfully initiated login
          content:
            application/json:
              schema:
                type: object
                description: Response object returned to initiate Passkey login (WebAuthn)
                properties:
                  LoginBeginCredential:
                    type: object
                    description: OpenAPI schema for protocol.PublicKeyCredentialRequestOptions
                    properties:
                      publicKey:
                        $ref: '#/components/schemas/PublicKeyCredentialRequestOptions'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PASSKEY_NOT_CONFIGURED_IN_PROFILE:
                  $ref: '#/components/examples/PASSKEY_NOT_CONFIGURED_IN_PROFILE'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
  /identity/v2/auth/login/passkey/finish:
    post:
      tags:
        - Login
      summary: Complete Login with Passkey
      operationId: finishPasskeyLogin
      description: Completes the login process using a Passkey.
      parameters:
        - $ref: '#/components/parameters/LoginUrl'
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/Options'
        - $ref: '#/components/parameters/InvitationToken'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaOneClickEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaOtpSMSTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasskeyLoginFinish'
      responses:
        '200':
          description: Successfully finish login
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/ACCOUNT_NOT_ALLOWED_TO_LOGIN'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
                PASSKEY_VERIFICATION_FAILED_FOR_BLOCK_LOCKOUT:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED_FOR_BLOCK_LOCKOUT'
                PASSKEY_VERIFICATION_FAILED_FOR_SUSPEND_LOCKOUT:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED_FOR_SUSPEND_LOCKOUT'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED'
                RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK'
                RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK'
                RBA_EMAIL_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_CITY_RISK'
                RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK'
                RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK'
                RBA_EMAIL_VERIFICATION_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_IP_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK'
                RBA_SMS_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_BROWSER_RISK'
                RBA_SMS_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_CITY_RISK'
                RBA_SMS_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_COUNTRY_RISK'
                RBA_SMS_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_DEVICE_RISK'
                RBA_SMS_VERIFICATION_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_IP_RISK'
                PIN_IS_REQUIRED:
                  $ref: '#/components/examples/PIN_IS_REQUIRED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/passkey/autofill/begin:
    get:
      tags:
        - Login
      summary: Initiate Login with Autofill Passkey
      operationId: beginAutofillPasskeyLogin
      description: Begins the login process using an Autofill Passkey.
      responses:
        '200':
          description: Successfully initiated login
          content:
            application/json:
              schema:
                type: object
                description: Response object returned to initiate Passkey login (WebAuthn)
                properties:
                  LoginBeginCredential:
                    type: object
                    description: OpenAPI schema for protocol.PublicKeyCredentialRequestOptions
                    properties:
                      publicKey:
                        $ref: '#/components/schemas/PublicKeyCredentialRequestOptions'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                PASSKEY_AUTOFILL_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_AUTOFILL_NOT_ENABLED_IN_APP'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
  /identity/v2/auth/login/passkey/autofill/finish:
    post:
      tags:
        - Login
      summary: Complete Login with Autofill Passkey
      operationId: finishAutofillPasskeyLogin
      description: Completes the login process using an Autofill Passkey.
      parameters:
        - $ref: '#/components/parameters/LoginUrl'
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/InvitationToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/Options'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaOneClickEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaOtpSMSTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasskeyLoginAutofillRequest'
      responses:
        '200':
          description: Successfully finish login
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                PASSKEY_AUTOFILL_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_AUTOFILL_NOT_ENABLED_IN_APP'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                PASSKEY_NOT_CONFIGURED_IN_PROFILE:
                  $ref: '#/components/examples/PASSKEY_NOT_CONFIGURED_IN_PROFILE'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/ACCOUNT_NOT_ALLOWED_TO_LOGIN'
                PASSKEY_VERIFICATION_FAILED_FOR_BLOCK_LOCKOUT:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED_FOR_BLOCK_LOCKOUT'
                PASSKEY_VERIFICATION_FAILED_FOR_SUSPEND_LOCKOUT:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED_FOR_SUSPEND_LOCKOUT'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED'
                RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK'
                RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK'
                RBA_EMAIL_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_CITY_RISK'
                RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK'
                RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK'
                RBA_EMAIL_VERIFICATION_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_IP_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK'
                RBA_SMS_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_BROWSER_RISK'
                RBA_SMS_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_CITY_RISK'
                RBA_SMS_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_COUNTRY_RISK'
                RBA_SMS_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_DEVICE_RISK'
                RBA_SMS_VERIFICATION_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_IP_RISK'
                PIN_IS_REQUIRED:
                  $ref: '#/components/examples/PIN_IS_REQUIRED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/2fa/register/passkey/begin:
    get:
      tags:
        - Security
      summary: Begin Passkey Registration with MFA Token
      operationId: beginMFAPasskeyRegistration
      description: Begins the MFA Passkey registration flow.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
      responses:
        '200':
          description: Successfully initiated credential registration
          content:
            application/json:
              schema:
                type: object
                description: Response object returned to initiate Passkey registration (WebAuthn)
                properties:
                  RegisterBeginCredential:
                    type: object
                    description: Container for the WebAuthn registration initiation data
                    properties:
                      publicKey:
                        $ref: '#/components/schemas/PublicKeyCredentialCreationOptions'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
      security:
        - APIKey: []
  /identity/v2/auth/login/2fa/register/passkey/finish:
    post:
      tags:
        - Security
      summary: Complete Passkey registration
      operationId: finishMFAPasskeyRegistration
      description: Completes the MFA Passkey registration process using the provided MFA token.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaOneClickEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaOtpSMSTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Passkey Credentials to finish Passkey registration (WebAuthn)
              properties:
                PasskeyCredential:
                  $ref: '#/components/schemas/PasskeyCredentialCreationResponse'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
        '404':
          description: Not Found - the requested resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - APIKey: []
  /identity/v2/auth/login/2fa/passkey/begin:
    get:
      tags:
        - Security
      summary: Begin Passkey Login with MFA Token
      operationId: beginPasskeyMFAVerification
      description: Begins the MFA Passkey verification flow.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
      responses:
        '200':
          description: Successfully initiated login
          content:
            application/json:
              schema:
                type: object
                description: Response object returned to initiate Passkey login (WebAuthn)
                properties:
                  LoginBeginCredential:
                    type: object
                    description: Container for the WebAuthn login initiation data
                    properties:
                      publicKey:
                        $ref: '#/components/schemas/PublicKeyCredentialRequestOptions'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
      security:
        - APIKey: []
  /identity/v2/auth/login/2fa/passkey/finish:
    post:
      tags:
        - Security
      summary: Complete Passkey Login with MFA Token
      operationId: finishPasskeyMFAVerification
      description: Completes the MFA Passkey verification flow.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaOneClickEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaOtpSMSTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Passkey Credentials to finish Passkey verify (WebAuthn)
              properties:
                PasskeyCredential:
                  $ref: '#/components/schemas/PasskeyCredentialAssertionResponse'
      responses:
        '200':
          description: Successfully finish login
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
        '404':
          description: Not Found - the requested resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - APIKey: []
  /identity/v2/auth/login/2fa/push:
    post:
      tags:
        - Security
      summary: Resend Push Notification
      operationId: mfaResendPushNotification
      description: Resends a Push Notification for Multi-Factor Authentication.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
      responses:
        '200':
          description: Push Notification sent for verification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED'
                MFA_PUSH_VERIFICATION_COMPLETE:
                  $ref: '#/components/examples/MFA_PUSH_VERIFICATION_COMPLETE'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_PUSH_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_PUSH_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
                TWO_FACTOR_AUTHENTICATION_PUSH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PUSH_CONFIG_INVALID'
  /identity/v2/auth/login/2fa/push/ping:
    get:
      tags:
        - Security
      summary: Check Push Notification Verification Status
      operationId: pingPushVerificationStatus
      description: Checks the status of Push Notification verification and returns the login response when verified.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaOneClickEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaOtpSMSTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      responses:
        '200':
          description: Successfully verified and give login response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED'
                MFA_PUSH_VERIFICATION_PENDING:
                  $ref: '#/components/examples/MFA_PUSH_VERIFICATION_PENDING'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                MFA_PUSH_VERIFICATION_DENIED:
                  $ref: '#/components/examples/MFA_PUSH_VERIFICATION_DENIED'
  /identity/v2/auth/login/2fa/resend:
    get:
      summary: Resend SMS OTP with MFA Token
      description: Resends the Multi-Factor Authentication OTP via SMS for login.
      operationId: Resend2FAOTP
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/IsVoiceOtp'
      responses:
        '200':
          description: Successful MFA login or MFA challenge required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponseData'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PHONE_NOT_VERIFIED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
  /identity/v2/auth/login/2fa/sms/resend:
    get:
      summary: Resend SMS OTP with MFA Token
      description: Resends the Multi-Factor Authentication OTP via SMS for login.
      operationId: Resend2faSMSOtp
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/IsVoiceOtp'
      responses:
        '200':
          description: Successful MFA login or MFA challenge required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponseData'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PHONE_NOT_VERIFIED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
  /identity/v2/auth/login/2fa/duo:
    put:
      tags:
        - Security
      summary: Verify Duo with MFA Token
      operationId: DuoAuthVerificationByMFASecondFactorToken
      description: Verifies Duo authentication for a User using a second factor token.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaOneClickEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaOtpSMSTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DuoVerifyRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                DUO_CODE_REQUIRED:
                  $ref: '#/components/examples/DUO_CODE_REQUIRED'
                DUO_STATE_REQUIRED:
                  $ref: '#/components/examples/DUO_STATE_REQUIRED'
                DUO_CODE_STATE_REQUIRED:
                  $ref: '#/components/examples/DUO_CODE_STATE_REQUIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                DUO_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/DUO_AUTH_NOT_ENABLED'
                DUO_STATE_NOT_VALID:
                  $ref: '#/components/examples/DUO_STATE_NOT_VALID'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                DUO_AUTHENTICATOR_VERIFICATION_FAILED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_VERIFICATION_FAILED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - APIKey: []
  /identity/v2/auth/login/2fa/backupcode:
    put:
      tags:
        - Security
      summary: Verify Backup Code with MFA Token
      operationId: VerifyBackupCodeForMFALogin
      description: Verifies a User's MFA backup code as a second factor during the login process, typically used when the primary MFA method is unavailable.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TwoFAAuthByBackupCode'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                BACKUP_CODE_REQUIRED:
                  $ref: '#/components/examples/BACKUP_CODE_REQUIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_VALID'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/2fa/email:
    post:
      tags:
        - Security
      summary: Resend Email OTP with MFA Token
      operationId: ResendEmailOTPMFAToken
      description: Sends the OTP to the Email if the Email OTP authenticator is enabled in the Tenant's MFA configuration.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/IsVoiceOtp'
        - $ref: '#/components/parameters/EmailTemplate2FA'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailModel'
      responses:
        '200':
          description: OTP sent successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                EMAIL_ID_REQUIRED:
                  $ref: '#/components/examples/EMAILID_REQUIRD'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                Email_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
    put:
      tags:
        - Security
      summary: Verify Email OTP with MFA Token
      operationId: ValidateMfaOTPByEmail
      description: Logs in to a User's account during the second MFA step with an OTP sent to the Email.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReAuthModelByEmailOtp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                EMAIL_NOT_FORMATTED:
                  $ref: '#/components/examples/EMAIL_NOT_FORMATTED'
                OTP_NOT_FORMATTED:
                  $ref: '#/components/examples/OTP_NOT_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
                INVITATION_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVITATION_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVITATION_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                OPERATION_FAILED_PARTNER:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/email/sendverificationemail:
    get:
      tags:
        - User
      operationId: SendEmailVerification
      summary: Send verification Email for social profile linking
      description: Sends a verification Email to the unverified Email of the social profile. This is applicable only in optional verification workflows.
      parameters:
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/ClientGuid'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: Email Verification request successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendEmailVerificationResponse'
        '400':
          description: Bad Request - Invalid parameters or missing required fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                CLIENT_GUID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_GUID_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_OR_CLIENT_GUID_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_OR_CLIENT_GUID_REQUIRED'
                INVALID_PROVIDER_IN_ORGANIZATION:
                  $ref: '#/components/examples/INVALID_PROVIDER_IN_ORGANIZATION'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                SP_JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SP_JWT_CONFIG_NOT_FOUND'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - Insufficient permissions to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                CLIENT_GUID_NOT_VALID:
                  $ref: '#/components/examples/CLIENT_GUID_NOT_VALID'
                AUTOLOGIN_LINK_ALREADY_USED:
                  $ref: '#/components/examples/AUTOLOGIN_LINK_ALREADY_USED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                EMAILID_VERIFICATION_DISABLE:
                  $ref: '#/components/examples/EMAILID_VERIFICATION_DISABLE'
                NO_CALLBACK_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/NO_CALLBACK_LOGIN_NOT_ENABLED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                PROVIDER_NOT_CONFIGURED:
                  $ref: '#/components/examples/PROVIDER_NOT_CONFIGURED'
                PROVIDER_NOT_SUPPORTED:
                  $ref: '#/components/examples/PROVIDER_NOT_SUPPORTED'
                PROVIDER_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_NOT_VALID'
                PROVIDER_SIDE_ERROR:
                  $ref: '#/components/examples/PROVIDER_SIDE_ERROR'
                JWT_SP_TOKEN_INVALID:
                  $ref: '#/components/examples/JWT_SP_TOKEN_INVALID'
                PROVIDER_ID_MISSING:
                  $ref: '#/components/examples/PROVIDER_ID_MISSING'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_ALLREADY_VERIFIED_TOKEN:
                  $ref: '#/components/examples/EMAIL_ALLREADY_VERIFIED_TOKEN'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
        '500':
          description: Internal Server Error - An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED_PARTNER:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/delete:
    get:
      tags:
        - User
      summary: Delete Account by Email token or OTP
      operationId: DeleteAccount
      description: Deletes an Account using a delete token or OTP.
      parameters:
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/DeleteToken'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/Otp'
      responses:
        '200':
          description: Account deletion request successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - Invalid parameters or missing required fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DELETE_TOKEN_REQUIRED:
                  $ref: '#/components/examples/DELETE_TOKEN_REQUIRED'
                EMAIL_OTP_REQUIRED:
                  $ref: '#/components/examples/EMAIL_OTP_REQUIRED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                OTP_OR_DELETE_TOKEN_REQUIRED:
                  $ref: '#/components/examples/OTP_OR_DELETE_TOKEN_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Status Forbidden - Insufficient permissions to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                DELETE_TOKEN_IS_INVALID:
                  $ref: '#/components/examples/DELETE_TOKEN_IS_INVALID'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                LINK_INVALID:
                  $ref: '#/components/examples/LINK_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
    post:
      summary: Delete Account by Phone OTP
      description: Deletes an Account using a Phone OTP.
      operationId: DeleteAccByPhoneOTP
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/QQCaptchaTicket'
        - $ref: '#/components/parameters/QQCaptchaRandstr'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyDeleteAccountOtp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Status Forbidden - Insufficient permissions to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
                OTP_ALREADY_USED:
                  $ref: '#/components/examples/OTP_ALREADY_USED'
                OTP_EXPIRED:
                  $ref: '#/components/examples/OTP_EXPIRED'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                PHONE_DOES_NOT_EXIST:
                  $ref: '#/components/examples/PHONE_DOES_NOT_EXIST'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
      security:
        - APIKey: []
          BearerToken: []
  /identity/v2/auth/access_token/invalidate:
    get:
      tags:
        - Session
      summary: Invalidate Access Token
      operationId: InvalidateAccessToken
      description: Invalidates an active Access Token, expiring its validity.
      parameters:
        - $ref: '#/components/parameters/PreventRefresh'
      responses:
        '200':
          description: Access Token invalidation request successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Status Bad Request. The request was invalid or malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                PREVENT_REFRESH_NOT_VALID:
                  $ref: '#/components/examples/PREVENT_REFRESH_NOT_VALID'
        '403':
          description: Status Forbidden. The request was valid, but the User does not have the necessary permissions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/privacypolicy/history:
    get:
      tags:
        - User
      operationId: GetPrivacyPolicyHistory
      summary: Retrieve Privacy Policy History
      description: Returns all accepted Privacy Policies for a User using their Access Token.
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: Privacy Policy History retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivacyPolicyHistoryResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '403':
          description: Forbidden - User does not have permission to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/username:
    get:
      tags:
        - Login
      operationId: CheckUserNameAvailability
      summary: Check Username availability
      description: Checks if a Username is available for registration on the platform.
      parameters:
        - $ref: '#/components/parameters/Username'
      responses:
        '200':
          description: Username existence check response
          content:
            application/json:
              schema:
                type: object
                properties:
                  IsExist:
                    type: boolean
                    description: Indicates whether the Username exists in the system.
              example:
                IsExist: true
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                USERNAME_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
    put:
      tags:
        - User
      summary: Update Username
      description: Sets or changes the User's Username using the Access Token.
      operationId: setorchangeusernamebyaccesstoken
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetUserNameRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                USERNAME_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USERNAME_ALREADY_REGISTERED:
                  $ref: '#/components/examples/USERNAME_ALREADY_REGISTERED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account:
    get:
      summary: Retrieve User
      description: Retrieves User details based on the Access Token.
      operationId: getAccountDetails
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      responses:
        '200':
          description: Successfully retrieved account details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                PIN_IS_REQUIRED:
                  $ref: '#/components/examples/PIN_IS_REQUIRED'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                SP_JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SP_JWT_CONFIG_NOT_FOUND'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                SOCIAL_REGISTRATION_NOT_ALLOWED:
                  $ref: '#/components/examples/SOCIAL_REGISTRATION_NOT_ALLOWED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - User does not have permission to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                INVALID_PROVIDER_IN_ORGANIZATION:
                  $ref: '#/components/examples/INVALID_PROVIDER_IN_ORGANIZATION'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                PROVIDER_NOT_CONFIGURED:
                  $ref: '#/components/examples/PROVIDER_NOT_CONFIGURED'
                PROVIDER_NOT_SUPPORTED:
                  $ref: '#/components/examples/PROVIDER_NOT_SUPPORTED'
                PROVIDER_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_NOT_VALID'
                PROVIDER_SIDE_ERROR:
                  $ref: '#/components/examples/PROVIDER_SIDE_ERROR'
                PROVIDER_ID_MISSING:
                  $ref: '#/components/examples/PROVIDER_ID_MISSING'
                EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION'
                AGE_UNDERAGE:
                  $ref: '#/components/examples/AGE_UNDERAGE'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_PHONE_ID:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_PHONE_ID'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                SIGNUP_NOT_ALLOWED_IN_ORG:
                  $ref: '#/components/examples/SIGNUP_NOT_ALLOWED_IN_ORG'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                JWT_SP_TOKEN_INVALID:
                  $ref: '#/components/examples/JWT_SP_TOKEN_INVALID'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                AUTOLOOKUP_DOMAIN_NOT_MATCH:
                  $ref: '#/components/examples/AUTOLOOKUP_DOMAIN_NOT_MATCH'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED'
                SOCIAL_REGISTRATION_NOT_ALLOWED:
                  $ref: '#/components/examples/SOCIAL_REGISTRATION_NOT_ALLOWED'
        '404':
          description: 'Status Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: 'Status Internal Server Error: An unexpected error occurred.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED_PARTNER:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - BearerToken: []
          APIKey: []
    put:
      tags:
        - User
      summary: Update User
      description: Updates the User's account information using a valid Access Token.
      operationId: updateccountbyaccesstoken
      parameters:
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/NullSupport'
        - $ref: '#/components/parameters/IsVoiceOtp'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateByTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                USERNAME_REQUIRED:
                  $ref: '#/components/examples/USERNAME_REQUIRED'
                GENDER_INVALID:
                  $ref: '#/components/examples/GENDER_INVALID'
                BIRTH_DATE_INVALID:
                  $ref: '#/components/examples/BIRTH_DATE_INVALID'
                ADDRESS_TYPE_REQUIRED:
                  $ref: '#/components/examples/ADDRESS_TYPE_REQUIRED'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                ADDRESS_TYPE_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/ADDRESS_TYPE_CAN_NOT_BE_SAME'
                EMAIL_TYPE_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_TYPE_VALUE_REQUIRED_PARAM'
                EMAIL_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_VALUE_REQUIRED_PARAM'
                EMAIL_TYPE_REQUIRED:
                  $ref: '#/components/examples/EMAIL_TYPE_REQUIRED'
                EMAIL_ID_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/EMAIL_ID_CAN_NOT_BE_SAME'
                PRIMARY_EMAIL_CAN_BE_ONLY_ONE:
                  $ref: '#/components/examples/PRIMARY_EMAIL_CAN_BE_ONLY_ONE'
                CUSTOM_FIELD_LENGTH_EXCEEDED:
                  $ref: '#/components/examples/CUSTOM_FIELD_LENGTH_EXCEEDED'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
                PHONE_TYPE_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/PHONE_TYPE_CAN_NOT_BE_SAME'
                PHONE_TYPE_REQUIRED:
                  $ref: '#/components/examples/PHONE_TYPE_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_ID_NOT_ALLOWED_TO_UPDATE:
                  $ref: '#/components/examples/EMAIL_ID_NOT_ALLOWED_TO_UPDATE'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                CUSTOM_FIELD_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                PRIVACY_POLICY_NOT_ACCEPTED:
                  $ref: '#/components/examples/PRIVACY_POLICY_NOT_ACCEPTED'
                ACTIVE_LOGIN_SESSIONS_NOT_ENABLED:
                  $ref: '#/components/examples/ACTIVE_LOGIN_SESSIONS_NOT_ENABLED'
                AGE_UNDERAGE:
                  $ref: '#/components/examples/AGE_UNDERAGE'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                USERNAME_ALREADY_REGISTERED:
                  $ref: '#/components/examples/USERNAME_ALREADY_REGISTERED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/AccessTokenInBody'
                - $ref: '#/components/schemas/ProfileRequestModel'
    delete:
      summary: Send User deletion Email
      description: Sends a confirmation Email for User deletion to the User's Email using their Access Token.
      operationId: deleteccountbyaccesstoken
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/DeleteUrl'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'Status Ok: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleteRequestAccepted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                DELETE_URL_IS_NOT_WHITELISTED:
                  $ref: '#/components/examples/DELETE_URL_IS_NOT_WHITELISTED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                USER_ID_NOT_VALID:
                  $ref: '#/components/examples/USER_ID_NOT_VALID'
                EMAIL_ID_NOT_EXIST_IN_PROFILE:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXIST_IN_PROFILE'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/otp:
    get:
      summary: Retrieve delete Account OTP
      description: Retrieves the OTP for the specified Account to facilitate account deletion.
      operationId: SendDeleteOtp
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/IsVoiceOtp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponse'
        '400':
          description: 'Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '401':
          description: 'Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                PHONE_DOES_NOT_EXIST:
                  $ref: '#/components/examples/PHONE_DOES_NOT_EXIST'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
      security:
        - APIKey: []
          BearerToken: []
  /identity/v2/auth/account/2fa/totp:
    delete:
      tags:
        - Security
      summary: Reset TOTP
      operationId: MFAResetTotpByToken
      description: Resets TOTP Authenticator configurations for an Account using an Access Token.
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED'
      security:
        - BearerToken: []
          APIKey: []
    put:
      summary: Verify TOTP code
      description: Validates an Authenticator Code as part of the MFA process.
      tags:
        - Security
      operationId: Verify2faTOTPAuth
      parameters:
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatorCodeRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                AUTH_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/AUTH_PARAMETER_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT_OLD'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/privacypolicy/accept:
    get:
      tags:
        - User
      summary: Accept Privacy Policy
      description: Updates the Privacy Policy stored in a User's profile using their Access Token.
      operationId: getPrivacyPolicyAcceptance
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      responses:
        '200':
          description: User information along with Privacy Policy acceptance details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '403':
          description: Forbidden - User does not have permission to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                PRIVACY_POLICY_NOT_AVAILABLE:
                  $ref: '#/components/examples/PRIVACY_POLICY_NOT_AVAILABLE'
                PRIVACY_POLICY_ALREADY_ACCEPTED:
                  $ref: '#/components/examples/PRIVACY_POLICY_ALREADY_ACCEPTED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/sendwelcomeemail:
    get:
      tags:
        - User
      summary: Send Welcome Email
      description: Sends a welcome Email to the User.
      operationId: sendWelcomeEmail
      parameters:
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: Invalid request parameters'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: Access denied'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/passkey:
    get:
      tags:
        - User
      summary: List registered Passkeys
      description: Lists all registered Passkeys for a User with a valid Access Token.
      operationId: accountListPasskey
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasskeyListResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_NOT_CONFIGURED_IN_PROFILE:
                  $ref: '#/components/examples/PASSKEY_NOT_CONFIGURED_IN_PROFILE'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/passkey/{passkeyId}:
    delete:
      tags:
        - User
      summary: Remove Passkey
      description: Removes a specific Passkey from the User's Account.
      operationId: accountRemovePasskey
      parameters:
        - $ref: '#/components/parameters/passkeyId'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: Remove Passkey credential from account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_NOT_CONFIGURED_IN_PROFILE:
                  $ref: '#/components/examples/PASSKEY_NOT_CONFIGURED_IN_PROFILE'
                INVALID_PASSKEY_ID:
                  $ref: '#/components/examples/INVALID_PASSKEY_ID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/register/passkey/begin:
    get:
      tags:
        - Login
      summary: Begin Passkey registration
      description: Initiates the Passkey registration process for an Account using an Access Token.
      operationId: accountRegisterPasskeyBegin
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: Successfully initiated credential registration
          content:
            application/json:
              schema:
                type: object
                description: Response object returned to initiate Passkey registration (WebAuthn)
                properties:
                  RegisterBeginCredential:
                    type: object
                    description: Container for the WebAuthn registration initiation data
                    properties:
                      publicKey:
                        $ref: '#/components/schemas/PublicKeyCredentialCreationOptions'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/register/passkey/finish:
    post:
      tags:
        - Login
      summary: Complete Passkey registration
      description: Completes the Passkey registration process for an Account using an Access Token.
      operationId: accountRegisterPasskeyFinish
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Passkey Credentials to finish Passkey registration (WebAuthn)
              properties:
                PasskeyCredential:
                  $ref: '#/components/schemas/PasskeyCredentialCreationResponse'
      responses:
        '200':
          description: Successfully finished credential registration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasskeyListResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/2fa/register/passkey/begin:
    get:
      tags:
        - Security
      summary: Begin MFA Passkey registration
      description: Initiates the MFA Passkey registration flow for an Account.
      operationId: accountRegisterMFAPasskeyBegin
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: Successfully initiated credential registration
          content:
            application/json:
              schema:
                type: object
                description: Response object returned to initiate Passkey registration (WebAuthn)
                properties:
                  RegisterBeginCredential:
                    type: object
                    description: Container for the WebAuthn registration initiation data
                    properties:
                      publicKey:
                        $ref: '#/components/schemas/PublicKeyCredentialCreationOptions'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/2fa/register/passkey/finish:
    post:
      tags:
        - Security
      summary: Complete MFA Passkey registration
      description: Completes the MFA Passkey registration flow for an Account.
      operationId: accountRegistferPasskeyFinish
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - PasskeyCredential
              description: Passkey Credentials to finish Passkey registration (WebAuthn)
              properties:
                PasskeyCredential:
                  $ref: '#/components/schemas/PasskeyCredentialCreationResponse'
      responses:
        '200':
          description: Successfully finished credential registration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasskeyCredentialObject'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/2fa/passkey:
    delete:
      tags:
        - Security
      summary: Reset Passkey Authenticator
      description: Resets the Passkey Authenticator settings for the specified User.
      operationId: ResetMFAPasskeyByAccessToken
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/2fa/duo:
    delete:
      tags:
        - Security
      summary: Reset Duo Authenticator
      description: Resets the Duo Authenticator settings for a User with MFA enabled, allowing reconfiguration or recovery of Duo access.
      operationId: ResetDuoAuthViaAccessToken
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                DUO_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/DUO_AUTH_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_DUO_AUTHENTICATOR_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_DUO_AUTHENTICATOR_NOT_CONFIGURED_ON_PROFILE'
      security:
        - BearerToken: []
          APIKey: []
    put:
      tags:
        - Security
      summary: Verify Duo authentication
      operationId: DuoAuthenticationVerificationByAccessToken
      description: Verifies Duo authentication for a User using an Access Token, typically after initial authentication.
      parameters:
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/Fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DuoVerifyRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                DUO_CODE_REQUIRED:
                  $ref: '#/components/examples/DUO_CODE_REQUIRED'
                DUO_STATE_REQUIRED:
                  $ref: '#/components/examples/DUO_STATE_REQUIRED'
                DUO_CODE_STATE_REQUIRED:
                  $ref: '#/components/examples/DUO_CODE_STATE_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                DUO_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/DUO_AUTH_NOT_ENABLED'
                DUO_STATE_NOT_VALID:
                  $ref: '#/components/examples/DUO_STATE_NOT_VALID'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                DUO_AUTHENTICATOR_VERIFICATION_FAILED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_VERIFICATION_FAILED'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/2fa/backupcode:
    get:
      tags:
        - Security
      summary: Generate backup codes
      description: Generates a set of backup codes for a User with MFA enabled. Returns an error if backup codes already exist.
      operationId: mfaGenerateBackupCodes
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MFABackUpCodeResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
                TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_ALREADY_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_ALREADY_CONFIGURED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/2fa/backupcode/reset:
    get:
      tags:
        - Security
      summary: Reset backup codes
      description: Resets backup codes for a User with MFA enabled, allowing regeneration of backup codes.
      operationId: mfaResetBackupCodes
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MFABackUpCodeResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/reauth/otp/email:
    get:
      summary: Send Email OTP
      description: Sends a One-Time Password (OTP) to the User's Email for re-authentication.
      operationId: SendReAuthEmailOtp
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/EmailId'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                EMAIL_ID_NOT_EXIST_IN_PROFILE:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXIST_IN_PROFILE'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
      security:
        - BearerToken: []
          APIKey: []
    put:
      summary: Verify Email OTP
      description: Validates the One-Time Password (OTP) sent to the User's Email during re-authentication.
      operationId: ValidateEmailOtpForReauth
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReAuthModelByEmailOtp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReAuthResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                OTP_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/OTP_PAYLOAD_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                EMAIL_ID_NOT_EXIST_IN_PROFILE:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXIST_IN_PROFILE'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/passkey/forgot:
    post:
      tags:
        - Login
      summary: Initiate Forgot Passkey
      operationId: PasskeyForgot
      description: Initiates the forgot Passkey process for a User.
      parameters:
        - $ref: '#/components/parameters/ResetPasskeyUrl'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasskeyForgot'
      responses:
        '200':
          description: Successfully submit request to reset the Passkey
          content:
            application/json:
              schema:
                type: object
                properties:
                  IsPosted:
                    type: boolean
                    description: Indicates if the request was successfully posted.
                    example: true
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_REQUIRED_PARAM'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                RESET_PASSKEY_URL_INVALID:
                  $ref: '#/components/examples/RESET_PASSKEY_URL_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
  /identity/v2/auth/passkey/reset/begin:
    get:
      tags:
        - Login
      summary: Begin Passkey Reset
      operationId: beginPasskeyReset
      description: Begins the reset Passkey process for a User.
      parameters:
        - $ref: '#/components/parameters/VToken'
      responses:
        '200':
          description: Successfully initiated Passkey reset
          content:
            application/json:
              schema:
                type: object
                description: Response object returned to initiate new Passkey registration (WebAuthn)
                properties:
                  RegisterBeginCredential:
                    type: object
                    description: Container for the WebAuthn registration initiation data
                    properties:
                      publicKey:
                        $ref: '#/components/schemas/PublicKeyCredentialCreationOptions'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                VERIFICATION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/VERIFICATION_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                LINK_ALREADY_VERIFIED:
                  $ref: '#/components/examples/LINK_ALREADY_VERIFIED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
  /identity/v2/auth/passkey/reset/finish:
    post:
      tags:
        - Login
      summary: Complete Passkey Reset
      operationId: finishPasskeyReset
      description: Completes the reset Passkey process for a User.
      parameters:
        - $ref: '#/components/parameters/VToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Passkey Credentials to finish Passkey registration (WebAuthn)
              properties:
                PasskeyCredential:
                  $ref: '#/components/schemas/PasskeyCredentialCreationResponse'
      responses:
        '200':
          description: Successfully finish reset Passkey process
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                VERIFICATION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/VERIFICATION_TOKEN_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PASS_KEY_CREDENTIAL_REQUIRED:
                  $ref: '#/components/examples/PASS_KEY_CREDENTIAL_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                LINK_ALREADY_VERIFIED:
                  $ref: '#/components/examples/LINK_ALREADY_VERIFIED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PASSKEY_ONLY_SUPPORT_EMAIL:
                  $ref: '#/components/examples/PASSKEY_ONLY_SUPPORT_EMAIL'
                PASSKEY_CONFIG_INVALID:
                  $ref: '#/components/examples/PASSKEY_CONFIG_INVALID'
                PASSKEY_VERIFICATION_FAILED:
                  $ref: '#/components/examples/PASSKEY_VERIFICATION_FAILED'
  /identity/v2/auth/access_token/validate:
    get:
      summary: Validate Access Token
      tags:
        - Session
      description: Validates an Access Token, returning its expiry if valid, or an error if invalid.
      operationId: validateAccessToken
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: 'Status Bad Request: Invalid request parameters'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '403':
          description: 'Status Forbidden: Access denied'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/access_token:
    get:
      summary: Retrieve Access Token information
      tags:
        - Session
      description: Obtains detailed information about the provided Access Token.
      operationId: getAccessToken
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenInfo'
        '400':
          description: 'Status Bad Request: Invalid request parameters'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '403':
          description: 'Status Forbidden: Access denied'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/unlock:
    put:
      tags:
        - User
      summary: Unlock User
      description: Unlocks a User's Account with a valid Access Token after successfully passing Bot Protection challenges.
      operationId: unlockaccountbyaccesstoken
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        $ref: '#/components/requestBodies/UnlockAccountRequest'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Request Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACCOUNT_ALREADY_UNLOCKED:
                  $ref: '#/components/examples/ACCOUNT_ALREADY_UNLOCKED'
                CAPTCHA_IS_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_IS_NOT_VALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/socialidentity:
    delete:
      tags:
        - User
      summary: Unlink social identities
      description: Unlinks a social provider account from the specified Account using Access Tokens, removing it from the database.
      operationId: unlinkSocialIdentitiesByAccessToken
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnlinkSocialIdentityRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
                PROVIDER_IS_REQUIRED:
                  $ref: '#/components/examples/PROVIDER_IS_REQUIRED'
                PROVIDER_ID_IS_REQUIRED:
                  $ref: '#/components/examples/PROVIDER_ID_IS_REQUIRED'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ENDPOINT_NOT_SUPPORTED_BY_PROVIDER:
                  $ref: '#/components/examples/ENDPOINT_NOT_SUPPORTED_BY_PROVIDER'
                ACCOUNT_LINKING_DISABLED:
                  $ref: '#/components/examples/ACCOUNT_LINKING_DISABLED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                SAME_ACCOUNT_CANT_BE_UNLINKED:
                  $ref: '#/components/examples/SAME_ACCOUNT_CANT_BE_UNLINKED'
                ACCOUNT_IS_NOT_LINKED_WITH_ANY_ACCOUNT:
                  $ref: '#/components/examples/ACCOUNT_IS_NOT_LINKED_WITH_ANY_ACCOUNT'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                PROVIDER_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_NOT_VALID'
                PROVIDER_ID_NOT_LINKED_WITH_THIS_ACCOUNT:
                  $ref: '#/components/examples/PROVIDER_ID_NOT_LINKED_WITH_THIS_ACCOUNT'
      security:
        - BearerToken: []
          APIKey: []
    post:
      summary: Link social identities
      description: Links a social provider account to an existing Account using Access Tokens.
      operationId: linkSocialIdentitiesByAccessToken
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CandidateTokenModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                CANDIDATE_TOKEN_REQUIRED:
                  $ref: '#/components/examples/CANDIDATE_TOKEN_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                SP_JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SP_JWT_CONFIG_NOT_FOUND'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCOUNT_LINKING_DISABLED:
                  $ref: '#/components/examples/ACCOUNT_LINKING_DISABLED'
                SAME_PROVIDER_CANT_BE_LINKED:
                  $ref: '#/components/examples/SAME_PROVIDER_CANT_BE_LINKED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                EMAIL_NOT_VERIFIED_CAN_NOT_LINK:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED_CAN_NOT_LINK'
                PROVIDER_NOT_CONFIGURED:
                  $ref: '#/components/examples/PROVIDER_NOT_CONFIGURED'
                PROVIDER_NOT_SUPPORTED:
                  $ref: '#/components/examples/PROVIDER_NOT_SUPPORTED'
                PROVIDER_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_NOT_VALID'
                PROVIDER_SIDE_ERROR:
                  $ref: '#/components/examples/PROVIDER_SIDE_ERROR'
                JWT_SP_TOKEN_INVALID:
                  $ref: '#/components/examples/JWT_SP_TOKEN_INVALID'
                PROVIDER_ID_MISSING:
                  $ref: '#/components/examples/PROVIDER_ID_MISSING'
                AGE_UNDERAGE:
                  $ref: '#/components/examples/AGE_UNDERAGE'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                ACCOUNT_IS_ALREADY_EXIST_WITH_SAME_EMAIL:
                  $ref: '#/components/examples/ACCOUNT_IS_ALREADY_EXIST_WITH_SAME_EMAIL'
                SAME_ACCOUNT_CANT_BE_LINKED:
                  $ref: '#/components/examples/SAME_ACCOUNT_CANT_BE_LINKED'
                ACCOUNT_IS_ALREADY_LINKED:
                  $ref: '#/components/examples/ACCOUNT_IS_ALREADY_LINKED'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/socialidentity/ping:
    post:
      summary: Link social identities via PING
      description: Links a social provider account with an existing Account using the Access Token and the social provider's User Access Token.
      operationId: LinkSocialIdentitiesByPing
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientGuidBodyModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                SP_JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SP_JWT_CONFIG_NOT_FOUND'
                CLIENT_GUID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_GUID_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                NO_CALLBACK_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/NO_CALLBACK_LOGIN_NOT_ENABLED'
                CLIENT_GUID_NOT_VALID:
                  $ref: '#/components/examples/CLIENT_GUID_NOT_VALID'
                ENDPOINT_NOT_SUPPORTED_BY_PROVIDER:
                  $ref: '#/components/examples/ENDPOINT_NOT_SUPPORTED_BY_PROVIDER'
                AUTOLOGIN_LINK_ALREADY_USED:
                  $ref: '#/components/examples/AUTOLOGIN_LINK_ALREADY_USED'
                ACCOUNT_LINKING_DISABLED:
                  $ref: '#/components/examples/ACCOUNT_LINKING_DISABLED'
                SAME_PROVIDER_CANT_BE_LINKED:
                  $ref: '#/components/examples/SAME_PROVIDER_CANT_BE_LINKED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                EMAIL_NOT_VERIFIED_CAN_NOT_LINK:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED_CAN_NOT_LINK'
                PROVIDER_NOT_CONFIGURED:
                  $ref: '#/components/examples/PROVIDER_NOT_CONFIGURED'
                PROVIDER_NOT_SUPPORTED:
                  $ref: '#/components/examples/PROVIDER_NOT_SUPPORTED'
                PROVIDER_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_NOT_VALID'
                PROVIDER_SIDE_ERROR:
                  $ref: '#/components/examples/PROVIDER_SIDE_ERROR'
                JWT_SP_TOKEN_INVALID:
                  $ref: '#/components/examples/JWT_SP_TOKEN_INVALID'
                PROVIDER_ID_MISSING:
                  $ref: '#/components/examples/PROVIDER_ID_MISSING'
                AGE_UNDERAGE:
                  $ref: '#/components/examples/AGE_UNDERAGE'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                ACCOUNT_IS_ALREADY_EXIST_WITH_SAME_EMAIL:
                  $ref: '#/components/examples/ACCOUNT_IS_ALREADY_EXIST_WITH_SAME_EMAIL'
                SAME_ACCOUNT_CANT_BE_LINKED:
                  $ref: '#/components/examples/SAME_ACCOUNT_CANT_BE_LINKED'
                ACCOUNT_IS_ALREADY_LINKED:
                  $ref: '#/components/examples/ACCOUNT_IS_ALREADY_LINKED'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/2fa/push:
    delete:
      tags:
        - Security
      summary: Reset MFA Push Notification
      operationId: ResetMfaPushAuthSettings
      description: Resets the MFA Push Authenticator settings for a User.
      responses:
        '200':
          description: 'Status OK: The request has succeeded and the MFA Push Authenticator settings have been reset.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but is refusing to fulfill it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_PUSH_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_PUSH_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
  /identity/v2/auth/onetouchlogin/email:
    post:
      summary: Retrieve link or OTP for one-touch login
      description: Initiates a one-touch login process using an Email.
      operationId: OneTouchLoginByEmail
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/RedirectUrl'
        - $ref: '#/components/parameters/OneTouchLoginEmailTemplate'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OneTouchLoginByEmail'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                CLIENT_GUID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_GUID_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                EMAILID_REQUIRD:
                  $ref: '#/components/examples/EMAILID_REQUIRD'
                CAPTCHA_REQUIRED:
                  $ref: '#/components/examples/CAPTCHA_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CAPTCHA_IS_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_IS_NOT_VALID'
                NO_REGISTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/NO_REGISTRATION_NOT_ENABLED'
                EMAILID_REQUIRD:
                  $ref: '#/components/examples/EMAILID_REQUIRD'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                CLIENT_GUID_MUST_BE_UNIQUE:
                  $ref: '#/components/examples/CLIENT_GUID_MUST_BE_UNIQUE'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                REDIRECT_URL_IS_NOT_WHITELISTED:
                  $ref: '#/components/examples/REDIRECT_URL_IS_NOT_WHITELISTED'
  /identity/v2/auth/onetouchlogin/phone:
    post:
      summary: Retrieve OTP for one-touch login
      description: Initiates a one-touch login process using a Phone number.
      operationId: OneTouchLoginByPhone
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/IsVoiceOtp'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OneTouchLoginByPhone'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
                CAPTCHA_REQUIRED:
                  $ref: '#/components/examples/CAPTCHA_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CAPTCHA_IS_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_IS_NOT_VALID'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                NO_REGISTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/NO_REGISTRATION_NOT_ENABLED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
  /identity/v2/auth/onetouchlogin/phone/verify:
    post:
      summary: Verify one-touch login
      description: Verifies a one-time passcode (OTP) for login without requiring User registration, including captcha validation and optional security answers.
      operationId: LoginByNoRegistrationPassCode
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/Otp'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyOtpPhoneModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                NO_REGISTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/NO_REGISTRATION_NOT_ENABLED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/PHONE_NOT_VERIFIED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
                OTP_ALREADY_USED:
                  $ref: '#/components/examples/OTP_ALREADY_USED'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/email/onetouchlogin:
    get:
      summary: Verify one-touch login by Email
      description: Verifies the auto-login Email using a Verification Token.
      operationId: VerifyAutoLoginEmailOneTouch
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/VerificationToken'
        - $ref: '#/components/parameters/VToken'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedVerified'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                VERIFICATION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/VERIFICATION_TOKEN_REQUIRED'
                EMAILID_REQUIRD:
                  $ref: '#/components/examples/EMAILID_REQUIRD'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                NO_REGISTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/NO_REGISTRATION_NOT_ENABLED'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                NO_REGISTRATION_LOGIN_LINK_ALREADY_USED:
                  $ref: '#/components/examples/NO_REGISTRATION_LOGIN_LINK_ALREADY_USED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
  /identity/v2/auth/account/reauth/pin:
    put:
      description: Verifies the PIN for a User using an Access Token, typically used when re-verification is required.
      summary: Verify PIN
      operationId: ReauthPin
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinReauthRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReAuthResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '401':
          description: 'Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PIN_AUTH_WRONG:
                  $ref: '#/components/examples/PIN_AUTH_WRONG'
        '403':
          description: 'Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                PIN_NOT_CONFIGURED:
                  $ref: '#/components/examples/PIN_NOT_CONFIGURED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/reauth/2fa/duo:
    put:
      tags:
        - Security
      summary: Verify Duo
      operationId: DuoAuthenticationReAuthVerificationByAccessToken
      description: Verifies Duo authentication for a User using an Access Token, typically used when re-verification is required.
      parameters:
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DuoVerifyRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReAuthResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                DUO_CODE_REQUIRED:
                  $ref: '#/components/examples/DUO_CODE_REQUIRED'
                DUO_STATE_REQUIRED:
                  $ref: '#/components/examples/DUO_STATE_REQUIRED'
                DUO_CODE_STATE_REQUIRED:
                  $ref: '#/components/examples/DUO_CODE_STATE_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                DUO_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/DUO_AUTH_NOT_ENABLED'
                DUO_STATE_NOT_VALID:
                  $ref: '#/components/examples/DUO_STATE_NOT_VALID'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_DUO_AUTHENTICATOR_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_DUO_AUTHENTICATOR_NOT_CONFIGURED_ON_PROFILE'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                DUO_AUTHENTICATOR_VERIFICATION_FAILED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_VERIFICATION_FAILED'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/reauth/password:
    put:
      summary: Verify Password
      description: Verifies the Password for a User using an Access Token, typically used when re-verification is required.
      operationId: ReauthPassword
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordReauthRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReAuthResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
        '401':
          description: 'Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PASSWORD_IS_WRONG:
                  $ref: '#/components/examples/PASSWORD_IS_WRONG'
        '403':
          description: 'Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/reauth/2fa:
    get:
      summary: Retrieve Step-Up Authentication settings
      description: Triggers Step-Up Authentication for Multi-Factor Authentication (MFA) settings, allowing Users to verify their MFA methods.
      operationId: ReauthTrigger
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/SMSTemplate2FA'
        - $ref: '#/components/parameters/DuoRedirectUri'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TwoFactorAuthenticationSettings'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                DUO_REDIRECT_URI_REQUIRED:
                  $ref: '#/components/examples/DUO_REDIRECT_URI_REQUIRED'
        '403':
          description: 'Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                DUO_AUTHENTICATOR_REDIRECT_URI_INVALID:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_INVALID'
                DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/PHONE_NOT_VERIFIED'
                EMAIL_OR_PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_OR_PHONE_NOT_VERIFIED'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD_MFA:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD_MFA'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/reauth/2fa/{type}:
    put:
      summary: Verify backup code or OTP
      description: Validates the triggered MFA authentication flow using a backup code, OTP, or authenticator code.
      operationId: ValidateReauthMFA
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/ReAuthType'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReAuthTwoFAModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReAuthResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                BACKUP_CODE_REQUIRED:
                  $ref: '#/components/examples/BACKUP_CODE_REQUIRED'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                GOOGLE_AUTH_CODE_REQUIRED:
                  $ref: '#/components/examples/GOOGLE_AUTH_CODE_REQUIRED'
                AUTHENTICATOR_CODE_REQUIRED:
                  $ref: '#/components/examples/AUTHENTICATOR_CODE_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG'
                TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT_OLD_MFA:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT_OLD_MFA'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT'
                TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_CONFIGURED'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RESOURCE_NOT_FOUND:
                  $ref: '#/components/examples/RESOURCE_NOT_FOUND'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/reauth/2fa/otp/email/verify:
    put:
      summary: Verify Email OTP
      description: Verifies the User with Email OTP and Access Token, typically used when re-authentication via Email OTP is required.
      operationId: ValidateEmailOtpForReauthMFA
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReAuthModelByEmailOtp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReAuthResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                OTP_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/OTP_PAYLOAD_REQUIRED'
        '403':
          description: 'Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/reauth/2fa/email:
    get:
      summary: Send Email OTP
      description: Sends a One-Time Password (OTP) to the User's Email for re-authentication.
      operationId: SendReAuthEmailOTP
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/EmailId'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                EMAIL_ID_NOT_EXIST_IN_PROFILE:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXIST_IN_PROFILE'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/reauth/2fa/securityquestionanswer/verify:
    post:
      summary: Verify security question answer
      description: Validates the triggered MFA authentication flow using a security question answer.
      operationId: ValidateSecurityQuestionReauthMFA
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TwoFAAuthBySecQuesAuthModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReAuthResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                SECURITY_QUES_ANS_REQUIRED:
                  $ref: '#/components/examples/SECURITY_QUES_ANS_REQUIRED'
        '403':
          description: 'Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                TWO_FACTOR_SECURITY_QUESTION_AUTHENTICATION_NOT_VERIFIED:
                  $ref: '#/components/examples/TWO_FACTOR_SECURITY_QUESTION_AUTHENTICATION_NOT_VERIFIED'
                TWO_FACTOR_AUTHENTICATION_METHOD_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_METHOD_ENABLED'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_QUESTION_NOT_SAVED_IN_PROFILE:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_SAVED_IN_PROFILE'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/email/smartlogin:
    get:
      summary: Verify smart login by Email
      description: Verifies the auto-login Email using a Verification Token.
      operationId: VerifyAutoLoginEmailSmartLogin
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/VerificationToken'
        - $ref: '#/components/parameters/VToken'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedVerified'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAILID_REQUIRD:
                  $ref: '#/components/examples/EMAILID_REQUIRD'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                VERIFICATION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/VERIFICATION_TOKEN_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AUTOLOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/AUTOLOGIN_NOT_ENABLED'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                AUTOLOGIN_LINK_ALREADY_USED:
                  $ref: '#/components/examples/AUTOLOGIN_LINK_ALREADY_USED'
                AUTOLOGIN_LINK_ALREADY_VERIFIED:
                  $ref: '#/components/examples/AUTOLOGIN_LINK_ALREADY_VERIFIED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
  /identity/v2/auth/login/smartlogin:
    get:
      summary: Retrieve OTP or Link for Smart Login
      description: Initiates a smart login process using Email, Username, or Phone, allowing flexibility based on the User's input.
      operationId: GetSmartLogin
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/Username'
        - $ref: '#/components/parameters/Phone'
        - $ref: '#/components/parameters/ClientGuid'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/RedirectUrl'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/IsVoiceOtp'
        - $ref: '#/components/parameters/SmartLoginEmailTemplate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED'
                CLIENT_GUID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_GUID_REQUIRED'
                EMAIL_PHONE_USERNAME_AND_CLIENT_GUID_REQUIRED:
                  $ref: '#/components/examples/EMAIL_PHONE_USERNAME_AND_CLIENT_GUID_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_NAME_AUTHENTICATION_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                AUTOLOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/AUTOLOGIN_NOT_ENABLED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/PHONE_NOT_VERIFIED'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                CLIENT_GUID_MUST_BE_UNIQUE:
                  $ref: '#/components/examples/CLIENT_GUID_MUST_BE_UNIQUE'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                OTP_LIMIT_REACHED:
                  $ref: '#/components/examples/OTP_LIMIT_REACHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                REDIRECT_URL_IS_NOT_WHITELISTED:
                  $ref: '#/components/examples/REDIRECT_URL_IS_NOT_WHITELISTED'
  /identity/v2/auth/login/smartlogin/ping:
    get:
      summary: Ping Smart Login
      description: Checks in the background if the smart login is verified successfully.
      operationId: PingSmartLogin
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/ClientGuidRequired'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CLIENT_GUID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_GUID_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AUTOLOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/AUTOLOGIN_NOT_ENABLED'
                CLIENT_GUID_NOT_VALID:
                  $ref: '#/components/examples/CLIENT_GUID_NOT_VALID'
                AUTOLOGIN_LINK_ALREADY_USED:
                  $ref: '#/components/examples/AUTOLOGIN_LINK_ALREADY_USED'
                AUTOLOGIN_LINK_NOT_VERIFIED:
                  $ref: '#/components/examples/AUTOLOGIN_LINK_NOT_VERIFIED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
  /identity/v2/auth/login/passwordlesslogin/email:
    get:
      summary: Initiate passwordless login by Email
      description: Initiates a Passwordless login process using an Email.
      operationId: PasswordlessLoginByEmail
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/Username'
        - $ref: '#/components/parameters/PasswordlessLoginTemplate'
        - $ref: '#/components/parameters/VerificationUrl'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                EMAILID_REQUIRD:
                  $ref: '#/components/examples/EMAILID_REQUIRD'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                USER_NAME_AUTHENTICATION_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED'
                ONE_CLICK_SIGIN_NOT_ENABLED:
                  $ref: '#/components/examples/ONE_CLICK_SIGIN_NOT_ENABLED'
                TOKEN_LIMIT_REACHED:
                  $ref: '#/components/examples/TOKEN_LIMIT_REACHED'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/passwordlesslogin/otp:
    post:
      summary: Initiate passwordless login by Phone
      description: Initiates a Passwordless login process using a Phone number and CAPTCHA validation.
      operationId: PasswordlessLoginByPhone
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/Phone'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateTokenResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID'
                PHONE_NUMBER_NOT_EXISTS:
                  $ref: '#/components/examples/PHONE_NUMBER_NOT_EXISTS'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                OTP_LIMIT_REACHED:
                  $ref: '#/components/examples/OTP_LIMIT_REACHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
  /identity/v2/auth/login/passwordlesslogin/email/verify:
    get:
      summary: Verify Email for passwordless login
      description: Verifies the Email using the provided Verification Token for passwordless login.
      operationId: PasswordlessEmailVerification
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/VerificationToken'
        - $ref: '#/components/parameters/WelcomeEmailTemplate'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/SMSTemplate2FA'
        - $ref: '#/components/parameters/DuoRedirectUri'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AuthResponseRequiredMfa'
                  - $ref: '#/components/schemas/AuthResponseOptionalMfa'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                VERIFICATION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/VERIFICATION_TOKEN_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                DUO_REDIRECT_URI_REQUIRED:
                  $ref: '#/components/examples/DUO_REDIRECT_URI_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ONE_CLICK_SIGIN_NOT_ENABLED:
                  $ref: '#/components/examples/ONE_CLICK_SIGIN_NOT_ENABLED'
                VERIFICATION_OTP_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_OTP_NOT_VALID'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                LINK_ALREADY_USED:
                  $ref: '#/components/examples/LINK_ALREADY_USED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                DUO_AUTHENTICATOR_REDIRECT_URI_INVALID:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_INVALID'
                DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/passwordlesslogin/otp/verify:
    put:
      summary: Verify Phone for passwordless login
      description: Verifies the OTP sent to the Phone number for passwordless login.
      operationId: PasswordlessLoginPhoneVerification
      tags:
        - Login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneOTPModel'
      parameters:
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/EmailTemplate2FA'
        - $ref: '#/components/parameters/DuoRedirectUri'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AuthResponseRequiredMfa'
                  - $ref: '#/components/schemas/AuthResponseOptionalMfa'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                PHONE_NOT_BLANK:
                  $ref: '#/components/examples/PHONE_NOT_BLANK'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
                OTP_NOT_BLANK:
                  $ref: '#/components/examples/OTP_NOT_BLANK'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                DUO_REDIRECT_URI_REQUIRED:
                  $ref: '#/components/examples/DUO_REDIRECT_URI_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/PHONE_NOT_VERIFIED'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
                OTP_ALREADY_USED:
                  $ref: '#/components/examples/OTP_ALREADY_USED'
                OTP_EXPIRED:
                  $ref: '#/components/examples/OTP_EXPIRED'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                DUO_AUTHENTICATOR_REDIRECT_URI_INVALID:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_INVALID'
                DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/passwordlesslogin/username/verifyotp:
    post:
      summary: Verify Username for passwordless login
      description: Verifies the OTP sent to the Username for passwordless login.
      operationId: PasswordlessLoginByUsernameAndOTP
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/SMSTemplate2FA'
        - $ref: '#/components/parameters/DuoRedirectUri'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordLessUserNameOTPModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AuthResponseRequiredMfa'
                  - $ref: '#/components/schemas/AuthResponseOptionalMfa'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                OTP_NOT_BLANK:
                  $ref: '#/components/examples/OTP_NOT_BLANK'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                USER_NAME_NOT_BLANK:
                  $ref: '#/components/examples/USER_NAME_NOT_BLANK'
                USERNAME_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                DUO_REDIRECT_URI_REQUIRED:
                  $ref: '#/components/examples/DUO_REDIRECT_URI_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_NAME_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_NOT_ENABLED'
                ONE_CLICK_SIGIN_NOT_ENABLED:
                  $ref: '#/components/examples/ONE_CLICK_SIGIN_NOT_ENABLED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                VERIFICATION_OTP_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_OTP_NOT_VALID'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                LINK_ALREADY_USED:
                  $ref: '#/components/examples/LINK_ALREADY_USED'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                DUO_AUTHENTICATOR_REDIRECT_URI_INVALID:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_INVALID'
                DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/passwordlesslogin/email/verifyotp:
    post:
      summary: Verify Email and OTP for passwordless login
      description: Verifies the OTP sent to the Email for passwordless login.
      operationId: PasswordlessLoginByEmailAndOTP
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/SMSTemplate2FA'
        - $ref: '#/components/parameters/DuoRedirectUri'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordLessEmailOTPModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AuthResponseRequiredMfa'
                  - $ref: '#/components/schemas/AuthResponseOptionalMfa'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                OTP_NOT_BLANK:
                  $ref: '#/components/examples/OTP_NOT_BLANK'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                EMAIL_NOT_BLANK:
                  $ref: '#/components/examples/EMAIL_NOT_BLANK'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                DUO_REDIRECT_URI_REQUIRED:
                  $ref: '#/components/examples/DUO_REDIRECT_URI_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_NAME_AUTHENTICATION_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                ONE_CLICK_SIGIN_NOT_ENABLED:
                  $ref: '#/components/examples/ONE_CLICK_SIGIN_NOT_ENABLED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                VERIFICATION_OTP_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_OTP_NOT_VALID'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                LINK_ALREADY_USED:
                  $ref: '#/components/examples/LINK_ALREADY_USED'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                DUO_AUTHENTICATOR_REDIRECT_URI_INVALID:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_INVALID'
                DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED:
                  $ref: '#/components/examples/DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/pin:
    post:
      summary: Login with PIN
      description: Allows Users to log in using their previously set PIN along with a valid session token.
      operationId: PINLogin
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/SessionTokenQuery'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQCaptchaTicket'
        - $ref: '#/components/parameters/QQCaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PINLoginModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PIN_REQUIRED_PARAM:
                  $ref: '#/components/examples/PIN_REQUIRED_PARAM'
                SESSION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SESSION_TOKEN_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                PIN_AUTH_WRONG:
                  $ref: '#/components/examples/PIN_AUTH_WRONG'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                PIN_AUTH_SESSION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/PIN_AUTH_SESSION_TOKEN_NOT_VALID'
                PIN_AUTH_SESSION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/PIN_AUTH_SESSION_TOKEN_EXPIRED'
                PIN_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_LOGIN_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                PIN_NOT_CONFIGURED:
                  $ref: '#/components/examples/PIN_NOT_CONFIGURED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
  /identity/v2/auth/customobject:
    get:
      summary: Retrieve Custom Objects
      description: Retrieves Custom Objects associated with the authenticated User using an Access Token.
      operationId: getCustomObjectByToken
      tags:
        - Custom Object
      parameters:
        - $ref: '#/components/parameters/CustomObjectId'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: Successfully retrieved Custom Objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectsResponseModel'
              examples:
                default:
                  $ref: '#/components/examples/CUSTOM_OBJECTS_RESPONSE_EXAMPLE'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                CUSTOM_OBJECT_RECORD_NOT_EXIST:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RECORD_NOT_EXIST'
      security:
        - BearerToken: []
          APIKey: []
    post:
      summary: Create Custom Object
      description: Creates a Custom Object associated with the authenticated User using an Access Token.
      operationId: createCustomObjectByToken
      tags:
        - Custom Object
      parameters:
        - $ref: '#/components/parameters/CustomObjectId'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectRequest'
      responses:
        '200':
          description: Successfully created the Custom Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponseModel'
              examples:
                default:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RESPONSE_EXAMPLE'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                CUSTOM_OBJECT_JSON_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_JSON_NOT_VALID'
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/customobject/{objectrecordid}:
    get:
      summary: Retrieve Custom Object by ID
      description: Retrieves the Custom Object associated with the specified User using an Access Token and record ID.
      operationId: getCustomObjectByTokenAndRecordId
      tags:
        - Custom Object
      parameters:
        - $ref: '#/components/parameters/ObjectRecordId'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/CustomObjectId'
      responses:
        '200':
          description: Successfully retrieved the Custom Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponseModel'
              examples:
                default:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RESPONSE_EXAMPLE'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                CUSTOM_OBJECT_RECORD_ID_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RECORD_ID_NOT_VALID'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
      security:
        - BearerToken: []
          APIKey: []
    put:
      summary: Update Custom Object by ID
      description: Updates a Custom Object associated with the authenticated User using an Access Token and record ID.
      operationId: updateCustomObjectByTokenAndRecordId
      tags:
        - Custom Object
      parameters:
        - $ref: '#/components/parameters/ObjectRecordId'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/UpdateType'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/CustomObjectId'
      requestBody:
        description: JSON payload representing the Custom Object to be updated.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectRequest'
      responses:
        '200':
          description: Successfully updated the Custom Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponseModel'
              examples:
                default:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RESPONSE_EXAMPLE'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                CUSTOM_OBJECT_JSON_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_JSON_NOT_VALID'
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                CUSTOM_OBJECT_RECORD_ID_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RECORD_ID_NOT_VALID'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
      security:
        - BearerToken: []
          APIKey: []
    delete:
      summary: Delete Custom Object by ID
      description: Deletes the Custom Object associated with the specified User using an Access Token and record ID.
      operationId: deleteCustomObjectByTokenAndRecordId
      tags:
        - Custom Object
      parameters:
        - $ref: '#/components/parameters/ObjectRecordId'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/CustomObjectId'
      responses:
        '200':
          description: Successfully deleted the Custom Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                CUSTOM_OBJECT_RECORD_ID_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RECORD_ID_NOT_VALID'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/phone:
    put:
      summary: Change Phone number
      description: Updates the User's Phone number using the Access Token.
      operationId: ChangePhoneNumber
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/IsVoiceOtp'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneIdModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
      security:
        - BearerToken: []
          APIKey: []
    delete:
      summary: Remove Phone number
      description: Removes the User's Phone number using the Access Token.
      operationId: RemovePhoneIdByToken
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED'
                PHONE_NUMBER_NOT_EXISTS:
                  $ref: '#/components/examples/PHONE_NUMBER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
      security:
        - BearerToken: []
          APIKey: []
    get:
      summary: Check Phone availability
      description: Verifies if a Phone number is available for registration.
      operationId: GetPhoneNumberAvailability
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/Phone'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsExist'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
  /identity/v2/auth/phone/otp:
    post:
      summary: Resend Phone OTP
      description: Resends the Phone OTP using either the Access Token or Phone number.
      operationId: ResendPhoneOtp
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/IsVoiceOtp'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneIdModelOptional'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                PHONE_NUMBER_NOT_EXISTS:
                  $ref: '#/components/examples/PHONE_NUMBER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                PHONE_NUMBER_ALREADY_VERIFIED:
                  $ref: '#/components/examples/PHONE_NUMBER_ALREADY_VERIFIED'
                ACCESS_TOKEN_INVALID_OR_PHONE_NUMBER_ALREADY_VERIFIED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_PHONE_NUMBER_ALREADY_VERIFIED'
      security:
        - BearerToken: []
          APIKey: []
          ClientId: []
    put:
      summary: Verify Phone
      description: Validates the verification code sent to confirm a User's Phone number when the User is logged in and provides an Access Token.
      operationId: VerifyPhoneOtp
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/Otp'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQRecaptchaTicket'
        - $ref: '#/components/parameters/QQRecaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyOtpPhoneModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/IsPostedResponse'
                  - $ref: '#/components/schemas/AuthResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                INVITATION_TOKEN_INVALID:
                  $ref: '#/components/examples/INVITATION_TOKEN_INVALID'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PHONE_NUMBER_ALREADY_VERIFIED:
                  $ref: '#/components/examples/PHONE_NUMBER_ALREADY_VERIFIED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_ALREADY_USED:
                  $ref: '#/components/examples/OTP_ALREADY_USED'
                OTP_EXPIRED:
                  $ref: '#/components/examples/OTP_EXPIRED'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                PIN_IS_REQUIRED:
                  $ref: '#/components/examples/PIN_IS_REQUIRED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                APP_NOT_EXISTS:
                  $ref: '#/components/examples/APP_NOT_EXISTS'
                CONSENT_FORM_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_AVAILABLE'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                PHONE_NUMBER_NOT_EXISTS:
                  $ref: '#/components/examples/PHONE_NUMBER_NOT_EXISTS'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
                RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK'
                RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK'
                RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK'
                RBA_EMAIL_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_CITY_RISK'
                RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK'
                RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK'
                RBA_EMAIL_VERIFICATION_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION_BY_IP_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK'
                RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK'
                RBA_SMS_VERIFICATION_BY_BROWSER_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_BROWSER_RISK'
                RBA_SMS_VERIFICATION_BY_CITY_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_CITY_RISK'
                RBA_SMS_VERIFICATION_BY_COUNTRY_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_COUNTRY_RISK'
                RBA_SMS_VERIFICATION_BY_DEVICE_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_DEVICE_RISK'
                RBA_SMS_VERIFICATION_BY_IP_RISK:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION_BY_IP_RISK'
  /identity/v2/auth/pin/change:
    post:
      tags:
        - Security
      summary: Update PIN with Access Token
      operationId: ChangePinByAccessToken
      description: Updates an existing PIN by providing the current PIN and a valid Access Token for authentication, allowing a User to change their PIN while logged in.
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePin'
      responses:
        '200':
          description: Successfully submit request to reset the PIN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                OLD_PIN_REQUIRED_PARAM:
                  $ref: '#/components/examples/OLD_PIN_REQUIRED_PARAM'
                NEW_PIN_REQUIRED_PARAM:
                  $ref: '#/components/examples/NEW_PIN_REQUIRED_PARAM'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
                OLD_PIN_WRONG:
                  $ref: '#/components/examples/OLD_PIN_WRONG'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                PIN_NOT_CONFIGURED:
                  $ref: '#/components/examples/PIN_NOT_CONFIGURED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/pin/set/pinauthtoken:
    post:
      tags:
        - Security
      summary: Set PIN with Authentication Token
      operationId: setPinByPinAuthToken
      description: Sets a PIN for Users logging in or registering for the first time. Requires a valid PIN authentication token and is typically part of the onboarding or initial setup process.
      parameters:
        - $ref: '#/components/parameters/PinAuthTokenQuery'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PINModel'
      responses:
        '200':
          description: Successfully submit request to reset the PIN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PIN_REQUIRED_PARAM:
                  $ref: '#/components/examples/PIN_REQUIRED_PARAM'
                PIN_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/PIN_AUTH_TOKEN_REQUIRED'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                PIN_AUTH_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/PIN_AUTH_TOKEN_NOT_VALID'
                PIN_AUTH_TOKEN_EXPIRED:
                  $ref: '#/components/examples/PIN_AUTH_TOKEN_EXPIRED'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
  /identity/v2/auth/pin/forgot/email:
    post:
      tags:
        - Security
      summary: Send PIN Reset Email
      operationId: forgotPinByEmail
      description: Sends a PIN reset Email to the User's registered Email, enabling them to reset their PIN if forgotten.
      parameters:
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/ResetPinURL'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgotPinByEmail'
      responses:
        '200':
          description: Successfully submit request to reset the PIN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                USER_NAME_AUTHENTICATION_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED'
                RESET_PIN_URL_INVALID:
                  $ref: '#/components/examples/RESET_PIN_URL_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
  /identity/v2/auth/pin/forgot/username:
    post:
      tags:
        - Security
      summary: Send PIN Reset Email by Username
      operationId: forgotPinByUsername
      description: Sends a PIN reset Email to the User IDentified by their Username, enabling them to reset their PIN if forgotten.
      parameters:
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/ResetPinURL'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgotPinByUsername'
      responses:
        '200':
          description: Successfully submit request to reset the PIN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                RESET_PIN_URL_INVALID:
                  $ref: '#/components/examples/RESET_PIN_URL_INVALID'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                EMAIL_ID_NOT_EXIST_IN_PROFILE:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXIST_IN_PROFILE'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
  /identity/v2/auth/pin/forgot/otp:
    post:
      tags:
        - Security
      summary: Send OTP for PIN Reset
      operationId: forgotPinByPhone
      description: Sends a One-Time Password (OTP) to the User's registered Phone number, enabling them to reset their PIN if forgotten.
      parameters:
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/IsVoiceOtp'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgotPinByPhone'
      responses:
        '200':
          description: Successfully submit request to reset the PIN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
  /identity/v2/auth/pin/reset/otp/{type}:
    put:
      summary: Reset PIN with OTP
      operationId: resetPinByOTP
      description: Allows a User to reset their PIN by verifying a One-Time Password (OTP). The User must provide the OTP, a new PIN, and one identifier (Phone, Email, or Username), enabling secure PIN recovery when the User forgets their PIN.
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/ReAuthType'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/GoogleRecaptchaResponse'
        - $ref: '#/components/parameters/GoogleRecaptchaResponseAlt'
        - $ref: '#/components/parameters/QQCaptchaTicket'
        - $ref: '#/components/parameters/QQCaptchaRandstr'
        - $ref: '#/components/parameters/HCaptchaResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPINByOTP'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_REQUIRED_PARAM'
                PIN_REQUIRED_PARAM:
                  $ref: '#/components/examples/PIN_REQUIRED_PARAM'
                USERNAME_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                PHONE_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_PAYLOAD_REQUIRED'
                RESOURCE_NOT_FOUND:
                  $ref: '#/components/examples/RESOURCE_NOT_FOUND'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                USER_NAME_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_NOT_ENABLED'
                USER_NAME_AUTHENTICATION_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                VERIFICATION_OTP_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_OTP_NOT_VALID'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                LINK_ALREADY_VERIFIED:
                  $ref: '#/components/examples/LINK_ALREADY_VERIFIED'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
  /identity/v2/auth/pin/reset/token:
    put:
      summary: Reset PIN with Reset Token
      operationId: resetPinByResetToken
      description: Allows a User to reset their PIN by providing a reset token received via Email and a new PIN, enabling secure PIN recovery when the User forgets their PIN.
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPINByToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                RESET_TOKEN_REQUIRED:
                  $ref: '#/components/examples/RESET_TOKEN_REQUIRED'
                PIN_REQUIRED_PARAM:
                  $ref: '#/components/examples/PIN_REQUIRED_PARAM'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                VERIFICATION_VTOKEN_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_VTOKEN_NOT_VALID'
                LINK_EXPIRED:
                  $ref: '#/components/examples/LINK_EXPIRED'
                PIN_LINK_ALREADY_VERIFIED:
                  $ref: '#/components/examples/PIN_LINK_ALREADY_VERIFIED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
  /identity/v2/auth/login/2fa/sms/phone:
    put:
      tags:
        - Security
      summary: Update Phone with MFA Token
      operationId: MFAUpdatePhoneNumberByMfaToken
      description: Sends a verification OTP to the provided Phone number as part of the process to update the Phone number used for Multi-Factor Authentication.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/SMSTemplate2FA'
        - $ref: '#/components/parameters/IsVoiceOtp'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MFAPhoneUpdateModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponseData'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                MFA_PHONE_REQUIRED:
                  $ref: '#/components/examples/MFA_PHONE_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_PHONE_ALREADY_USED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PHONE_ALREADY_USED'
                TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE_OLD'
                TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
                TWO_FACTOR_SECURITY_QUESTION_AUTHENTICATION_NOT_VERIFIED:
                  $ref: '#/components/examples/TWO_FACTOR_SECURITY_QUESTION_AUTHENTICATION_NOT_VERIFIED'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
  /identity/v2/auth/account/2fa/sms/phone:
    put:
      tags:
        - Security
      summary: Update Phone by token
      operationId: MFAUpdatePhoneNumberByToken
      description: Sends a verification OTP to the provided Phone number as part of the process to update the Phone number used for MFA.
      parameters:
        - $ref: '#/components/parameters/SMSTemplate2FA'
        - $ref: '#/components/parameters/IsVoiceOtp'
        - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MFAPhoneUpdateModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponseData'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                MFA_PHONE_REQUIRED:
                  $ref: '#/components/examples/MFA_PHONE_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_PHONE_ALREADY_USED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PHONE_ALREADY_USED'
                TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE_OLD'
                TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/login/2fa/sms:
    put:
      tags:
        - Security
      summary: Verify SMS OTP
      operationId: ValidateMfaOTPByPhone
      description: Allows Users to log in with Multi-Factor Authentication using the OTP sent via SMS or Voice OTP.
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/SMSTemplate2FA'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/IsVoiceOtp'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaOtpSMSTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MFAVerifyPhoneOtpModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
                INVALID_INVITATION_ID_ACCEPTED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_ACCEPTED'
                INVALID_INVITATION_ID_EXPIRED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_EXPIRED'
                INVALID_INVITATION_ID_REVOKED:
                  $ref: '#/components/examples/INVALID_INVITATION_ID_REVOKED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/login/2fa/totp:
    put:
      summary: Verify TOTP Code with MFA Token
      description: Validates the TOTP Authenticator code provided by the User as part of the Multi-Factor Authentication login process.
      operationId: VerifyTotpByMfaToken
      tags:
        - Security
      parameters:
        - $ref: '#/components/parameters/SecondFactorToken'
        - $ref: '#/components/parameters/Fields'
        - $ref: '#/components/parameters/RbaBrowserEmailTemplate'
        - $ref: '#/components/parameters/RbaCityEmailTemplate'
        - $ref: '#/components/parameters/RbaCountryEmailTemplate'
        - $ref: '#/components/parameters/RbaIPEmailTemplate'
        - $ref: '#/components/parameters/RbaDeviceEmailTemplate'
        - $ref: '#/components/parameters/RbaBrowserSMSTemplate'
        - $ref: '#/components/parameters/RbaCitySMSTemplate'
        - $ref: '#/components/parameters/RbaCountrySMSTemplate'
        - $ref: '#/components/parameters/RbaIPSMSTemplate'
        - $ref: '#/components/parameters/RbaDeviceSMSTemplate'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatorCodeRequest'
      responses:
        '200':
          description: Successful MFA login or MFA challenge required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                AUTH_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/AUTH_PARAMETER_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTH_TOKEN_REQUIRED'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT_OLD'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: Internal Server Error - an unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /identity/v2/auth/account/2fa/sms:
    delete:
      tags:
        - Security
      summary: Reset SMS Authenticator
      operationId: MFAResetSMSAuthByToken
      description: Resets SMS Authenticator configurations for an Account using an Access Token.
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED'
      security:
        - BearerToken: []
          APIKey: []
    put:
      tags:
        - Security
      summary: Verify Phone MFA
      operationId: MFAVerifyPhoneNumberByAccessToken
      description: Updates Phone-based MFA settings after a successful login, managing or verifying Phone MFA configurations for secure operations.
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/Fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MFAVerifyPhoneOtpModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OTP_REQUIRED:
                  $ref: '#/components/examples/OTP_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TWO_FACTOR_AUTHENTICATION_PHONE_ALREADY_USED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PHONE_ALREADY_USED'
                TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE_OLD'
                TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
                OTP_INVALID:
                  $ref: '#/components/examples/OTP_INVALID'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                SECURITY_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_ANSWER_INVALID'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/account/2fa/email:
    get:
      tags:
        - Security
      summary: Resend Email OTP
      operationId: ResendTwoFactorEmailOtp
      description: Sends the OTP to the Email if the Email OTP Authenticator is enabled in the Tenant's MFA configuration.
      parameters:
        - $ref: '#/components/parameters/EmailId'
        - $ref: '#/components/parameters/EmailTemplate2FA'
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: OTP resent successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_ID_REQUIRED:
                  $ref: '#/components/examples/EMAILID_REQUIRD'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
      security:
        - APIKey: []
    delete:
      tags:
        - Security
      summary: Reset Email OTP Authenticator
      description: Resets the Email OTP Authenticator settings for a User with MFA enabled, allowing reconfiguration.
      operationId: ResetMFAEmailAuthByAccessToken
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
      security:
        - BearerToken: []
          APIKey: []
    put:
      tags:
        - Security
      summary: Verify Email OTP
      operationId: EmailOTPAuthVerificationByAccessToken
      description: Verifies Email OTP authentication for a User using an Access Token.
      parameters:
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/Fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReAuthModelByEmailOtp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                OTP_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/OTP_PAYLOAD_REQUIRED'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                LOGIN_IS_LOCKED_FOR_MFA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_MFA'
                USER_ID_LOCKED_WITH_TIMEOUT:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT'
                USER_ID_LOCKED:
                  $ref: '#/components/examples/USER_ID_LOCKED'
                OTP_NOT_EXISTS:
                  $ref: '#/components/examples/OTP_NOT_EXISTS'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/consent:
    post:
      summary: Submit Consent with Token
      description: Submits User consent information using a consent token.
      operationId: SubmitConsentByConsentToken
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/ConsentToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentSubmit'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentResponse'
        '400':
          description: 'Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                CONSENT_TOKEN_REQUIRED:
                  $ref: '#/components/examples/CONSENT_TOKEN_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_FORM_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                CONSENT_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/CONSENT_TOKEN_NOT_VALID'
                CONSENT_TOKEN_EXPIRED:
                  $ref: '#/components/examples/CONSENT_TOKEN_EXPIRED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
    put:
      summary: Update Consent Profile
      description: Updates the consent profile using an Access Token.
      operationId: UpdateConsentByAccessToken
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentUpdate'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentProfile'
        '400':
          description: 'Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_FORM_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                CONSENT_FORM_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_AVAILABLE'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/consent/profile:
    post:
      summary: Submit Consent
      description: Submits User consent information using an Access Token.
      operationId: SubmitConsentByAccessToken
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentSubmit'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '400':
          description: 'Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                CONSENT_FORM_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                CONSENT_FORM_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_AVAILABLE'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/consent/logs:
    get:
      summary: Retrieve Consent Logs
      description: Retrieves consent logs for a User based on the provided Access Token.
      operationId: GetConsentLogs
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentLogsResponse'
        '400':
          description: 'Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_LOGS_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_LOGS_NOT_AVAILABLE'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                CONSENT_FORM_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_AVAILABLE'
                CONSENT_FORM_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_ENABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/consent/verify:
    get:
      summary: Retrieve Consent Status
      description: Retrieves the consent verification status for a User based on the provided Access Token and event.
      operationId: GetVerifiedConsentWithAccessToken
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/Event'
        - $ref: '#/components/parameters/IsCustom'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyConsent'
        '400':
          description: 'Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED'
                EVENT_REQUIRED:
                  $ref: '#/components/examples/EVENT_REQUIRED'
                IS_CUSTOM_REQUIRED:
                  $ref: '#/components/examples/ISCUSTOM_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_FORM_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED'
                CONSENT_FORM_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_AVAILABLE'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - BearerToken: []
          APIKey: []
  /identity/v2/auth/invitations/{invitation_token}:
    get:
      summary: Retrieve invitation details
      description: Retrieves details about a specific invitation using the invitation token.
      operationId: getInvitation
      tags:
        - User
      parameters:
        - $ref: '#/components/parameters/InvitationTokenPath'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationToken'
        '400':
          description: Bad Request - the request is malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/INVITATION_TOKEN_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '403':
          description: Forbidden - the client is not allowed to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
        '404':
          description: Not Found - the invitation token does not exist or is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
  /identity/v2/manage/account/emailtoken/{tokentype}:
    post:
      summary: Retrieve Multipurpose Email Token
      description: Retrieves a multi-purpose Email token for verification, Password reset, and other Email-related actions.
      operationId: MultipurposeEmailTokenAPI
      tags:
        - Multipurpose Tokens
      parameters:
        - $ref: '#/components/parameters/tokenType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/EmailVerificationOrForgotPINModel'
                - $ref: '#/components/schemas/AddEmailModelManage'
                - $ref: '#/components/schemas/ForgotPasswordOrPasswordLessLoginOrAutoLoginModel'
                - $ref: '#/components/schemas/DeleteUserModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                TOKEN_TYPE_REQUIRED:
                  $ref: '#/components/examples/TOKEN_TYPE_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                EMAILID_OR_USERNAME_REQUIRD:
                  $ref: '#/components/examples/EMAILID_OR_USERNAME_REQUIRD'
                EMAILID_REQUIRD:
                  $ref: '#/components/examples/EMAILID_REQUIRD'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                EMAIL_TYPE_CAN_NOT_NULL:
                  $ref: '#/components/examples/EMAIL_TYPE_CAN_NOT_NULL'
                EMAIL_TYPE_CAN_NOT_NULL-EMAIL_REQUIRED-UID_REQUIRED:
                  $ref: '#/components/examples/EMAIL_TYPE_CAN_NOT_NULL-EMAIL_REQUIRED-UID_REQUIRED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                EMAIL_OR_USER_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_OR_USER_REQUIRED_PARAM'
                EMAIL_OR_USER_REQUIRED_PARAM-CLIENT_GUID_REQUIRED:
                  $ref: '#/components/examples/EMAIL_OR_USER_REQUIRED_PARAM-CLIENT_GUID_REQUIRED'
                CLIENT_GUID_REQUIRED-EMAIL_REQUIRED:
                  $ref: '#/components/examples/CLIENT_GUID_REQUIRED-EMAIL_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                AUTOLOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/AUTOLOGIN_NOT_ENABLED'
                CANNOT_ADD_EMAIL_ADDRESS:
                  $ref: '#/components/examples/CANNOT_ADD_EMAIL_ADDRESS'
                CLIENT_GUID_MUST_BE_UNIQUE:
                  $ref: '#/components/examples/CLIENT_GUID_MUST_BE_UNIQUE'
                EMAIL_ALLREADY_VERIFIED_TOKEN:
                  $ref: '#/components/examples/EMAIL_ALLREADY_VERIFIED_TOKEN'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                EMAIL_ID_NOT_EXIST_IN_PROFILE:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXIST_IN_PROFILE'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                EMAILID_VERIFICATION_DISABLE:
                  $ref: '#/components/examples/EMAILID_VERIFICATION_DISABLE'
                INVALID_TOKEN_TYPE:
                  $ref: '#/components/examples/INVALID_TOKEN_TYPE'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                NO_REGISTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/NO_REGISTRATION_NOT_ENABLED'
                ONE_CLICK_SIGIN_NOT_ENABLED:
                  $ref: '#/components/examples/ONE_CLICK_SIGIN_NOT_ENABLED'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                TOKEN_LIMIT_REACHED:
                  $ref: '#/components/examples/TOKEN_LIMIT_REACHED'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                USER_NAME_AUTHENTICATION_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/smsotp/{smsotptype}:
    post:
      summary: Multipurpose SMS OTP
      description: Generates an OTP for the User, applicable for adding a Phone, Phone ID verification, and other SMS-related actions.
      operationId: MultipurposeSmsOtpAPI
      tags:
        - Multipurpose Tokens
      parameters:
        - $ref: '#/components/parameters/smsOtpType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/AddPhoneModel'
                - $ref: '#/components/schemas/PhoneIdModel'
                - $ref: '#/components/schemas/OneTouchLoginPhoneModel'
                - $ref: '#/components/schemas/DeleteUserModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
                TOKEN_TYPE_REQUIRED:
                  $ref: '#/components/examples/SMS_OTP_TYPE_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                PHONE_REQUIRED_PARAM-UID_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED_PARAM-UID_REQUIRED'
                PHONE_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_REQUIRED_PARAM'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED'
                OTP_LIMIT_REACHED:
                  $ref: '#/components/examples/OTP_LIMIT_REACHED'
                PHONE_NUMBER_NOT_EXISTS:
                  $ref: '#/components/examples/PHONE_NUMBER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PHONE_NUMBER_ALREADY_VERIFIED:
                  $ref: '#/components/examples/PHONE_NUMBER_ALREADY_VERIFIED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
                NO_REGISTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/NO_REGISTRATION_NOT_ENABLED'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                USER_NAME_AUTHENTICATION_ENABLED:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED'
                AUTOLOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/AUTOLOGIN_NOT_ENABLED'
                PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/PHONE_NOT_VERIFIED'
                PHONE_DOES_NOT_EXIST:
                  $ref: '#/components/examples/PHONE_DOES_NOT_EXIST'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/rolecontext:
    get:
      summary: Retrieve Context by UID
      description: |
        Retrieves User Roles for all Contexts using the UID.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: GetRoleContextByUid
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/UidPathParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleContextResponseModal'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                B2B_FEATURE_ENABLED:
                  $ref: '#/components/examples/B2B_FEATURE_ENABLED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    put:
      summary: Upsert Context by UID
      description: |
        Creates or updates a Context with a set of Roles using the UID.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: UpsertRoleContextByUid
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/UidPathParam'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/XPreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleContextBodyModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleContextResponseModal'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                PUT_BODY_INVALID:
                  $ref: '#/components/examples/PUT_BODY_INVALID'
                PARAMETER_NOT_WELL_FORMATTED_CONTEXT:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_CONTEXT'
                PARAMETER_NOT_WELL_FORMATTED_ROLE:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_ROLE'
                PARAMETER_NOT_WELL_FORMATTED_ROLE_NULL:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_ROLE_NULL'
                INVALID_DATE_ROLES:
                  $ref: '#/components/examples/INVALID_DATE_ROLES'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                B2B_FEATURE_ENABLED:
                  $ref: '#/components/examples/B2B_FEATURE_ENABLED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/roleContext/{contextName}:
    get:
      summary: Retrieve Role Context
      description: |
        Retrieves the Role Context for a specified Role.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: GetRoleContextByContextName
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/ContextName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleContextProfileResponseModel'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTEXT_NAME_REQUIRED:
                  $ref: '#/components/examples/CONTEXT_NAME_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_CONTEXT_NOT_VALID:
                  $ref: '#/components/examples/ROLE_CONTEXT_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                B2B_FEATURE_ENABLED:
                  $ref: '#/components/examples/B2B_FEATURE_ENABLED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/role:
    get:
      summary: Retrieve Roles by UID
      description: |
        Retrieves Roles associated with a specified UID.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: GetRolesByUid
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/UidPathParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRolesModel'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    put:
      summary: Assign Roles by UID
      description: |
        Updates and assigns Roles to a User using the UID.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: SaveRolesByUid
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/UidPathParam'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRolesModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRolesModel'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                PUT_BODY_INVALID:
                  $ref: '#/components/examples/PUT_BODY_INVALID'
                ROLES_CAN_NOT_BE_EMPTY:
                  $ref: '#/components/examples/ROLES_CAN_NOT_BE_EMPTY'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    delete:
      summary: Unassign Roles by UID
      description: |
        Removes specified Roles from a User using the UID.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: DeleteRolesByUid
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/UidPathParam'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRolesModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/rolecontext/{contextName}/role:
    delete:
      summary: Delete Role from Context
      description: |
        Deletes the specified Role from a Context.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: DeleteContextRoleByUid
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/UidPathParam'
        - $ref: '#/components/parameters/ContextName'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveRoleContextRoleModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
                PARAMETER_NOT_WELL_FORMATTED_ROLE:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_ROLE'
                PARAMETER_NOT_WELL_FORMATTED_ROLE_NULL:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_ROLE_NULL'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS'
                ROLE_CONTEXT_NOT_VALID:
                  $ref: '#/components/examples/ROLE_CONTEXT_NOT_VALID'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                B2B_FEATURE_ENABLED:
                  $ref: '#/components/examples/B2B_FEATURE_ENABLED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/rolecontext/{contextName}/additionalpermission:
    delete:
      summary: Delete Additional Permissions from Context
      description: |
        Removes specified additional Permissions from a Context.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: DeleteRoleContextAdditionalPermissionsByUid
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/UidPathParam'
        - $ref: '#/components/parameters/ContextName'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveRoleContextAdditionalPermissionsModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
                PARAMETER_NOT_WELL_FORMATTED_ADDPERMISSION_NULL:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_ADDPERMISSION_NULL'
                PARAMETER_NOT_WELL_FORMATTED_ADDPERMISSION:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_ADDPERMISSION'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                CONTENT_TYPE_INVALID:
                  $ref: '#/components/examples/CONTENT_TYPE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS'
                ROLE_CONTEXT_NOT_VALID:
                  $ref: '#/components/examples/ROLE_CONTEXT_NOT_VALID'
                ADDITIONALPERMISSIONS_NOT_EXITS:
                  $ref: '#/components/examples/ADDITIONALPERMISSIONS_NOT_EXITS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                B2B_FEATURE_ENABLED:
                  $ref: '#/components/examples/B2B_FEATURE_ENABLED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/rolecontext/{contextName}:
    delete:
      summary: Delete Role Context
      description: |
        Deletes the specified Role Context.

        This API is supported only for B2C tenants. For improved role and permission management, we recommend migrating to a B2B tenant. Please contact support for assistance with the migration.
      operationId: DeleteRoleContextByUid
      tags:
        - Roles Management
      parameters:
        - $ref: '#/components/parameters/ContextName'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/UidPathParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_CONTEXT_NOT_VALID:
                  $ref: '#/components/examples/ROLE_CONTEXT_NOT_VALID'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                B2B_FEATURE_ENABLED:
                  $ref: '#/components/examples/B2B_FEATURE_ENABLED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/passkey:
    get:
      summary: List Passkeys
      description: Retrieves a list of Passkeys configured for a specified User.
      operationId: ListPasskeyUser
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasskeyListResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                PASSKEY_NOT_CONFIGURED_IN_PROFILE:
                  $ref: '#/components/examples/PASSKEY_NOT_CONFIGURED_IN_PROFILE'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/passkey/{passkeyId}:
    delete:
      summary: Delete Passkey
      description: Removes configured Passkey for specified User.
      operationId: DeletePasskeyByUid
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
        - $ref: '#/components/parameters/passkeyId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                PASSKEY_NOT_ENABLED_IN_APP:
                  $ref: '#/components/examples/PASSKEY_NOT_ENABLED_IN_APP'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                PASSKEY_NOT_CONFIGURED_IN_PROFILE:
                  $ref: '#/components/examples/PASSKEY_NOT_CONFIGURED_IN_PROFILE'
                INVALID_PASSKEY_ID:
                  $ref: '#/components/examples/INVALID_PASSKEY_ID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/2fa/passkey:
    delete:
      summary: Reset MFA Passkey
      description: Resets the MFA Passkey for the specified User.
      operationId: ResetMfaPasskeyByUid
      tags:
        - Account Security
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/2fa/push:
    delete:
      summary: Reset MFA Push Notification
      description: Resets the Push Notification Authenticator for the specified User.
      operationId: ResetMfaPushByUid
      tags:
        - Account Security
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but is refusing to fulfill it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_PUSH_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_PUSH_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/2fa/duo:
    delete:
      summary: Reset Duo
      description: Resets the Duo Authenticator for the specified User.
      operationId: ResetDuoAuthByUid
      tags:
        - Account Security
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but is refusing to fulfill it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                DUO_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/DUO_AUTH_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_DUO_AUTHENTICATOR_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_DUO_AUTHENTICATOR_NOT_CONFIGURED_ON_PROFILE'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/2fa/email:
    delete:
      summary: Reset Email OTP
      description: Resets the Email OTP Authenticator for the specified User.
      operationId: ResetEmailAuthenticatorByUid
      tags:
        - Account Security
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but is refusing to fulfill it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/2fa/backupcode:
    get:
      summary: Generate Backup Codes
      description: Generates a set of backup codes for the specified User.
      operationId: mfaGenerateBackupCodesByUid
      tags:
        - Account Security
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MFABackUpCodeResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
                TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_ALREADY_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_ALREADY_CONFIGURED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/2fa/backupcode/reset:
    get:
      summary: Reset Backup Codes
      description: Resets and generates a new set of backup codes for the specified User.
      operationId: mfaResetBackupCodesByUid
      tags:
        - Account Security
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MFABackUpCodeResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/access_token/refresh:
    get:
      summary: Refresh Access Token
      description: Refreshes the Access Token using a Refresh Token.
      operationId: refreshAccessToken
      tags:
        - Account Session
      parameters:
        - $ref: '#/components/parameters/RefreshToken'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REFRESH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/REFRESH_TOKEN_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REFRESH_TOKEN_INVALID:
                  $ref: '#/components/examples/REFRESH_TOKEN_INVALID'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/access_token/refresh/revoke:
    get:
      summary: Revoke Refresh Token
      description: Revokes the specified Refresh Token.
      operationId: revokeRefreshToken
      tags:
        - Account Session
      parameters:
        - $ref: '#/components/parameters/RefreshToken'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REFRESH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/REFRESH_TOKEN_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REFRESH_TOKEN_INVALID:
                  $ref: '#/components/examples/REFRESH_TOKEN_INVALID'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/access_token/refresh/revoke:
    delete:
      summary: Revoke refresh tokens
      description: Revokes all active refresh tokens for a specified User.
      operationId: revokeAllRefreshToken
      tags:
        - Account Session
      parameters:
        - $ref: '#/components/parameters/UidPath'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/customobject:
    get:
      summary: List Custom Objects
      tags:
        - Account Custom Object
      description: Retrieves all Custom Objects associated with the UID.
      operationId: GetCustomObjectByUid
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/CustomObjectId'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectsResponseModel'
              examples:
                default:
                  $ref: '#/components/examples/CUSTOM_OBJECTS_RESPONSE_EXAMPLE'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
                CUSTOM_OBJECT_RECORD_NOT_EXIST:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RECORD_NOT_EXIST'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    post:
      summary: Create Custom Object
      tags:
        - Account Custom Object
      description: Creates a new Custom Object for the User.
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/CustomObjectId'
      operationId: CreateCustomObject
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectRequest'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponseModel'
              examples:
                default:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RESPONSE_EXAMPLE'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_OIDC'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/customobject/{objectrecordid}:
    get:
      summary: Retrieve Custom Object
      description: Retrieves the Custom Object associated with the specified User using the UID and record ID.
      operationId: getCustomObjectByUidndRecordId
      tags:
        - Account Custom Object
      parameters:
        - $ref: '#/components/parameters/ObjectRecordId'
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/CustomObjectId'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponseModel'
              examples:
                default:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RESPONSE_EXAMPLE'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    put:
      summary: Update Custom Object
      description: Updates a Custom Object associated with the authenticated User using the UID and record ID.
      operationId: updateCustomObjectByUidAndRecordId
      tags:
        - Account Custom Object
      parameters:
        - $ref: '#/components/parameters/ObjectRecordId'
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/UpdateType'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/CustomObjectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectRequest'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponseModel'
              examples:
                default:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RESPONSE_EXAMPLE'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                CUSTOM_OBJECT_JSON_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_JSON_NOT_VALID'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_OIDC'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    delete:
      summary: Delete Custom Object
      description: Deletes the Custom Object associated with the specified User using the UID and record ID.
      operationId: deleteCustomObjectByUidAndRecordId
      tags:
        - Account Custom Object
      parameters:
        - $ref: '#/components/parameters/ObjectRecordId'
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/ObjectName'
        - $ref: '#/components/parameters/CustomObjectId'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                CUSTOM_OBJECT_NAME_REQUIRED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_REQUIRED'
                CUSTOM_OBJECT_RECORD_ID_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_RECORD_ID_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                CUSTOM_OBJECT_NAME_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NAME_NOT_VALID'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                CUSTOM_OBJECT_NOT_CONFIGURED:
                  $ref: '#/components/examples/CUSTOM_OBJECT_NOT_CONFIGURED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_OIDC'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account:
    delete:
      summary: Delete Account by Email
      description: Deletes an Account based on the specified Email.
      operationId: DeleteAccountByEmail
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      responses:
        '200':
          description: Account successfully deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeletedResponseWithCount'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                INVALID_EMAIL:
                  $ref: '#/components/examples/INVALID_EMAIL'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    get:
      summary: Retrieve Account
      description: Retrieves Account Identity details using Email, Username, Phone, or Query parameter.
      operationId: GetAccountIdentity
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/Username'
        - $ref: '#/components/parameters/Phone'
        - $ref: '#/components/parameters/QParam'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      responses:
        '200':
          description: Account Identity retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Q_REQUIRED:
                  $ref: '#/components/examples/Q_REQUIRED'
                Q_NOT_VALID:
                  $ref: '#/components/examples/Q_NOT_VALID'
                QUERY_KEY_REQUIRED:
                  $ref: '#/components/examples/QUERY_KEY_REQUIRED'
                QUERY_VALUE_REQUIRED:
                  $ref: '#/components/examples/QUERY_VALUE_REQUIRED'
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                USERNAME_REQUIRED:
                  $ref: '#/components/examples/USERNAME_REQUIRED'
                PHONE_REQUIRED:
                  $ref: '#/components/examples/PHONE_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                MULTIPLE_QUERY_PARAMETERS:
                  $ref: '#/components/examples/MULTIPLE_QUERY_PARAMETERS'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                QUERY_KEY_INDEX_NOT_FOUND:
                  $ref: '#/components/examples/QUERY_KEY_INDEX_NOT_FOUND'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                USERNAME_NOT_EXISTS:
                  $ref: '#/components/examples/USERNAME_NOT_EXISTS'
                PHONE_NUMBER_NOT_EXISTS:
                  $ref: '#/components/examples/PHONE_NUMBER_NOT_EXISTS'
                PHONE_NUMBER_LOGIN_ENABLED:
                  $ref: '#/components/examples/PHONE_NUMBER_LOGIN_ENABLED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    post:
      summary: Create Account
      description: Creates a new Account with the provided details.
      operationId: CreateUser
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManageRegisterModel'
      responses:
        '200':
          description: User account successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                PHONE_OR_EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_OR_EMAIL_REQUIRED_PARAM'
                EMAIL_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_REQUIRED_PARAM'
                PHONE_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_REQUIRED_PARAM'
                USERNAME_REQUIRED_PARAM:
                  $ref: '#/components/examples/USERNAME_REQUIRED_PARAM'
                EMAIL_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_VALUE_REQUIRED_PARAM'
                EMAIL_TYPE_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_TYPE_VALUE_REQUIRED_PARAM'
                EMAIL_TYPE_REQUIRED:
                  $ref: '#/components/examples/EMAIL_TYPE_REQUIRED'
                EMAIL_ID_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/EMAIL_ID_CAN_NOT_BE_SAME'
                PRIMARY_EMAIL_CAN_BE_ONLY_ONE:
                  $ref: '#/components/examples/PRIMARY_EMAIL_CAN_BE_ONLY_ONE'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                ADDRESS_TYPE_REQUIRED:
                  $ref: '#/components/examples/ADDRESS_TYPE_REQUIRED'
                ADDRESS_TYPE_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/ADDRESS_TYPE_CAN_NOT_BE_SAME'
                BIRTH_DATE_INVALID:
                  $ref: '#/components/examples/BIRTH_DATE_INVALID'
                GENDER_INVALID:
                  $ref: '#/components/examples/GENDER_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACTIVE_LOGIN_SESSIONS_NOT_ENABLED:
                  $ref: '#/components/examples/ACTIVE_LOGIN_SESSIONS_NOT_ENABLED'
                PRIVACY_POLICY_NOT_ACCEPTED:
                  $ref: '#/components/examples/PRIVACY_POLICY_NOT_ACCEPTED'
                SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                CUSTOM_FIELD_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_VALID'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                AGE_UNDERAGE:
                  $ref: '#/components/examples/AGE_UNDERAGE'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                UID_IS_NOT_VALID:
                  $ref: '#/components/examples/UID_IS_NOT_VALID'
                ACCOUNT_ID_IS_ALREADY_REGISTERED:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_ALREADY_REGISTERED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                PRIVACY_POLICY_NOT_VALID:
                  $ref: '#/components/examples/PRIVACY_POLICY_NOT_VALID'
                PIN_REQUIRED:
                  $ref: '#/components/examples/PIN_REQUIRED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}:
    get:
      summary: Retrieve Account by UID
      description: Retrieves Account Identity details using the UID.
      operationId: GetAccountIdentityByUID
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      responses:
        '200':
          description: Account Identity retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    delete:
      summary: Delete Account by UID
      description: Deletes an Account based on the specified UID.
      operationId: DeleteAccountByUID
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      responses:
        '200':
          description: Account successfully deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeletedResponseWithCount'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    put:
      summary: Update Account by UID
      description: Updates Account details using the UID.
      operationId: UpdateAccountProfileByUID
      tags:
        - Accounts
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/NullSupport'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManageRegisterModel'
      responses:
        '200':
          description: Account profile updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                EMAIL_ID_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/EMAIL_ID_CAN_NOT_BE_SAME'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                PRIMARY_EMAIL_CAN_BE_ONLY_ONE:
                  $ref: '#/components/examples/PRIMARY_EMAIL_CAN_BE_ONLY_ONE'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER'
                GENDER_INVALID:
                  $ref: '#/components/examples/GENDER_INVALID'
                BIRTH_DATE_INVALID:
                  $ref: '#/components/examples/BIRTH_DATE_INVALID'
                ADDRESS_TYPE_REQUIRED:
                  $ref: '#/components/examples/ADDRESS_TYPE_REQUIRED'
                ADDRESS_TYPE_CAN_NOT_BE_SAME:
                  $ref: '#/components/examples/ADDRESS_TYPE_CAN_NOT_BE_SAME'
                EMAIL_TYPE_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_TYPE_VALUE_REQUIRED_PARAM'
                EMAIL_VALUE_REQUIRED_PARAM:
                  $ref: '#/components/examples/EMAIL_VALUE_REQUIRED_PARAM'
                EMAIL_TYPE_REQUIRED:
                  $ref: '#/components/examples/EMAIL_TYPE_REQUIRED'
                USERNAME_REQUIRED:
                  $ref: '#/components/examples/USERNAME_REQUIRED'
                PIN_REQUIRED:
                  $ref: '#/components/examples/PIN_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                UID_IS_NOT_VALID:
                  $ref: '#/components/examples/UID_IS_NOT_VALID'
                ACCOUNT_ID_IS_ALREADY_REGISTERED:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_ALREADY_REGISTERED'
                CUSTOM_FIELD_NOT_VALID:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED'
                SECURITY_QUESTION_NOT_VALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_VALID'
                SECURITY_QUESTION_OR_ANSWER_INVALID:
                  $ref: '#/components/examples/SECURITY_QUESTION_OR_ANSWER_INVALID'
                PRIVACY_POLICY_NOT_ACCEPTED:
                  $ref: '#/components/examples/PRIVACY_POLICY_NOT_ACCEPTED'
                ACTIVE_LOGIN_SESSIONS_NOT_ENABLED:
                  $ref: '#/components/examples/ACTIVE_LOGIN_SESSIONS_NOT_ENABLED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
  /identity/v2/manage/account/access_token:
    get:
      summary: Retrieve Impersonation Token
      description: Retrieves an Impersonation Token for an Account using the UID.
      operationId: GetImpersonationToken
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      responses:
        '200':
          description: Impersonation token retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessToken'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/forgot/token:
    post:
      summary: Retrieve Forgot Password Token
      description: Generates a Forgot Password Token for the User and optionally sends an Email with the token.
      operationId: ForgotPasswordTokenAndEmail
      tags:
        - Multipurpose Tokens
      parameters:
        - $ref: '#/components/parameters/SendEmail'
        - $ref: '#/components/parameters/ResetPasswordUrl'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/UsernameModel'
                - $ref: '#/components/schemas/EmailToValidateServerSide'
      responses:
        '200':
          description: Forgot Password token generated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForgotPasswordTokenModel'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                USERNAME_REQUIRED_CORE:
                  $ref: '#/components/examples/USERNAME_REQUIRED_CORE'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                INVALID_REQUEST_BODY:
                  $ref: '#/components/examples/INVALID_REQUEST_BODY'
                EMAILID_OR_USERNAME_REQUIRD:
                  $ref: '#/components/examples/EMAILID_OR_USERNAME_REQUIRD'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                SEND_EMAIL_INVALID_PARAMETER:
                  $ref: '#/components/examples/SEND_EMAIL_INVALID_PARAMETER'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                RESET_PASSWORD_URL_INVALID:
                  $ref: '#/components/examples/RESET_PASSWORD_URL_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/vtoken:
    get:
      summary: Retrieve Email Verification Token
      description: Retrieves an Email Verification Token for a specified Email.
      operationId: GetVerificationToken
      tags:
        - Multipurpose Tokens
      parameters:
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/VType'
        - $ref: '#/components/parameters/ExpireIn'
      responses:
        '200':
          description: Verification token retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationLinkResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                VERIFICATION_TYPE_REQUIRED:
                  $ref: '#/components/examples/VERIFICATION_TYPE_REQUIRED'
                VTYPE_INVALID:
                  $ref: '#/components/examples/VTYPE_INVALID'
                EXPIRE_IN_INVALID_FORMAT:
                  $ref: '#/components/examples/EXPIRE_IN_INVALID_FORMAT'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAILID_VERIFICATION_DISABLE:
                  $ref: '#/components/examples/EMAILID_VERIFICATION_DISABLE'
                USER_NOT_EXISTS:
                  $ref: '#/components/examples/USER_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                EMAIL_ALLREADY_VERIFIED_TOKEN:
                  $ref: '#/components/examples/EMAIL_ALLREADY_VERIFIED_TOKEN'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/identities:
    get:
      summary: Retrieve Account by Email
      description: Retrieves Account associated with a specified Email.
      operationId: GetIdentities
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/Email'
        - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: User Identities retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentitiesResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_REQUIRED:
                  $ref: '#/components/examples/EMAIL_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                PHONE_NUMBER_LOGIN_ENABLED:
                  $ref: '#/components/examples/PHONE_NUMBER_LOGIN_ENABLED'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/email:
    delete:
      summary: Delete Email
      description: Removes an Email from an Account.
      operationId: DeleteEmailFromAccount
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailModelManage'
      responses:
        '200':
          description: Email successfully deleted from the Account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Identity'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
                PARAMETER_NOT_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_FORMATTED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                ONE_EMAILID_IS_REQUIRED:
                  $ref: '#/components/examples/ONE_EMAILID_IS_REQUIRED'
                EMAIL_ID_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_ID_NOT_EXISTS'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    put:
      summary: Upsert Email
      description: Adds or updates an Email associated with an Account using the UID.
      operationId: UpsertEmailForAccount
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertEmailModel'
      responses:
        '200':
          description: Email successfully upserted for the Account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                EMAIL_CAN_NOT_NULL:
                  $ref: '#/components/examples/EMAIL_CAN_NOT_NULL'
                EMAIL_TYPE_AND_VALUE_CAN_NOT_NULL:
                  $ref: '#/components/examples/EMAIL_TYPE_AND_VALUE_CAN_NOT_NULL'
                EMAIL_VALUE_CAN_NOT_NULL:
                  $ref: '#/components/examples/EMAIL_VALUE_CAN_NOT_NULL'
                EMAIL_TYPE_CAN_NOT_NULL:
                  $ref: '#/components/examples/EMAIL_TYPE_CAN_NOT_NULL'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                CANNOT_ADD_EMAIL_ADDRESS:
                  $ref: '#/components/examples/CANNOT_ADD_EMAIL_ADDRESS'
                EMAILID_ALREADY_REGISTERED:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/phoneid:
    put:
      summary: Update Phone
      description: Updates the PhoneID associated with an Account using the UID.
      operationId: UpdatePhoneNumber
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneModel'
      responses:
        '200':
          description: Phone number successfully updated for the Account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PHONE_NOT_BLANK:
                  $ref: '#/components/examples/PHONE_NOT_BLANK'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/invalidateemail:
    put:
      summary: Invalidate Email Verification
      description: Invalidates the Email Verification status for an Account using the UID.
      operationId: InvalidateEmailVerification
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/EmailTemplate'
        - $ref: '#/components/parameters/VerificationUrl'
      responses:
        '200':
          description: Email Verification status invalidated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                CAN_NOT_ENFORCE_EMAIL_INVALIDATION:
                  $ref: '#/components/examples/CAN_NOT_ENFORCE_EMAIL_INVALIDATION'
                EMAIL_ALREADY_UNVERIFIED:
                  $ref: '#/components/examples/EMAIL_ALREADY_UNVERIFIED'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                VERIFICATION_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/VERIFICATION_URL_IS_NOT_VALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/invalidatephone:
    put:
      summary: Invalidate Phone verification
      description: Resets the Phone verification status for an Account using the UID.
      operationId: ResetPhoneVerification
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
        - $ref: '#/components/parameters/XPreventWebhook'
        - $ref: '#/components/parameters/PreventWebhook'
        - $ref: '#/components/parameters/SmsTemplate'
        - $ref: '#/components/parameters/IsVoiceOtp'
      responses:
        '200':
          description: Phone verification status reset successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                CAN_NOT_ENFORCE_PHONE_INVALIDATION:
                  $ref: '#/components/examples/CAN_NOT_ENFORCE_PHONE_INVALIDATION'
                PHONE_NUMBER_ALREADY_UNVERIFIED:
                  $ref: '#/components/examples/PHONE_NUMBER_ALREADY_UNVERIFIED'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS'
                VOICE_SMS_CONFIGURATION_NOT_ENABLED:
                  $ref: '#/components/examples/VOICE_SMS_CONFIGURATION_NOT_ENABLED'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/privacypolicy/history:
    get:
      summary: Retrieve Privacy Policy History
      description: Retrieves the Privacy Policy acceptance history for an Account by UID.
      operationId: GetPrivacyPolicyHistoryByUid
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
      responses:
        '200':
          description: Privacy Policy History retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivacyPolicyHistoryResponse'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/password:
    get:
      summary: Retrieve Password
      description: Retrieves the Password details for an Account using the UID.
      operationId: GetProfilePassword
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
      responses:
        '200':
          description: Password details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordResponse'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
    put:
      summary: Update Password
      description: Sets or updates the Password for an Account using the UID.
      operationId: SetProfilePassword
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordModel'
      responses:
        '200':
          description: Password successfully set for the Account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordResponse'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                SERVER_SIDE_VALIDATION_ERROR:
                  $ref: '#/components/examples/SERVER_SIDE_VALIDATION_ERROR'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WEAK_PASSWORD:
                  $ref: '#/components/examples/WEAK_PASSWORD'
                PASSWORD_IN_HISTORY:
                  $ref: '#/components/examples/PASSWORD_IN_HISTORY'
                BREACHED_PASSWORD:
                  $ref: '#/components/examples/BREACHED_PASSWORD'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/reauth/pin:
    post:
      summary: Verify PIN MFA Token
      description: Validates and verifies the 'SecondFactorValidationToken' generated by the Step-Up Authenticate By PIN API.
      operationId: ValidateSecondFactorTokenForPin
      tags:
        - Account Security
      parameters:
        - $ref: '#/components/parameters/UidPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventBasedSecondFactorToken'
      responses:
        '200':
          description: Second factor token successfully validated for step-up by PIN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsValid'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                SECOND_FACTOR_VALIDATION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_VALIDATION_TOKEN_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                SECOND_FACTOR_VERIFICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/SECOND_FACTOR_VERIFICATION_TOKEN_NOT_VALID'
                PIN_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/PIN_AUTH_NOT_ENABLED'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/reauth/password:
    post:
      summary: Verify Password MFA Token
      description: Validates and verifies the 'SecondFactorValidationToken' generated by the Step-Up Authenticate By Password API.
      operationId: ValidateSecondFactorTokenForPassword
      tags:
        - Account Security
      parameters:
        - $ref: '#/components/parameters/UidPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventBasedSecondFactorToken'
      responses:
        '200':
          description: Second factor token successfully validated for step-up by Password
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsValid'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID'
                SECOND_FACTOR_VALIDATION_TOKEN_REQUIRED:
                  $ref: '#/components/examples/SECOND_FACTOR_VALIDATION_TOKEN_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: Forbidden - The client is not authorized to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID'
                ACCESS_TOKEN_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT'
                TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED'
                SECOND_FACTOR_VERIFICATION_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/SECOND_FACTOR_VERIFICATION_TOKEN_NOT_VALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/{uid}/consent/logs:
    get:
      summary: Retrieve Consent Logs
      description: Retrieves Consent Management logs for the specified User.
      operationId: GetConsentLogsByUid
      tags:
        - Accounts
      parameters:
        - $ref: '#/components/parameters/UidPath'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentLogsResponse'
        '400':
          description: 'Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
        '401':
          description: 'Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_LOGS_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_LOGS_NOT_AVAILABLE'
                CONSENT_FORM_NOT_AVAILABLE:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_AVAILABLE'
                CONSENT_FORM_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_ENABLED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                REQUEST_EXPIRY_TIME_IS_INVALID:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_IS_INVALID'
                IP_ACCESS_DENIED:
                  $ref: '#/components/examples/IP_ACCESS_DENIED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/2fa/totp:
    delete:
      tags:
        - Account Security
      summary: Reset TOTP
      description: Resets MFA settings for the specified User.
      operationId: MFAResetTotpByUid
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /identity/v2/manage/account/2fa/sms:
    delete:
      tags:
        - Account Security
      summary: Reset SMS Authenticator
      description: Resets MFA settings for the specified User.
      operationId: MFAResetSMSAuthByUid
      parameters:
        - $ref: '#/components/parameters/UidQueryParam'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED'
                API_SECRET_OR_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_OR_SIGNATURE_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED'
                API_SIGNATURE_REQUIRED:
                  $ref: '#/components/examples/API_SIGNATURE_REQUIRED'
                API_SIGNATURE_INVALID:
                  $ref: '#/components/examples/API_SIGNATURE_INVALID'
                REQUEST_EXPIRY_TIME_INVALID_FORMAT:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_INVALID_FORMAT'
                REQUEST_EXPIRY_TIME_REQUIRED:
                  $ref: '#/components/examples/REQUEST_EXPIRY_TIME_REQUIRED'
                UID_REQUIRED:
                  $ref: '#/components/examples/UID_REQUIRED'
                DELETE_BODY_INVALID:
                  $ref: '#/components/examples/DELETE_BODY_INVALID'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID'
                SECRET_DOESNT_HAVE_ACCESS:
                  $ref: '#/components/examples/SECRET_DOESNT_HAVE_ACCESS'
                TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_ENABLED'
                RAAS_PROFILE_NOT_EXISTS:
                  $ref: '#/components/examples/RAAS_PROFILE_NOT_EXISTS'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD'
                TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED'
                TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE'
                TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
                  $ref: '#/components/examples/TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
        - Digest: []
          XRequestExpiresTime: []
  /api/v2/access_token/refresh:
    get:
      summary: Refresh Access Token
      description: Refreshes the Access Token using a valid refresh token to extend session validity.
      operationId: RefreshAccessToken
      tags:
        - Account Session
      security:
        - XLoginRadiusAPISecret: []
        - ApiSecret: []
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/IsWeb'
        - $ref: '#/components/parameters/ExpiresIn'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                GENERIC_REQUIRED:
                  $ref: '#/components/examples/GENERIC_REQUIRED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND_NATIVE'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID_NATIVE'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID_NATIVE'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED_NATIVE'
                REFRESH_TOKEN_INVALID:
                  $ref: '#/components/examples/REFRESH_TOKEN_INVALID_NATIVE'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT_NATIVE'
                ENDPOINT_NOT_SUPPORTED_BY_CURRENT_PROVIDER:
                  $ref: '#/components/examples/ENDPOINT_NOT_SUPPORTED_BY_CURRENT_PROVIDER'
                PROVIDER_SIDE_ERROR:
                  $ref: '#/components/examples/PROVIDER_SIDE_ERROR_NATIVE'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST_NATIVE'
  /api/v2/access_token:
    get:
      summary: Retrieve Access Token
      description: Translates the Request Token obtained during authentication into an Access Token for use with other API calls.
      operationId: GetAccessToken
      tags:
        - Account Session
      security:
        - XLoginRadiusAPISecret: []
        - ApiSecret: []
      parameters:
        - $ref: '#/components/parameters/Token'
      responses:
        '200':
          description: 'Status Ok: The request was successful'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: 'Status Bad Request: The request was invalid or cannot be otherwise served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND_NATIVE'
        '401':
          description: 'Status Unauthorized: The request requires User authentication or the provided credentials are invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID_NATIVE'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                REQUEST_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/REQUEST_TOKEN_NOT_VALID_NATIVE'
                REQUEST_TOKEN_EXPIRED:
                  $ref: '#/components/examples/REQUEST_TOKEN_EXPIRED'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID_NATIVE'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED_NATIVE'
  /api/v2/access_token/validate:
    get:
      summary: Validate Access Token
      description: Validates the provided Access Token to ensure its authenticity and validity.
      operationId: ValidateAccessToken
      tags:
        - Account Session
      security:
        - XLoginRadiusAPISecret: []
          XLoginRadiusAPIKey: []
        - ApiSecret: []
          APIKey: []
      parameters:
        - $ref: '#/components/parameters/AccessTokenRequired'
      responses:
        '200':
          description: 'Status Ok: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: 'Status Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED_NATIVE'
                GENERIC_REQUIRED:
                  $ref: '#/components/examples/GENERIC_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED_NATIVE'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED_NATIVE'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED_NATIVE'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND_NATIVE'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID_NATIVE'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_NATIVE'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID_NATIVE'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED_NATIVE'
  /api/v2/access_token/invalidate:
    get:
      summary: Invalidate Access Token
      description: Invalidates the specified Access Token, terminating its validity.
      operationId: NativeInvalidateAccessToken
      tags:
        - Account Session
      parameters:
        - $ref: '#/components/parameters/AccessToken'
        - $ref: '#/components/parameters/PreventRefresh'
      security:
        - XLoginRadiusAPISecret: []
          XLoginRadiusAPIKey: []
        - ApiSecret: []
          APIKey: []
      responses:
        '200':
          description: 'Status Ok: The request was successful'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsPostedResponse'
        '400':
          description: 'Status Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED_NATIVE'
                GENERIC_REQUIRED:
                  $ref: '#/components/examples/GENERIC_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED_NATIVE'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED_NATIVE'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED_NATIVE'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND_NATIVE'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID_NATIVE'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_NATIVE'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID_NATIVE'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED_NATIVE'
  /api/v2/access_token/activesession:
    get:
      summary: Retrieve active session
      description: Retrieves details of the current active session for the authenticated User.
      operationId: GetActiveSession
      tags:
        - Account Session
      parameters:
        - $ref: '#/components/parameters/TokenNotRequired'
        - $ref: '#/components/parameters/ProfileId'
        - $ref: '#/components/parameters/AccountId'
      security:
        - XLoginRadiusAPISecret: []
          XLoginRadiusAPIKey: []
        - ApiSecret: []
          APIKey: []
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveSessionResponse'
        '400':
          description: 'Status Bad Request: The request was invalid or cannot be served.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED_NATIVE'
                GENERIC_REQUIRED:
                  $ref: '#/components/examples/GENERIC_REQUIRED'
                API_SECRET_REQUIRED:
                  $ref: '#/components/examples/API_SECRET_REQUIRED_NATIVE'
                API_SECRET_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_SECRET_NOT_WELL_FORMATTED_NATIVE'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED_NATIVE'
                OAUTH_TOKEN_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND_NATIVE'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID_NATIVE'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_NATIVE'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID_NATIVE'
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED_NATIVE'
                PROFILE_ID_MISSING:
                  $ref: '#/components/examples/PROFILE_ID_MISSING'
                USER_ID_NOT_VALID:
                  $ref: '#/components/examples/USER_ID_NOT_VALID_NATIVE'
                ACCOUNT_ID_REQUIRED:
                  $ref: '#/components/examples/ACCOUNT_ID_REQUIRED'
                ACCOUNT_ID_IS_INVALID:
                  $ref: '#/components/examples/ACCOUNT_ID_IS_INVALID_NATIVE'
                ACTIVE_TOKEN_NOT_EXISTS:
                  $ref: '#/components/examples/ACTIVE_TOKEN_NOT_EXISTS'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED_OIDC'
  /api/v2/access_token/{nativeProvider}:
    get:
      summary: Login via social provider
      description: Retrieves an Access Token for authentication through a native social provider.
      operationId: NativeProviderAccessToken
      tags:
        - Login
      parameters:
        - $ref: '#/components/parameters/NativeProvider'
        - $ref: '#/components/parameters/SocialAppName'
        - $ref: '#/components/parameters/RedirectUri'
        - $ref: '#/components/parameters/RefreshToken'
        - $ref: '#/components/parameters/ProviderName'
        - $ref: '#/components/parameters/Code'
        - $ref: '#/components/parameters/TwitterToken'
        - $ref: '#/components/parameters/TwitterSecret'
        - $ref: '#/components/parameters/GoogleAuthCode'
        - $ref: '#/components/parameters/ClientId'
        - $ref: '#/components/parameters/GoogleAccessToken'
        - $ref: '#/components/parameters/IdToken'
        - $ref: '#/components/parameters/FourSquareAccessToken'
        - $ref: '#/components/parameters/LinkedInAccessToken'
        - $ref: '#/components/parameters/FacebookAccessToken'
        - $ref: '#/components/parameters/InvitationToken'
      responses:
        '200':
          description: 'Status OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                GENERIC_REQUIRED:
                  $ref: '#/components/examples/GENERIC_REQUIRED'
                REFRESH_TOKEN_REQUIRED:
                  $ref: '#/components/examples/REFRESH_TOKEN_REQUIRED'
                JWTAPP_PROVIDER_REQUIRED:
                  $ref: '#/components/examples/JWTAPP_PROVIDER_REQUIRED'
                PROVIDER_NAME_REQUIRED:
                  $ref: '#/components/examples/PROVIDER_NAME_REQUIRED'
                ACCESS_TOKEN_REQUIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED'
                SP_JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SP_JWT_CONFIG_NOT_FOUND'
                INVALID_PROVIDER_IN_ORGANIZATION:
                  $ref: '#/components/examples/INVALID_PROVIDER_IN_ORGANIZATION'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED_PROVIDER'
                API_KEY_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED_NATIVE'
        '401':
          description: 'Status Unauthorized: The request requires User authentication.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_SECRET_NOT_VALID:
                  $ref: '#/components/examples/API_SECRET_NOT_VALID_NATIVE'
        '403':
          description: 'Status Forbidden: The server understood the request, but refuses to authorize it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_NATIVE'
                PROVIDER_NAME_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_NAME_NOT_VALID'
                SOMETHING_GOING_WRONG:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG'
                TRIAL_PLAN_USER_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED'
                PROVIDER_NOT_CONFIGURED:
                  $ref: '#/components/examples/PROVIDER_NOT_CONFIGURED'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED'
                PROVIDER_NOT_SUPPORTED:
                  $ref: '#/components/examples/PROVIDER_NOT_SUPPORTED'
                PROVIDER_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_NOT_VALID'
                PROVIDER_SIDE_ERROR:
                  $ref: '#/components/examples/PROVIDER_SIDE_ERROR_NATIVE'
                CLIENT_GUID_MUST_BE_UNIQUE:
                  $ref: '#/components/examples/CLIENT_GUID_MUST_BE_UNIQUE'
                EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION'
                AUTOLOOKUP_DOMAIN_NOT_MATCH:
                  $ref: '#/components/examples/AUTOLOOKUP_DOMAIN_NOT_MATCH'
        '500':
          description: 'Status Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseNative'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - APIKey: []
          ApiSecret: []
        - XLoginRadiusAPISecret: []
          XLoginRadiusAPIKey: []
  /v2/manage/invitations/{invitationid}:
    get:
      summary: Retrieve invitation by ID
      operationId: getInvitationByInvitationId
      description: Retrieves invitation details by invitation ID.
      tags:
        - User
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/InvitationId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invitation'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_ID_REQUIRED:
                  $ref: '#/components/examples/INVITATION_ID_REQUIRED'
                INVALID_INVITATION_ID:
                  $ref: '#/components/examples/INVALID_INVITATION_ID'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    put:
      summary: Update invitation by ID
      operationId: updateInvitationByInvitationId
      description: Updates invitation details by invitation ID.
      tags:
        - Organization Invitations
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/InvitationId'
        - $ref: '#/components/parameters/InvitationUrl'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                RolesIds:
                  type: array
                  description: The list of Role IDs associated with the invitation. Each Role ID is typically in the format *role_<unique_id>*, where *<unique_id>* is a string of alphanumeric characters.
                  items:
                    type: string
                  example:
                    - role_123456
                    - role_78901
                ResendEmail:
                  type: boolean
                  description: Indicates whether to resend the invitation Email. If set to true, the invitation Email will be resent to the User.
                  example: true
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invitation'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_ID_INVALID:
                  $ref: '#/components/examples/INVITATION_ID_REQUIRED'
                INVALID_JSON_BODY:
                  $ref: '#/components/examples/INVALID_JSON_BODY'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED_PARTNER'
                INVITATION_ID_REQUIRED:
                  $ref: '#/components/examples/INVITATION_ID_REQUIRED'
                ROLE_OR_RESEND_EMAIL_REQUIRED:
                  $ref: '#/components/examples/ROLE_OR_RESEND_EMAIL_REQUIRED'
                INVALID_INVITATION_URL:
                  $ref: '#/components/examples/INVALID_INVITATION_URL'
                INVITATION_ACCEPTED:
                  $ref: '#/components/examples/INVITATION_ACCEPTED'
                INVITATION_EXPIRED:
                  $ref: '#/components/examples/INVITATION_EXPIRED'
                INVITATION_REVOKED:
                  $ref: '#/components/examples/INVITATION_REVOKED'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
                INVALID_INVITER_UID:
                  $ref: '#/components/examples/INVALID_INVITER_UID'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
                ROLE_NOT_EXIST:
                  $ref: '#/components/examples/ROLE_NOT_EXIST'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    delete:
      summary: Delete invitation by ID
      operationId: deleteInvitationByInvitationId
      description: Deletes or revokes an invitation by invitation ID.
      tags:
        - Organization Invitations
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/InvitationId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invitation'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_ID_INVALID:
                  $ref: '#/components/examples/INVITATION_ID_REQUIRED'
                Invitation_ID_REQUIRED:
                  $ref: '#/components/examples/INVITATION_ID_REQUIRED'
                INVITATION_ACCEPTED:
                  $ref: '#/components/examples/INVITATION_ACCEPTED'
                INVITATION_EXPIRED:
                  $ref: '#/components/examples/INVITATION_EXPIRED'
                INVITATION_REVOKED:
                  $ref: '#/components/examples/INVITATION_REVOKED'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/invitations:
    get:
      summary: List invitations by Organization ID
      operationId: getInvitationsByOrgId
      description: Lists all invitations by Organization ID.
      tags:
        - Organization Invitations
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - name: orgid
          in: query
          required: true
          schema:
            type: string
            description: The ID of the Organization to retrieve invitations for.
          example: org_123456789
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invitation'
                  TotalCount:
                    type: integer
                    example: 100
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_ID_REQUIRED:
                  $ref: '#/components/examples/ORGANIZATION_ID_REQUIRED'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    post:
      summary: Send invitation
      operationId: sendInvitation
      description: Sends a new invitation.
      tags:
        - Organization Invitations
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/InvitationUrl'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendInvitation'
            example:
              email: user@example.com
              roleIds:
                - role_12345
                - role_67890
              orgId: org_123456789
              inviterUid: '123456789'
      responses:
        '200':
          description: Invitation sent successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invitation'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                INVALID_JSON_BODY:
                  $ref: '#/components/examples/INVALID_JSON_BODY'
                SEND_INVITATION_REQUIRED:
                  $ref: '#/components/examples/SEND_INVITATION_REQUIRED'
                INVALID_INVITATION_URL:
                  $ref: '#/components/examples/INVALID_INVITATION_URL'
                INVALID_EMAIL:
                  $ref: '#/components/examples/INVALID_EMAIL'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
                INVALID_INVITER_UID:
                  $ref: '#/components/examples/INVALID_INVITER_UID'
                INVITATION_ALREADY_ACTIVE:
                  $ref: '#/components/examples/INVITATION_ALREADY_ACTIVE'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
                ROLE_NOT_EXIST:
                  $ref: '#/components/examples/ROLE_NOT_EXIST'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_EXISTS_IN_ORG:
                  $ref: '#/components/examples/USER_EXISTS_IN_ORG'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/invitations/{invitationid}/resend:
    post:
      summary: Resend invitation by ID
      operationId: resendInvitationByInvitationId
      description: Resends an invitation by invitation ID.
      tags:
        - Organization Invitations
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/InvitationId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResendInvitation'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_ID_REQUIRED:
                  $ref: '#/components/examples/INVITATION_ID_REQUIRED'
                INVALID_INVITATION_ID:
                  $ref: '#/components/examples/INVALID_INVITATION_ID'
                INVITATION_ACCEPTED:
                  $ref: '#/components/examples/INVITATION_ACCEPTED'
                INVITATION_EXPIRED:
                  $ref: '#/components/examples/INVITATION_EXPIRED'
                INVITATION_REVOKED:
                  $ref: '#/components/examples/INVITATION_REVOKED'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVITATION_NOT_FOUND:
                  $ref: '#/components/examples/INVITATION_NOT_FOUND'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/organizations:
    get:
      description: Retrieves a list of all Organizations in the Tenant.
      operationId: GetAllOrganizations
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    items:
                      $ref: '#/components/schemas/OrganizationsResponse'
                    type: array
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: List Organizations
      tags:
        - Organization
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    post:
      description: Creates a new Organization in the Tenant.
      operationId: CreateOrganization
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/OrganizationBase'
                - type: object
                  required:
                    - Name
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationsResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                DOMAIN_DUPLICATE:
                  $ref: '#/components/examples/DOMAIN_DUPLICATE'
                DOMAIN_NAME_INVALID:
                  $ref: '#/components/examples/DOMAIN_NAME_INVALID'
                DOMAIN_NO_VALID_MX_RECORD:
                  $ref: '#/components/examples/DOMAIN_NO_VALID_MX_RECORD'
                DOMAIN_SPAM_OR_GENERIC_DOMAIN:
                  $ref: '#/components/examples/DOMAIN_SPAM_OR_GENERIC_DOMAIN'
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                NAME_REQUIRED:
                  $ref: '#/components/examples/NAME_REQUIRED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                TRIAL_PLAN_ORG_LIMIT_REACHED:
                  $ref: '#/components/examples/TRIAL_PLAN_ORG_LIMIT_REACHED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          content:
            application/json:
              examples:
                ORGANIZATION_ALREADY_EXIST:
                  $ref: '#/components/examples/ORGANIZATION_ALREADY_EXIST'
                ORGANIZATION_DOMAIN_ALREADY_EXIST:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_ALREADY_EXIST'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Create Organization
      tags:
        - Organization
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/organizations/{orgId}:
    delete:
      description: Deletes an Organization by its ID.
      operationId: DeleteOrganization
      parameters:
        - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Delete Organization
      tags:
        - Organization
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    get:
      description: Retrieves details of a specific Organization by its ID.
      operationId: GetOrganization
      parameters:
        - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationsResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Retrieve Organization details
      tags:
        - Organization
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    put:
      description: Updates an Organization by its ID. Supports updating org fields, policies, and status in a single request.
      operationId: UpdateOrganization
      parameters:
        - $ref: '#/components/parameters/orgId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationUpdateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationsResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                DOMAIN_DUPLICATE:
                  $ref: '#/components/examples/DOMAIN_DUPLICATE'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED_PARTNER'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
                ORGANIZATION_MEMBER_ROLE_NOT_VALID:
                  $ref: '#/components/examples/ORGANIZATION_MEMBER_ROLE_NOT_VALID'
                STATUS_UPDATE_INVALID:
                  $ref: '#/components/examples/STATUS_UPDATE_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_DOMAIN_CAN_NOT_DELETED:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_CAN_NOT_DELETED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_JIT_POLICY_NOT_ALLOWED:
                  $ref: '#/components/examples/ORGANIZATION_JIT_POLICY_NOT_ALLOWED'
                ORGANIZATION_MFA_ENFORCEMENT_NOT_ALLOWED:
                  $ref: '#/components/examples/ORGANIZATION_MFA_ENFORCEMENT_NOT_ALLOWED'
                ORGANIZATION_MFA_NONE_ENFORCEMENT_NOT_ALLOWED:
                  $ref: '#/components/examples/ORGANIZATION_MFA_NONE_ENFORCEMENT_NOT_ALLOWED'
                ORGANIZATION_MFA_ENFORCEMENT_ONLY_FORCE_ALLOWED:
                  $ref: '#/components/examples/ORGANIZATION_MFA_ENFORCEMENT_ONLY_FORCE_ALLOWED'
                ORGANIZATION_MFA_FORCE_AUTHENTICATORS_DISABLED:
                  $ref: '#/components/examples/ORGANIZATION_MFA_FORCE_AUTHENTICATORS_DISABLED'
                ORGANIZATION_ENABLE_MFA_ENFORCEMENT_NOT_ALLOWED:
                  $ref: '#/components/examples/ORGANIZATION_ENABLE_MFA_ENFORCEMENT_NOT_ALLOWED'
                ORGANIZATION_DISABLE_MFA_ENFORCEMENT_NOT_ALLOWED:
                  $ref: '#/components/examples/ORGANIZATION_DISABLE_MFA_ENFORCEMENT_NOT_ALLOWED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          content:
            application/json:
              examples:
                ORGANIZATION_ALREADY_EXIST:
                  $ref: '#/components/examples/ORGANIZATION_ALREADY_EXIST'
                ORGANIZATION_DOMAIN_ALREADY_EXIST:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_ALREADY_EXIST'
                CONNECTION_DOMAIN_ALREADY_EXIST:
                  $ref: '#/components/examples/CONNECTION_DOMAIN_ALREADY_EXIST'
                STATUS_UPDATED_ALREADY:
                  $ref: '#/components/examples/STATUS_UPDATED_ALREADY'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Update Organization
      tags:
        - Organization
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/organizations/{orgId}/connections:
    get:
      description: Lists all Identity Provider connections for an Organization.
      operationId: GetAllOrganizationConnections
      parameters:
        - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    items:
                      $ref: '#/components/schemas/ConnectionResponse'
                    type: array
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: List Organization connections
      tags:
        - Organization Connections
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    post:
      description: Creates a new Identity Provider connection for an Organization.
      operationId: CreateOrganizationConnection
      parameters:
        - $ref: '#/components/parameters/orgId'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/OrganizationConnectionRequest'
                - type: object
                  required:
                    - Name
                    - ConnectionType
                    - Domain
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                CONNECTION_TYPE_INVALID:
                  $ref: '#/components/examples/CONNECTION_TYPE_INVALID'
                CONNECTION_TYPE_REQUIRED:
                  $ref: '#/components/examples/CONNECTION_TYPE_REQUIRED'
                CUSTOM_MAPPING_INVALID:
                  $ref: '#/components/examples/CUSTOM_MAPPING_INVALID'
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                NAME_INVALID:
                  $ref: '#/components/examples/NAME_INVALID'
                NAME_REQUIRED:
                  $ref: '#/components/examples/NAME_REQUIRED'
                OIDC_IDP_ISSUER_INVALID:
                  $ref: '#/components/examples/OIDC_IDP_ISSUER_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
                CONN_SAML_IDP_CERTIFICATE_INVALID:
                  $ref: '#/components/examples/CONN_SAML_IDP_CERTIFICATE_INVALID'
                SAML_METADATA_ENDPOINT_INVALID:
                  $ref: '#/components/examples/SAML_METADATA_ENDPOINT_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_DOMAIN_NOT_VERIFIED:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_NOT_VERIFIED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_DOMAIN_NOT_EXIST:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_NOT_EXIST'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          content:
            application/json:
              examples:
                CONNECTION_ALREADY_EXIST:
                  $ref: '#/components/examples/CONNECTION_ALREADY_EXIST'
                CONNECTION_DOMAIN_ALREADY_EXIST:
                  $ref: '#/components/examples/CONNECTION_DOMAIN_ALREADY_EXIST'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Create Organization connection
      tags:
        - Organization Connections
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/organizations/{orgId}/connections/{connId}:
    delete:
      description: Deletes an Identity Provider connection from an Organization.
      operationId: DeleteOrganizationConnection
      parameters:
        - $ref: '#/components/parameters/orgId'
        - $ref: '#/components/parameters/connId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                CONNECTION_ID_INVALID:
                  $ref: '#/components/examples/CONNECTION_ID_INVALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED_PARTNER'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
                STATUS_UPDATE_INVALID:
                  $ref: '#/components/examples/STATUS_UPDATE_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          content:
            application/json:
              examples:
                STATUS_UPDATED_ALREADY:
                  $ref: '#/components/examples/STATUS_UPDATED_ALREADY'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Delete Organization connection
      tags:
        - Organization Connections
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    get:
      description: Retrieves details of a specific Identity Provider connection.
      operationId: GetOrganizationConnection
      parameters:
        - $ref: '#/components/parameters/orgId'
        - $ref: '#/components/parameters/connId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                CONNECTION_ID_INVALID:
                  $ref: '#/components/examples/CONNECTION_ID_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Retrieve Organization connection
      tags:
        - Organization Connections
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    put:
      description: Updates the configuration of an Identity Provider connection.
      operationId: UpdateOrganizationConnection
      parameters:
        - $ref: '#/components/parameters/orgId'
        - $ref: '#/components/parameters/connId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationConnectionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                CONNECTION_ID_INVALID:
                  $ref: '#/components/examples/CONNECTION_ID_INVALID'
                CUSTOM_MAPPING_INVALID:
                  $ref: '#/components/examples/CUSTOM_MAPPING_INVALID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED_PARTNER'
                NAME_INVALID:
                  $ref: '#/components/examples/NAME_INVALID'
                OIDC_IDP_ISSUER_INVALID:
                  $ref: '#/components/examples/OIDC_IDP_ISSUER_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
                CONN_SAML_IDP_CERTIFICATE_INVALID:
                  $ref: '#/components/examples/CONN_SAML_IDP_CERTIFICATE_INVALID'
                SAML_METADATA_ENDPOINT_INVALID:
                  $ref: '#/components/examples/SAML_METADATA_ENDPOINT_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_DOMAIN_NOT_VERIFIED:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_NOT_VERIFIED'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_DOMAIN_NOT_EXIST:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_NOT_EXIST'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          content:
            application/json:
              examples:
                CONNECTION_ALREADY_EXIST:
                  $ref: '#/components/examples/CONNECTION_ALREADY_EXIST'
                CONNECTION_DOMAIN_ALREADY_EXIST:
                  $ref: '#/components/examples/CONNECTION_DOMAIN_ALREADY_EXIST'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Update Organization connection
      tags:
        - Organization Connections
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/organizations/{orgId}/connections/{connId}/grouproles:
    get:
      description: Lists all group-to-role mappings for an Identity Provider connection.
      operationId: GetAllConnectionGroupRoles
      parameters:
        - $ref: '#/components/parameters/orgId'
        - $ref: '#/components/parameters/connId'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    items:
                      $ref: '#/components/schemas/ConnectionGroupRoleResponse'
                    type: array
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                CONNECTION_ID_INVALID:
                  $ref: '#/components/examples/CONNECTION_ID_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: List Organization connection group Roles
      tags:
        - Organization Connection Group Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    post:
      description: Creates a new group-to-role mapping for an Identity Provider connection.
      operationId: CreateConnectionGroupRole
      parameters:
        - $ref: '#/components/parameters/connId'
        - $ref: '#/components/parameters/orgId'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/ConnectionGroupRoleRequest'
                - type: object
                  required:
                    - Name
                    - GroupId
                    - RoleId
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGroupRoleResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                CONNECTION_ID_INVALID:
                  $ref: '#/components/examples/CONNECTION_ID_INVALID'
                GROUP_ROLE_GROUP_ID_REQUIRED:
                  $ref: '#/components/examples/GROUP_ROLE_GROUP_ID_REQUIRED'
                GROUP_ROLE_ROLE_ID_INVALID:
                  $ref: '#/components/examples/GROUP_ROLE_ROLE_ID_INVALID'
                GROUP_ROLE_ROLE_ID_REQUIRED:
                  $ref: '#/components/examples/GROUP_ROLE_ROLE_ID_REQUIRED'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                NAME_INVALID:
                  $ref: '#/components/examples/NAME_INVALID'
                NAME_REQUIRED:
                  $ref: '#/components/examples/NAME_REQUIRED'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          content:
            application/json:
              examples:
                GROUP_ROLE_NAME_ALREADY_EXIST:
                  $ref: '#/components/examples/GROUP_ROLE_NAME_ALREADY_EXIST'
                GROUP_ROLE_GROUP_ID_ALREADY_EXIST:
                  $ref: '#/components/examples/GROUP_ROLE_GROUP_ID_ALREADY_EXIST'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Create Organization connection group Role
      tags:
        - Organization Connection Group Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/organizations/{orgId}/connections/{connId}/grouproles/{groupRoleId}:
    delete:
      description: Deletes a specific group-to-role mapping.
      operationId: DeleteConnectionGroupRole
      parameters:
        - $ref: '#/components/parameters/orgId'
        - $ref: '#/components/parameters/connId'
        - $ref: '#/components/parameters/groupRoleId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                CONNECTION_ID_INVALID:
                  $ref: '#/components/examples/CONNECTION_ID_INVALID'
                GROUP_ROLE_ID_INVALID:
                  $ref: '#/components/examples/GROUP_ROLE_ID_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                GROUP_ROLE_NOT_EXIST:
                  $ref: '#/components/examples/GROUP_ROLE_NOT_EXIST'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          content:
            application/json:
              examples:
                GROUP_ROLE_NAME_ALREADY_EXIST:
                  $ref: '#/components/examples/GROUP_ROLE_NAME_ALREADY_EXIST'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Delete Organization connection group Role
      tags:
        - Organization Connection Group Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    put:
      description: Updates a specific group-to-role mapping.
      operationId: UpdateConnectionGroupRole
      parameters:
        - $ref: '#/components/parameters/connId'
        - $ref: '#/components/parameters/groupRoleId'
        - $ref: '#/components/parameters/orgId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionGroupRoleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGroupRoleResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                CONNECTION_ID_INVALID:
                  $ref: '#/components/examples/CONNECTION_ID_INVALID'
                GROUP_ROLE_GROUP_ID_REQUIRED:
                  $ref: '#/components/examples/GROUP_ROLE_GROUP_ID_REQUIRED'
                GROUP_ROLE_ID_INVALID:
                  $ref: '#/components/examples/GROUP_ROLE_ID_INVALID'
                GROUP_ROLE_ROLE_ID_INVALID:
                  $ref: '#/components/examples/GROUP_ROLE_ROLE_ID_INVALID'
                GROUP_ROLE_ROLE_ID_REQUIRED:
                  $ref: '#/components/examples/GROUP_ROLE_ROLE_ID_REQUIRED'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                NAME_INVALID:
                  $ref: '#/components/examples/NAME_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                GROUP_ROLE_NOT_EXIST:
                  $ref: '#/components/examples/GROUP_ROLE_NOT_EXIST'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          content:
            application/json:
              examples:
                GROUP_ROLE_NAME_ALREADY_EXIST:
                  $ref: '#/components/examples/GROUP_ROLE_NAME_ALREADY_EXIST'
                GROUP_ROLE_GROUP_ID_ALREADY_EXIST:
                  $ref: '#/components/examples/GROUP_ROLE_GROUP_ID_ALREADY_EXIST'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Update Organization connection group Role
      tags:
        - Organization Connection Group Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/organizations/{orgId}/connections/{connId}/status:
    put:
      description: Updates the active status of an Identity Provider connection.
      operationId: UpdateConnectionStatus
      parameters:
        - $ref: '#/components/parameters/orgId'
        - $ref: '#/components/parameters/connId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionStatusRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionStatusResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Update Organization connection status
      tags:
        - Organization Connections
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/organizations/{orgId}/domains:
    get:
      description: Lists all domains associated with an Organization.
      operationId: GetAllOrganizationDomains
      parameters:
        - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    items:
                      $ref: '#/components/schemas/OrganizationsDomainsResponse'
                    type: array
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: List Organization domains
      tags:
        - Organization Domains
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    post:
      description: Adds a new domain to an Organization.
      operationId: AddOrganizationDomain
      parameters:
        - $ref: '#/components/parameters/orgId'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                DomainName:
                  type: string
                  example: example.com
              required:
                - DomainName
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationsDomainsResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                DOMAIN_NO_VALID_MX_RECORD:
                  $ref: '#/components/examples/DOMAIN_NO_VALID_MX_RECORD'
                DOMAIN_SPAM_OR_GENERIC_DOMAIN:
                  $ref: '#/components/examples/DOMAIN_SPAM_OR_GENERIC_DOMAIN'
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                ORGANIZATION_DOMAIN_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_ID_INVALID'
                ORGANIZATION_DOMAIN_NAME_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_NAME_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Add Organization domain
      tags:
        - Organization Domains
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/organizations/{orgId}/domains/{domainId}:
    delete:
      description: Deletes a domain from an Organization.
      operationId: DeleteOrganizationDomain
      parameters:
        - $ref: '#/components/parameters/orgId'
        - $ref: '#/components/parameters/domainId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                ORGANIZATION_DOMAIN_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_ID_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_DOMAIN_CAN_NOT_DELETED:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_CAN_NOT_DELETED'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Delete Organization domain
      tags:
        - Organization Domains
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    get:
      description: Retrieves details of a specific Organization domain.
      operationId: GetOrganizationDomain
      parameters:
        - $ref: '#/components/parameters/orgId'
        - $ref: '#/components/parameters/domainId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationsDomainsResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Retrieve Organization domain
      tags:
        - Organization Domains
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
    post:
      description: Verifies the ownership of an Organization domain.
      operationId: VerifyOrganizationDomain
      parameters:
        - $ref: '#/components/parameters/domainId'
        - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationsDomainsResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                DOMAIN_TXT_RECORD_FAILED:
                  $ref: '#/components/examples/DOMAIN_TXT_RECORD_FAILED'
                ORGANIZATION_DOMAIN_ALREADY_VERIFY:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_ALREADY_VERIFY'
                ORGANIZATION_DOMAIN_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_DOMAIN_ID_INVALID'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
      summary: Verify Organization domain
      tags:
        - Organization Domains
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
  /v2/manage/permissions:
    get:
      summary: List Permissions
      operationId: Permissions
      description: Retrieves a list of all Permissions.
      tags:
        - Permissions
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Permissions'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    post:
      summary: Create Permission
      operationId: AddPermission
      description: Adds a new Permission.
      tags:
        - Permissions
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PermissionsPostRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Permissions'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                INVALID_OBJECT_ID:
                  $ref: '#/components/examples/INVALID_ID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DUPLICATE_PERMISSION_NAME:
                  $ref: '#/components/examples/DUPLICATE_PERMISSION_NAME'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/permissions/{id}:
    get:
      summary: Retrieve Permission by ID
      operationId: GetPermissionById
      description: Retrieves a Permission by its ID.
      tags:
        - Permissions
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/permissionId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Permissions'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PERMISSION_ID_REQUIRED:
                  $ref: '#/components/examples/PERMISSION_ID_REQUIRED'
                PERMISSION_ID_INVALID:
                  $ref: '#/components/examples/PERMISSION_ID_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    put:
      summary: Update Permission
      operationId: UpdateTenantPermission
      description: 'Updates a specific Permission. Note: The Name field cannot be modified for non-B2B apps. If a different Name value is provided, the API will return an error.'
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/permissionId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PermissionPutRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Permissions'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED_PARTNER'
                PERMISSION_ID_REQUIRED:
                  $ref: '#/components/examples/PERMISSION_ID_REQUIRED'
                PERMISSION_ID_INVALID:
                  $ref: '#/components/examples/PERMISSION_ID_INVALID'
                PARAMETER_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                NAME_NOT_ALLOWED_TO_UPDATE:
                  $ref: '#/components/examples/NAME_NOT_ALLOWED_TO_UPDATE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DUPLICATE_PERMISSION_NAME:
                  $ref: '#/components/examples/DUPLICATE_PERMISSION_NAME'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    delete:
      summary: Delete Permission
      operationId: DeleteTenantPermission
      description: Deletes a specific Permission.
      tags:
        - Permissions
      parameters:
        - $ref: '#/components/parameters/permissionId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PERMISSION_ID_REQUIRED:
                  $ref: '#/components/examples/PERMISSION_ID_REQUIRED'
                PERMISSION_ID_INVALID:
                  $ref: '#/components/examples/PERMISSION_ID_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/roles:
    get:
      description: Lists all Roles within the Tenant.
      operationId: GetAllTenantRoles
      summary: List Tenant Roles
      tags:
        - Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantRole'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    post:
      description: Creates a Role within the Tenant.
      operationId: CreateTenantRole
      summary: Create Tenant Role
      tags:
        - Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RolePostRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantRole'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                PERMISSION_ID_INVALID:
                  $ref: '#/components/examples/PERMISSION_ID_INVALID'
                INVALID_BODY_JSON:
                  $ref: '#/components/examples/INVALID_BODY_JSON'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DUPLICATE_ROLE_NAME:
                  $ref: '#/components/examples/DUPLICATE_ROLE_NAME'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/roles/{id}:
    get:
      description: Retrieves details of a Role by its ID.
      operationId: GetRoleById
      summary: Retrieve Role by ID
      tags:
        - Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/roleId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_ID_REQUIRED:
                  $ref: '#/components/examples/ROLE_ID_REQUIRED'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    put:
      description: Updates a Role by its ID.
      operationId: UpdateRole
      summary: Update Role
      tags:
        - Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/roleId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RolesPutRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED_PARTNER'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                PERMISSION_ID_INVALID:
                  $ref: '#/components/examples/PERMISSION_ID_INVALID'
                ROLE_ID_REQUIRED:
                  $ref: '#/components/examples/ROLE_ID_REQUIRED'
                INVALID_BODY_JSON:
                  $ref: '#/components/examples/INVALID_BODY_JSON'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
                NAME_NOT_ALLOWED_TO_UPDATE:
                  $ref: '#/components/examples/NAME_NOT_ALLOWED_TO_UPDATE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DUPLICATE_ROLE_NAME:
                  $ref: '#/components/examples/DUPLICATE_ROLE_NAME'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    delete:
      description: Deletes a Role by its ID.
      operationId: DeleteTenantRole
      summary: Delete Role
      tags:
        - Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/roleId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_ID_REQUIRED:
                  $ref: '#/components/examples/ROLE_ID_REQUIRED'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DEFAULT_ROLE_CANNOT_BE_DELETED:
                  $ref: '#/components/examples/DEFAULT_ROLE_CANNOT_BE_DELETED'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_PARTNER'
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/roles/{name}/name:
    get:
      summary: Retrieve Role by name
      description: Retrieves details of a Role by its name.
      operationId: RoleByName
      tags:
        - Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - name: name
          in: path
          description: Role Name
          required: true
          schema:
            type: string
          example: Admin
        - name: orgid
          in: query
          description: Organization ID
          required: false
          schema:
            type: string
          example: org_2enk23n3
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Role'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_ID_REQUIRED:
                  $ref: '#/components/examples/ROLE_NAME_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/roles/{id}/default:
    put:
      description: |
        Sets a Role as the default for new Users. This API is supported only for B2B tenants.
      operationId: SetDefaultRole
      summary: Set default Role
      tags:
        - Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/roleId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_ID_REQUIRED:
                  $ref: '#/components/examples/ROLE_ID_REQUIRED'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_DOES_NOT_BELONGS_TO_TENANT:
                  $ref: '#/components/examples/ROLE_DOES_NOT_BELONGS_TO_TENANT'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/account/{uid}/orgcontext:
    get:
      summary: Retrieve Organization context by UID
      description: Retrieves User Roles for all Organizations by UID.
      operationId: getOrgContextByUid
      tags:
        - Organization User Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/Uid'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserRole'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/USER_ID_REQUIRED'
                USER_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/USER_DOES_NOT_EXISTS'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    delete:
      summary: Delete Organization context by UID
      description: Deletes User Roles for all Organizations by UID.
      operationId: deleteOrgContextByUid
      tags:
        - Organization User Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/Uid'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/USER_ID_REQUIRED'
                USER_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/USER_DOES_NOT_EXISTS'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/account/{uid}/orgcontext/{orgId}:
    get:
      summary: Retrieve Organization Roles by OrgID and UID
      description: Retrieves User Roles of an Organization by UID and OrgID.
      operationId: getOrgContextByUidAndOrgId
      tags:
        - Organization User Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/Uid'
        - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserRole'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/USER_ID_REQUIRED'
                USER_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/USER_DOES_NOT_EXISTS'
                ORGANIZATION_ID_REQUIRED:
                  $ref: '#/components/examples/ORGANIZATION_ID_REQUIRED'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    delete:
      summary: Delete Organization Roles by OrgID and UID
      description: Deletes User Roles of an Organization by UID and OrgID.
      operationId: deleteOrgContextByUidAndOrgId
      tags:
        - Organization User Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/Uid'
        - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/USER_ID_REQUIRED'
                USER_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/USER_DOES_NOT_EXISTS'
                ORGANIZATION_ID_REQUIRED:
                  $ref: '#/components/examples/ORGANIZATION_ID_REQUIRED'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
        '403':
          description: 'Forbidden: The server understood the request, but is refusing to fulfill it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
                USER_NOT_FOUND_IN_ORG:
                  $ref: '#/components/examples/USER_NOT_FOUND_IN_ORG'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/account/{uid}/orgcontext/{orgId}/roles:
    put:
      summary: Assign Roles in Organization
      description: Assigns Roles to a User within a specific Organization.
      operationId: assignRolesToUser
      tags:
        - Organization User Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/Uid'
        - $ref: '#/components/parameters/orgId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRolePutRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserRole'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/USER_ID_REQUIRED'
                ORGANIZATION_ID_REQUIRED:
                  $ref: '#/components/examples/ORGANIZATION_ID_REQUIRED'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED_PARTNER'
                ROLE_DOES_NOT_BELONGS_TO_ORG:
                  $ref: '#/components/examples/ROLE_DOES_NOT_BELONGS_TO_ORG'
                INVALID_BODY_JSON:
                  $ref: '#/components/examples/INVALID_BODY_JSON'
                PARAMETER_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                B2B_EMAIL_NOT_AVAILABLE:
                  $ref: '#/components/examples/B2B_EMAIL_NOT_AVAILABLE'
        '403':
          description: 'Forbidden: The server understood the request, but is refusing to fulfill it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                ROLE_DOES_NOT_BELONGS_TO_ORG:
                  $ref: '#/components/examples/ROLE_DOES_NOT_BELONGS_TO_ORG'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
                USER_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/USER_DOES_NOT_EXISTS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ROLE_ALREADY_EXISTS:
                  $ref: '#/components/examples/USER_ROLE_ALREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/account/{uid}/orgcontext/roles:
    put:
      summary: Assign Roles in Tenant
      description: Assigns Roles to a User within a Tenant.
      operationId: assignRolesToUserInAllOrgs
      tags:
        - Organization User Roles
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/Uid'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserRole'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_ID_REQUIRED:
                  $ref: '#/components/examples/USER_ID_REQUIRED'
                INVALID_ROLE_ID:
                  $ref: '#/components/examples/INVALID_ROLE_ID'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED_PARTNER'
                INVALID_BODY_JSON:
                  $ref: '#/components/examples/INVALID_BODY_JSON'
                PARAMETER_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                B2B_EMAIL_NOT_AVAILABLE:
                  $ref: '#/components/examples/B2B_EMAIL_NOT_AVAILABLE'
        '403':
          description: 'Forbidden: The server understood the request, but is refusing to fulfill it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ROLE_DOES_NOT_BELONGS_TO_TENANT:
                  $ref: '#/components/examples/ROLE_DOES_NOT_BELONGS_TO_TENANT'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                USER_DOES_NOT_EXISTS:
                  $ref: '#/components/examples/USER_DOES_NOT_EXISTS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DUPLICATE_ROLE_NAME:
                  $ref: '#/components/examples/USER_ROLE_ALREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/organizations/{orgId}/orgcontext:
    get:
      summary: Retrieve Organization context
      description: Retrieves User Roles for all Organizations by OrgID.
      operationId: getOrgContextByOrgId
      tags:
        - Organization
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - name: orgId
          in: path
          description: Unique identifier of the Organization.
          required: true
          schema:
            type: string
          example: org_fasf432d
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserRole'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_ID_REQUIRED:
                  $ref: '#/components/examples/ORGANIZATION_ID_REQUIRED'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/organizations/{orgId}/roles:
    get:
      description: Lists all Roles defined within an Organization.
      operationId: getOrgRolesByOrgId
      summary: List Organization Roles
      tags:
        - Organization
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Role'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_ID_REQUIRED:
                  $ref: '#/components/examples/ORGANIZATION_ID_REQUIRED'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    post:
      summary: Create Role in Organization
      description: Creates a Role within an Organization.
      operationId: createTenantRole
      tags:
        - Organization
      security:
        - APIKey: []
          APISecret: []
        - ClientId: []
          ClientSecret: []
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/orgId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RolePostRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_ID_REQUIRED:
                  $ref: '#/components/examples/ORGANIZATION_ID_REQUIRED'
                ORGANIZATION_ID_INVALID:
                  $ref: '#/components/examples/ORGANIZATION_ID_INVALID'
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                INVALID_BODY_JSON:
                  $ref: '#/components/examples/INVALID_BODY_JSON'
                PARAMETER_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED'
                PERMISSION_ID_INVALID:
                  $ref: '#/components/examples/PERMISSION_ID_INVALID'
                ROLE_NAME_REQUIRED:
                  $ref: '#/components/examples/ROLE_NAME_REQUIRED'
        '403':
          description: 'Forbidden: The server understood the request, but is refusing to fulfill it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                B2B_NOT_ENABLED:
                  $ref: '#/components/examples/B2B_NOT_ENABLED'
        '404':
          description: 'Not Found: The requested resource could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ORGANIZATION_NOT_FOUND:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_PARTNER'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DUPLICATE_ROLE_NAME:
                  $ref: '#/components/examples/DUPLICATE_ROLE_NAME'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/sott:
    get:
      summary: List SOTTs
      operationId: GetAllSOTT
      description: Retrieves a list of all Secure One Time Token (SOTT) entries associated with the Tenant.
      tags:
        - SOTT
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SottList'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SOTT_NOT_FOUND:
                  $ref: '#/components/examples/SOTT_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    post:
      summary: Generate SOTT
      operationId: AddSott
      description: Generates a new Secure One Time Token (SOTT) for the Tenant based on specified technology and parameters.
      tags:
        - SOTT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SottGenerateTechnology'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SottResponse'
        '400':
          description: Bad Request - The request could not be understood by the server due to malformed syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                TECHNOLOGY_SELECTION_INVALID:
                  $ref: '#/components/examples/TECHNOLOGY_SELECTION_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/workflows:
    get:
      summary: List workflows
      operationId: getAllWorkflows
      description: Retrieves a list of all workflows configured for the Tenant.
      tags:
        - Workflows
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkflowConfigWithoutData'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IDENTITY_ORCHESTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/IDENTITY_ORCHESTRATION_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    post:
      summary: Add workflow
      operationId: addWorkflow
      description: Adds a new workflow configuration to the Tenant.
      tags:
        - Workflows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddWorkflowConfig'
            examples:
              WORKFLOW_PAYLOAD:
                $ref: '#/components/examples/WORKFLOW_PAYLOAD'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowConfig'
              examples:
                WORKFLOW_RESPONSE:
                  $ref: '#/components/examples/WORKFLOW_RESPONSE'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                POST_BODY_INVALID:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                WORKFLOW_STATE_IS_INVALID:
                  $ref: '#/components/examples/WORKFLOW_STATE_IS_INVALID'
                INVALID_WORKFLOW_NAME:
                  $ref: '#/components/examples/INVALID_WORKFLOW_NAME'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IDENTITY_ORCHESTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/IDENTITY_ORCHESTRATION_NOT_ENABLED'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_CONFIG_EXISTS:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_EXISTS_WITH_SAME_NAME'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/workflows/{workflowId}:
    get:
      summary: Retrieve Workflow
      operationId: getWorkflowById
      description: Retrieves details of a specific Workflow using its unique identifier.
      tags:
        - Workflows
      parameters:
        - $ref: '#/components/parameters/WorkflowId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowConfig'
              examples:
                WORKFLOW_RESPONSE:
                  $ref: '#/components/examples/WORKFLOW_RESPONSE'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IDENTITY_ORCHESTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/IDENTITY_ORCHESTRATION_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    put:
      summary: Update Workflow
      operationId: updateWorkflow
      description: Updates the configuration of an existing Workflow.
      tags:
        - Workflows
      parameters:
        - $ref: '#/components/parameters/WorkflowId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowConfig'
            examples:
              WORKFLOW_PAYLOAD:
                $ref: '#/components/examples/WORKFLOW_PAYLOAD'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowConfig'
              examples:
                WORKFLOW_RESPONSE:
                  $ref: '#/components/examples/WORKFLOW_RESPONSE'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PUT_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                WORKFLOW_STATE_IS_INVALID:
                  $ref: '#/components/examples/WORKFLOW_STATE_IS_INVALID'
                INVALID_WORKFLOW_NAME:
                  $ref: '#/components/examples/INVALID_WORKFLOW_NAME'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IDENTITY_ORCHESTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/IDENTITY_ORCHESTRATION_NOT_ENABLED'
                WORKFLOW_CONFIG_UPDATE_EXISTS:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_EXISTS_WITH_SAME_NAME'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_NOT_FOUND'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_CONFIG_UPDATE_EXISTS:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_EXISTS_WITH_SAME_NAME'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    delete:
      summary: Delete Workflow
      operationId: deleteWorkflow
      description: Deletes an existing Workflow from the system.
      tags:
        - Workflows
      parameters:
        - $ref: '#/components/parameters/WorkflowId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IDENTITY_ORCHESTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/IDENTITY_ORCHESTRATION_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/workflows/{workflowId}/versions:
    get:
      summary: List Workflow Versions
      description: Returns a list of all available versions for a specified Workflow.
      operationId: GetAllWorkflowVersionList
      tags:
        - Workflows
      parameters:
        - $ref: '#/components/parameters/WorkflowId'
      responses:
        '200':
          description: List of workflow versions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionListResponse'
        '400':
          description: Invalid workflow ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_WORKFLOW_ID:
                  $ref: '#/components/examples/INVALID_WORKFLOW_ID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IDENTITY_ORCHESTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/IDENTITY_ORCHESTRATION_NOT_ENABLED'
        '404':
          description: Workflow not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_NOT_FOUND'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/workflows/{workflowId}/versions/{version}:
    delete:
      summary: Delete Workflow Version
      description: Deletes a specific version of a Workflow from the system.
      operationId: DeleteWorkflowVersion
      tags:
        - Workflows
      parameters:
        - $ref: '#/components/parameters/WorkflowId'
        - $ref: '#/components/parameters/Version'
      responses:
        '200':
          description: Workflow version deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: Invalid workflow id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_WORKFLOW_ID:
                  $ref: '#/components/examples/INVALID_WORKFLOW_ID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IDENTITY_ORCHESTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/IDENTITY_ORCHESTRATION_NOT_ENABLED'
        '404':
          description: Workflow version not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_NOT_FOUND'
                WORKFLOW_VERSION_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_VERSION_NOT_FOUND'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    put:
      summary: Restore Workflow Version
      description: Restores a specific version of a Workflow to its active state.
      operationId: RestoreWorkflowVersion
      tags:
        - Workflows
      parameters:
        - $ref: '#/components/parameters/WorkflowId'
        - $ref: '#/components/parameters/Version'
      responses:
        '200':
          description: Workflow version restored successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    $ref: '#/components/schemas/WorkflowData'
        '400':
          description: Invalid workflow id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_WORKFLOW_ID:
                  $ref: '#/components/examples/INVALID_WORKFLOW_ID'
        '403':
          description: Unauthorized access to restore workflow version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                FAILED_TO_RESTORE_WORKFLOW_VERSION:
                  $ref: '#/components/examples/FAILED_TO_RESTORE_WORKFLOW_VERSION'
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IDENTITY_ORCHESTRATION_NOT_ENABLED:
                  $ref: '#/components/examples/IDENTITY_ORCHESTRATION_NOT_ENABLED'
        '404':
          description: Workflow version not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WORKFLOW_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_CONFIG_NOT_FOUND'
                WORKFLOW_VERSION_NOT_FOUND:
                  $ref: '#/components/examples/WORKFLOW_VERSION_NOT_FOUND'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/webhooks:
    get:
      summary: List webhook configurations
      operationId: GetAllWebhooksConfigurations
      description: Retrieves a list of all configured webhooks for the Tenant, including detailed information about each webhook and its subscribed events.
      tags:
        - Webhooks
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscriptionResponse'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                WEBHOOK_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/WEBHOOK_FEATURE_NOT_ENABLED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WEBHOOK_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WEBHOOK_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    post:
      summary: Create webhook configuration
      operationId: CreateWebhookConfiguration
      description: Creates a new webhook configuration for the Tenant, allowing registration of a webhook with details such as the Target URL and subscribed events.
      tags:
        - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscriptionCreateModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscription'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                INVALID_WEBHOOK_EVENT_TYPE:
                  $ref: '#/components/examples/INVALID_WEBHOOK_EVENT_TYPE'
                WEB_HOOK_TARGET_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/WEB_HOOK_TARGET_URL_IS_NOT_VALID'
                WEB_HOOK_TARGET_URL_IS_NOT_REACHABLE:
                  $ref: '#/components/examples/WEB_HOOK_TARGET_URL_IS_NOT_REACHABLE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                WEBHOOK_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/WEBHOOK_FEATURE_NOT_ENABLED'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WEB_HOOK_TARGET_URL_IS_ALREADY_SUBSCRIBE:
                  $ref: '#/components/examples/WEB_HOOK_TARGET_URL_IS_ALREADY_SUBSCRIBE'
                WEB_HOOK_NOT_ALLOWED_MORE_THAN_MAX_LIMIT:
                  $ref: '#/components/examples/WEB_HOOK_NOT_ALLOWED_MORE_THAN_MAX_LIMIT'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/webhooks/{hookId}:
    get:
      summary: Retrieve webhook configuration
      operationId: GetWebhookConfigurationById
      description: Retrieves the details of a specific webhook configuration for the Tenant by its unique ID, including the Target URL, subscribed events, and other settings.
      tags:
        - Webhooks
      parameters:
        - $ref: '#/components/parameters/HookId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscription'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_WEBHOOK_ID:
                  $ref: '#/components/examples/INVALID_WEBHOOK_ID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                WEBHOOK_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/WEBHOOK_FEATURE_NOT_ENABLED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WEBHOOK_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WEBHOOK_CONFIG_NOT_FOUND'
      security:
        - M2MBearerToken: []
    put:
      summary: Update webhook configuration
      operationId: UpdateWebhookConfigurationById
      description: Updates an existing webhook configuration for the Tenant by its unique ID, modifying details such as the Target URL, subscribed events, or other settings.
      tags:
        - Webhooks
      parameters:
        - $ref: '#/components/parameters/HookId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscriptionUpdateModel'
            examples:
              example1:
                summary: Example to update all the fields in webhook
                value:
                  TargetUrl: https://example.com/webhook
                  Name: Test Webhook
                  SecretName: xyz
                  Headers:
                    x-test-header: qa
                  QueryParams:
                    apikey: '123456'
                  Authentication:
                    AuthType: Basic
                    BasicAuth:
                      Username: admin
                      Password: password123
              example2:
                summary: Example to reset Headers, Query Params and Authentication
                value:
                  Headers: {}
                  QueryParams: {}
                  TargetUrl: https://example.com/webhook
                  Authentication:
                    AuthType: Basic
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscription'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_WEBHOOK_ID:
                  $ref: '#/components/examples/INVALID_WEBHOOK_ID'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                WEB_HOOK_TARGET_URL_IS_NOT_VALID:
                  $ref: '#/components/examples/WEB_HOOK_TARGET_URL_IS_NOT_VALID'
                WEB_HOOK_TARGET_URL_IS_NOT_REACHABLE:
                  $ref: '#/components/examples/WEB_HOOK_TARGET_URL_IS_NOT_REACHABLE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                WEBHOOK_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/WEBHOOK_FEATURE_NOT_ENABLED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WEBHOOK_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WEBHOOK_CONFIG_NOT_FOUND'
                CANNOT_UPDATE_WEBHOOK:
                  $ref: '#/components/examples/CANNOT_UPDATE_WEBHOOK'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WEB_HOOK_TARGET_URL_IS_ALREADY_SUBSCRIBE:
                  $ref: '#/components/examples/WEB_HOOK_TARGET_URL_IS_ALREADY_SUBSCRIBE'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    delete:
      summary: Delete webhook configuration
      operationId: DeleteWebhookConfigurationById
      description: Deletes a specific webhook configuration for the Tenant using its unique ID, permanently removing the webhook from receiving further event notifications.
      tags:
        - Webhooks
      parameters:
        - $ref: '#/components/parameters/HookId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_WEBHOOK_ID:
                  $ref: '#/components/examples/INVALID_WEBHOOK_ID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                WEBHOOK_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/WEBHOOK_FEATURE_NOT_ENABLED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                WEBHOOK_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/WEBHOOK_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/webhooks/events:
    get:
      summary: List webhook events
      operationId: GetAllEvents
      description: Retrieves a list of all available webhook events that can be subscribed to by the Tenant for configuring webhooks to receive notifications for specific activities.
      tags:
        - Webhooks
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEvents'
              examples:
                WEBHOOK_EVENTS:
                  $ref: '#/components/examples/WEBHOOK_EVENTS'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                WEBHOOK_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/WEBHOOK_FEATURE_NOT_ENABLED'
      security:
        - M2MBearerToken: []
  /v2/manage/smstemplates:
    get:
      summary: List SMS templates
      description: Retrieves a list of SMS templates for a specified customer and Tenant.
      operationId: GetSmsTemplates
      tags:
        - SMS Templates
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SmsTemplate'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    post:
      summary: Create SMS template
      description: Creates a new SMS template for a specified customer and Tenant.
      operationId: CreateSmsTemplate
      tags:
        - SMS Templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsTemplate'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsTemplate'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                INVALID_SMS_TYPE:
                  $ref: '#/components/examples/INVALID_SMS_TYPE'
        '403':
          description: Forbidden due to invalid request body or SMS configuration details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SMS_TEMPLATE_EXISTS:
                  $ref: '#/components/examples/SMS_TEMPLATE_ALREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/sms-templates/{templateType}:
    put:
      summary: Update SMS template
      description: Updates an existing SMS template by its type for a specified customer and Tenant.
      operationId: UpdateSmsTemplate
      tags:
        - SMS Templates
      parameters:
        - $ref: '#/components/parameters/SmsTemplateType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSmsTemplateModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsTemplate'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                INVALID_SMS_TYPE:
                  $ref: '#/components/examples/INVALID_SMS_TYPE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SMS_TEMPLATE_NOT_FOUND:
                  $ref: '#/components/examples/SMS_TEMPLATE_NOT_FOUND'
                SMS_TEMPLATE_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_TEMPLATE_NOT_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    delete:
      summary: Delete SMS template
      description: Deletes an SMS template by its type for a specified customer and Tenant.
      operationId: DeleteSmsTemplate
      tags:
        - SMS Templates
      parameters:
        - $ref: '#/components/parameters/SmsTemplateType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSmsTemplateModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_SMS_TYPE:
                  $ref: '#/components/examples/INVALID_SMS_TYPE'
                JSON_DELETE_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_DELETE_BODY_REQUIRED'
        '403':
          description: Forbidden due to invalid request body or SMS configuration details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SMS_TEMPLATE_NOT_FOUND:
                  $ref: '#/components/examples/SMS_TEMPLATE_NOT_FOUND'
                SMS_TEMPLATE_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_TEMPLATE_NOT_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/passkey:
    get:
      summary: Retrieve Passkey configuration
      description: Retrieves the current Passkey configuration settings for the Tenant.
      operationId: getPassKeyConfig
      tags:
        - Passkey Configuration
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PassKeyConfig'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                PASSKEY_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/PASSKEY_FEATURE_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PASSKEY_NOT_FOUND:
                  $ref: '#/components/examples/PASSKEY_NOT_FOUND'
      security:
        - M2MBearerToken: []
    put:
      summary: Update Passkey configuration
      description: Creates or updates the Passkey configuration settings for the Tenant.
      operationId: upsertPassKeyConfig
      tags:
        - Passkey Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PassKeyConfig'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PassKeyConfig'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                INVALID_PASSKEY_SELECTION:
                  $ref: '#/components/examples/INVALID_PASSKEY_SELECTION'
                INVALID_PASSKEY_ATTESTATION:
                  $ref: '#/components/examples/INVALID_PASSKEY_ATTESTATION'
                INVALID_RP_ORIGIN_URL:
                  $ref: '#/components/examples/INVALID_RP_ORIGIN_URL'
                RP_ORIGIN_RPID_MISMATCH:
                  $ref: '#/components/examples/RP_ORIGIN_RPID_MISMATCH'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                PASSKEY_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/PASSKEY_FEATURE_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/2fa/push-notification-settings:
    get:
      summary: Retrieve Push Notification settings
      description: Retrieves the current Push Notification settings for second factor authentication.
      operationId: getPushSettings
      tags:
        - Push Notification Configuration
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushAuthenticator'
              examples:
                PUSH_AUTHENTICATOR_EXAMPLE:
                  $ref: '#/components/examples/PUSH_AUTHENTICATOR_EXAMPLE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED'
                PUSH_NOTIFICATIONS_NOT_ENABLED:
                  $ref: '#/components/examples/PUSH_NOTIFICATIONS_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PUSH_SETTINGS_NOT_FOUND:
                  $ref: '#/components/examples/PUSH_SETTINGS_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    post:
      summary: Create Push Notification settings
      description: Creates new Push Notification settings for second factor authentication.
      operationId: createPushSettings
      tags:
        - Push Notification Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushAuthenticator'
            examples:
              PUSH_AUTHENTICATOR_EXAMPLE:
                $ref: '#/components/examples/PUSH_AUTHENTICATOR_EXAMPLE'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushAuthenticator'
              examples:
                PUSH_AUTHENTICATOR_EXAMPLE:
                  $ref: '#/components/examples/PUSH_AUTHENTICATOR_EXAMPLE'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                INVALID_NOTIFICATION_SERVICE_CUSTOM:
                  $ref: '#/components/examples/INVALID_NOTIFICATION_SERVICE_CUSTOM'
                ATLEAST_ANDORID_OR_IOS_ENABLED:
                  $ref: '#/components/examples/ATLEAST_ANDORID_OR_IOS_ENABLED'
                INVALID_NOTIFICATION_SERVICE:
                  $ref: '#/components/examples/INVALID_NOTIFICATION_SERVICE'
                INVALID_IOS_ENVIRONMENT:
                  $ref: '#/components/examples/INVALID_IOS_ENVIRONMENT'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED'
                PUSH_NOTIFICATIONS_NOT_ENABLED:
                  $ref: '#/components/examples/PUSH_NOTIFICATIONS_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    put:
      summary: Update Push Notification settings
      description: Updates existing Push Notification settings for second factor authentication.
      operationId: updatePushSettings
      tags:
        - Push Notification Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushAuthenticator'
            examples:
              PUSH_AUTHENTICATOR_EXAMPLE:
                $ref: '#/components/examples/PUSH_AUTHENTICATOR_EXAMPLE'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushAuthenticator'
              examples:
                PUSH_AUTHENTICATOR_EXAMPLE:
                  $ref: '#/components/examples/PUSH_AUTHENTICATOR_EXAMPLE'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                ATLEAST_ANDORID_OR_IOS_ENABLED:
                  $ref: '#/components/examples/ATLEAST_ANDORID_OR_IOS_ENABLED'
                INVALID_NOTIFICATION_SERVICE:
                  $ref: '#/components/examples/INVALID_NOTIFICATION_SERVICE'
                INVALID_IOS_ENVIRONMENT:
                  $ref: '#/components/examples/INVALID_IOS_ENVIRONMENT'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED'
                PUSH_NOTIFICATIONS_NOT_ENABLED:
                  $ref: '#/components/examples/PUSH_NOTIFICATIONS_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PUSH_SETTINGS_NOT_FOUND:
                  $ref: '#/components/examples/PUSH_SETTINGS_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/security-questions:
    get:
      summary: Retrieve security questions
      description: Retrieves a list of all available security questions for the Tenant.
      tags:
        - Security Questions
      operationId: getSecurityQuestions
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SecurityQuestion'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECURITY_QUESTION_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_ENABLED'
      security:
        - M2MBearerToken: []
    post:
      summary: Add security question
      description: Adds a new security question to the Tenant's configuration.
      tags:
        - Security Questions
      operationId: addSecurityQuestion
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityQuestionInput'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityQuestion'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECURITY_QUESTION_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_ENABLED'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SECURITY_QUESTION_ALREADY_ADDED:
                  $ref: '#/components/examples/SECURITY_QUESTION_ALREADY_ADDED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/security-questions/{securityQuestionID}:
    put:
      summary: Update security question
      description: Updates an existing security question by its ID.
      tags:
        - Security Questions
      operationId: updateSecurityQuestion
      parameters:
        - $ref: '#/components/parameters/SecurityQuestionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityQuestionInput'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityQuestion'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                INVALID_QUESTION_ID:
                  $ref: '#/components/examples/INVALID_QUESTION_ID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECURITY_QUESTION_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SECURITY_QUESTION_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SECURITY_QUESTION_CONFIG_NOT_FOUND'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SECURITY_QUESTION_ALREADY_ADDED:
                  $ref: '#/components/examples/SECURITY_QUESTION_ALREADY_ADDED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    delete:
      summary: Delete security question
      description: Deletes a security question by its ID.
      tags:
        - Security Questions
      operationId: deleteSecurityQuestion
      parameters:
        - $ref: '#/components/parameters/SecurityQuestionId'
      responses:
        '200':
          description: Deletion status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_QUESTION_ID:
                  $ref: '#/components/examples/INVALID_QUESTION_ID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECURITY_QUESTION_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SECURITY_QUESTION_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SECURITY_QUESTION_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/security-questions/count:
    get:
      summary: Retrieve security question count
      description: Retrieves the number of security questions to render for a User.
      operationId: getSecurityQuestionRenderCount
      tags:
        - Security Questions
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityQuestionsRender'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECURITY_QUESTION_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SECURITY_QUESTION_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SECURITY_QUESTION_CONFIG_NOT_FOUND'
      security:
        - M2MBearerToken: []
    put:
      summary: Update security question count
      description: Updates the number of security questions to render for a User.
      operationId: updateSecurityQuestionRenderCount
      tags:
        - Security Questions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityQuestionsRender'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityQuestionsRender'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECURITY_QUESTION_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SECURITY_QUESTION_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SECURITY_QUESTION_CONFIG_NOT_FOUND'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SECURITY_QUESTION_RENDER_COUNT_ERROR:
                  $ref: '#/components/examples/SECURITY_QUESTION_RENDER_COUNT_ERROR'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/restrictions/domain-access:
    get:
      summary: Retrieve Domain Access Restrictions
      operationId: GetDomainAccessRestrictionsByAppID
      description: Retrieves the domain access restrictions configured for the Tenant.
      tags:
        - Domain Access Restrictions
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAccessRestrictions'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                DOMAIN_WHITE_LISTING_NOT_ENABLED:
                  $ref: '#/components/examples/DOMAIN_WHITE_LISTING_NOT_ENABLED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DOMAIN_RESTRICTION_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/DOMAIN_RESTRICTION_CONFIG_NOT_FOUND'
      security:
        - M2MBearerToken: []
    put:
      summary: Update Domain Access Restrictions
      operationId: UpdateDomainAccessRestrictionsByAppID
      description: Updates the domain access restrictions for the Tenant.
      tags:
        - Domain Access Restrictions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainAccessRestrictions'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAccessRestrictions'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PUT_BODY_INVALID:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                DOMAIN_WHITE_LISTING_NOT_ENABLED:
                  $ref: '#/components/examples/DOMAIN_WHITE_LISTING_NOT_ENABLED'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SAME_DOMAIN_OR_EMAIL_CANNOT_EXIST_IN_BOTH_LIST:
                  $ref: '#/components/examples/SAME_DOMAIN_OR_EMAIL_CANNOT_EXIST_IN_BOTH_LIST'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/email-templates:
    get:
      summary: List Email templates
      description: Retrieves all Email templates configured for the Tenant.
      operationId: getEmailTemplates
      tags:
        - Email Templates
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmailTemplateResponse'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_TEMPLATE_NOT_CREATED:
                  $ref: '#/components/examples/EMAIL_TEMPLATE_NOT_CREATED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    post:
      summary: Create Email template
      description: Adds a new Email template to the Tenant's configuration.
      operationId: addEmailTemplate
      tags:
        - Email Templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailTemplateModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailTemplateResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_ALPHANUMERIC:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_ALPHANUMERIC'
                PARAMETER_NOT_WELL_FORMATTED_EMAIL:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_EMAIL'
                INVALID_FROM_EMAIL_OR_NAME:
                  $ref: '#/components/examples/INVALID_FROM_EMAIL_OR_NAME'
                INVALID_EMAIL_TYPE:
                  $ref: '#/components/examples/INVALID_EMAIL_TYPE'
                INVALID_EMAIL_TEMPLATES_INVALID_EMAIL_TYPE:
                  $ref: '#/components/examples/INVALID_EMAIL_TEMPLATES_INVALID_EMAIL_TYPE'
                INVALID_EMAIL_TEMPLATES_INVALID_TOKEN_TYPE:
                  $ref: '#/components/examples/INVALID_EMAIL_TEMPLATES_INVALID_TOKEN_TYPE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_TEMPLATE_EXISTS:
                  $ref: '#/components/examples/EMAIL_TEMPLATE_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/email-templates/{templateType}:
    put:
      summary: Update Email Template
      description: Updates the Email template for a specified Email template type within a specific Tenant.
      operationId: UpdateEmailTemplate
      tags:
        - Email Templates
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/EmailTemplateType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmailTemplate'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailTemplateResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_ALPHANUMERIC:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_ALPHANUMERIC'
                PARAMETER_NOT_WELL_FORMATTED_EMAIL:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_EMAIL'
                INVALID_FROM_EMAIL_OR_NAME:
                  $ref: '#/components/examples/INVALID_FROM_EMAIL_OR_NAME'
                INVALID_EMAIL_TYPE:
                  $ref: '#/components/examples/INVALID_EMAIL_TYPE'
                INVALID_EMAIL_TEMPLATES_INVALID_EMAIL_TYPE:
                  $ref: '#/components/examples/INVALID_EMAIL_TEMPLATES_INVALID_EMAIL_TYPE'
                INVALID_EMAIL_TEMPLATES_INVALID_TOKEN_TYPE:
                  $ref: '#/components/examples/INVALID_EMAIL_TEMPLATES_INVALID_TOKEN_TYPE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_TEMPLATE_NOT_CREATED:
                  $ref: '#/components/examples/EMAIL_TEMPLATE_NOT_CREATED'
                EMAIL_TEMPLATE_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_TEMPLATE_NOT_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    delete:
      summary: Delete Email Template
      description: Deletes the Email template for a specified Email template type within a specific Tenant.
      operationId: deleteEmailTemplate
      tags:
        - Email Templates
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/EmailTemplateType'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEmailTemplate'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INVALID_EMAIL_TYPE:
                  $ref: '#/components/examples/INVALID_EMAIL_TYPE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EMAIL_TEMPLATE_NOT_EXISTS:
                  $ref: '#/components/examples/EMAIL_TEMPLATE_NOT_EXISTS'
                EMAIL_TEMPLATE_NOT_CREATED:
                  $ref: '#/components/examples/EMAIL_TEMPLATE_NOT_CREATED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/providers:
    get:
      summary: List social provider configurations
      operationId: GetAllProviderConfigurations
      description: Retrieves all social provider configurations available for the Tenant.
      tags:
        - Social Providers
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProviderConfigOptions'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
      security:
        - M2MBearerToken: []
    put:
      summary: Set social provider status
      operationId: SetProvidersStatus
      description: Sets the status of social providers for the Tenant.
      tags:
        - Social Providers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProviderStatusList'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Provider'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/providers/{provider}:
    get:
      summary: Retrieve social provider configuration
      operationId: GetSocialProviderByName
      description: Retrieves the social provider configuration for a specified provider name for the Tenant.
      tags:
        - Social Providers
      parameters:
        - $ref: '#/components/parameters/ProviderNamePath'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppProvider'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PROVIDER_NOT_CONFIGURED:
                  $ref: '#/components/examples/PROVIDER_NOT_CONFIGURED_PARTNER'
                PROVIDER_NOT_ACTIVE:
                  $ref: '#/components/examples/PROVIDER_NOT_ACTIVE'
      security:
        - M2MBearerToken: []
    delete:
      summary: Delete social provider configuration
      operationId: DeleteSocialProviderByName
      description: Deletes the social provider configuration for a specified provider name for the Tenant.
      tags:
        - Social Providers
      parameters:
        - $ref: '#/components/parameters/ProviderNamePath'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                PROVIDER_IS_NOT_SUPPORT_CONFIGURATION_SETTINGS:
                  $ref: '#/components/examples/PROVIDER_IS_NOT_SUPPORT_CONFIGURATION_SETTINGS'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PROVIDER_NOT_CONFIGURED:
                  $ref: '#/components/examples/PROVIDER_NOT_CONFIGURED_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    put:
      summary: Update social provider configuration
      operationId: UpdateSocialProviderByName
      description: Updates the social provider configuration for a specified provider name for the Tenant.
      tags:
        - Social Providers
      parameters:
        - $ref: '#/components/parameters/ProviderNamePath'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppProvider'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppProvider'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                PROVIDER_IS_NOT_SUPPORT_CONFIGURATION_SETTINGS:
                  $ref: '#/components/examples/PROVIDER_IS_NOT_SUPPORT_CONFIGURATION_SETTINGS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/providers/setorder:
    put:
      summary: Set social provider order
      operationId: SetProvidersOrder
      description: Sets the order of social providers for the Tenant to be listed in the UI.
      tags:
        - Social Providers
      requestBody:
        content:
          application/json:
            schema:
              properties:
                Data:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      type: string
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PROVIDER_IS_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_IS_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/providers/active:
    get:
      summary: Retrieve enabled social providers
      operationId: GetEnabledProviders
      description: Retrieves a list of all enabled social providers for the Tenant.
      tags:
        - Social Providers
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Provider'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
      security:
        - M2MBearerToken: []
  /v2/manage/2fa/config:
    get:
      summary: Retrieve second factor configuration
      operationId: GetSecondFactorConfiguration
      description: Retrieves the second factor authentication configuration for the Tenant.
      tags:
        - Second Factor Configuration
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MFASettings'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
      security:
        - M2MBearerToken: []
    put:
      summary: Update second factor configuration
      operationId: UpdateSecondFactorConfiguration
      description: Updates the second factor authentication configuration for the Tenant.
      tags:
        - Second Factor Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MFASettings'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MFASettings'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                ATLEAST_ONE_MFA:
                  $ref: '#/components/examples/ATLEAST_ONE_MFA'
                PUSH_NOTIFICATIONS_NOT_ENABLED:
                  $ref: '#/components/examples/PUSH_NOTIFICATIONS_NOT_ENABLED'
                DUO_AUTH_NOT_ENABLED:
                  $ref: '#/components/examples/DUO_AUTH_NOT_ENABLED_PARTNER'
                SECURITY_QUESTION_NOT_ENABLED:
                  $ref: '#/components/examples/SECURITY_QUESTION_NOT_ENABLED'
                PASSKEY_FEATURE_NOT_ENABLED:
                  $ref: '#/components/examples/PASSKEY_FEATURE_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/2fa/totp-authenticator-settings:
    get:
      summary: Retrieve TOTP configuration
      operationId: GetTOTPConfiguration
      description: Retrieves the Time-based One Time Password (TOTP) configuration for a specific Tenant.
      tags:
        - Second Factor Configuration
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleAuthenticator'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GOOGLE_AUTHENTICATOR_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/GOOGLE_AUTHENTICATOR_CONFIG_NOT_FOUND'
      security:
        - M2MBearerToken: []
    put:
      summary: Update TOTP configuration
      operationId: UpdateTOTPConfiguration
      description: Updates the Time-based One Time Password (TOTP) configuration for a specific Tenant.
      tags:
        - Second Factor Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleAuthenticator'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleAuthenticator'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/2fa/duo-authenticator-settings:
    get:
      summary: Retrieve Duo configuration
      operationId: GetDuoAuthenticatorConfiguration
      description: Retrieves the Duo Authentication configuration for a specific Tenant.
      tags:
        - Second Factor Configuration
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuoSecurityAuthenticator'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED'
                ENABLE_DUO_SECURITY_AUTHENTICATOR:
                  $ref: '#/components/examples/DUO_AUTH_NOT_ENABLED_PARTNER'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DUO_AUTH_SETTINGS_NOT_FOUND:
                  $ref: '#/components/examples/DUO_AUTH_SETTINGS_NOT_FOUND'
      security:
        - M2MBearerToken: []
    put:
      summary: Update Duo configuration
      operationId: UpdateDuoAuthenticatorConfiguration
      description: Updates the Duo Authentication configuration for a specific Tenant.
      tags:
        - Second Factor Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DuoSecurityAuthenticator'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuoSecurityAuthenticator'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED:
                  $ref: '#/components/examples/SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED'
                ENABLE_DUO_SECURITY_AUTHENTICATOR:
                  $ref: '#/components/examples/DUO_AUTH_NOT_ENABLED_PARTNER'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/captcha:
    get:
      summary: Retrieve captcha configuration
      operationId: GetCaptchaConfiguration
      description: Retrieves the captcha configuration settings for a specific Tenant.
      tags:
        - Captcha Configuration
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptchaConfig'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
      security:
        - M2MBearerToken: []
    put:
      summary: Update captcha configuration
      operationId: UpdateCaptchaConfiguration
      description: Updates the captcha configuration settings for a specific Tenant.
      tags:
        - Captcha Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaptchaConfig'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptchaConfig'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_INVALID:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CAPTCHA_CONFIG_VALUE_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_CONFIG_VALUE_NOT_VALID'
                CAPTCHA_THRESHOLD_INVALID:
                  $ref: '#/components/examples/CAPTCHA_THRESHOLD_INVALID'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/restrictions/ip-access:
    get:
      summary: Retrieve IP Access Restrictions
      operationId: GetIPAccessRestrictions
      description: Retrieves the IP access restrictions configured for a specific Tenant.
      tags:
        - IP Access Restrictions
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPAccessRestrictions'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IP_AUTHORIZATION_DISABLED:
                  $ref: '#/components/examples/IP_AUTHORIZATION_DISABLED'
      security:
        - M2MBearerToken: []
    put:
      summary: Update IP Access Restrictions
      operationId: UpdateIPAccessRestrictions
      description: Updates the IP access restrictions for a specific Tenant.
      tags:
        - IP Access Restrictions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPAccessRestrictions'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPAccessRestrictions'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                SPECIAL_CHARACTERS_NOT_ALLOWED:
                  $ref: '#/components/examples/SPECIAL_CHARACTERS_NOT_ALLOWED'
                INVALID_IP_ADDRESS:
                  $ref: '#/components/examples/INVALID_IP_ADDRESS'
                SAME_START_AND_END:
                  $ref: '#/components/examples/SAME_START_AND_END'
                INVALID_IP_ADDRESS_RANGE:
                  $ref: '#/components/examples/INVALID_IP_ADDRESS_RANGE'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IP_AUTHORIZATION_DISABLED:
                  $ref: '#/components/examples/IP_AUTHORIZATION_DISABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    delete:
      summary: Reset IP Access Restrictions
      operationId: ResetIPAccessRestrictions
      description: Resets the IP access restrictions to their default state.
      tags:
        - IP Access Restrictions
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                IP_AUTHORIZATION_DISABLED:
                  $ref: '#/components/examples/IP_AUTHORIZATION_DISABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/jwt-clients:
    get:
      summary: List JWT IdP clients
      operationId: GetAllJwtClientIdPConfigurations
      description: Retrieves a list of all configured JWT-based Identity Provider (IdP) integrations for the Tenant, including algorithms, mapping, endpoints, and settings used for authentication and federation.
      tags:
        - JWT Clients
      security:
        - M2MBearerToken: []
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/JwtClientIdpResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    post:
      summary: Create JWT IdP configuration
      operationId: CreateJwtIdPConfiguration
      description: Creates a new JWT-based Identity Provider (IdP) configuration for the Tenant by specifying algorithms, mapping, and endpoint information, enabling authentication and federation with the specified IdP.
      tags:
        - JWT Clients
      security:
        - M2MBearerToken: []
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    AppName:
                      type: string
                  required:
                    - AppName
                    - Algo
                    - Secret
                - $ref: '#/components/schemas/JwtClientIdpRequest'
        required: true
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JwtClientIdpResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                SSO_APPNAME_REQUIRED:
                  $ref: '#/components/examples/SSO_APPNAME_REQUIRED'
                SSO_APPNAME_LENGTH_EXCEEDED:
                  $ref: '#/components/examples/SSO_APPNAME_LENGTH_EXCEEDED'
                SSO_APPNAME_INVALID:
                  $ref: '#/components/examples/SSO_APPNAME_INVALID'
                JWT_ALOGITHM_REQUIRED:
                  $ref: '#/components/examples/JWT_ALOGITHM_REQUIRED'
                JWT_ALOGRITHM_INVALID:
                  $ref: '#/components/examples/JWT_ALOGRITHM_INVALID'
                JWT_RESPONSE_MODE_INVALID:
                  $ref: '#/components/examples/JWT_RESPONSE_MODE_INVALID'
                JWT_QUERY_STRING_PARAMETER_INVALID:
                  $ref: '#/components/examples/JWT_QUERY_STRING_PARAMETER_INVALID'
                JWT_LOGIN_URL_INVALID:
                  $ref: '#/components/examples/JWT_LOGIN_URL_INVALID'
                JWT_EXPIRY_TIME_INVALID:
                  $ref: '#/components/examples/JWT_EXPIRY_TIME_INVALID'
                JWT_NOT_BEFORE_INVALID:
                  $ref: '#/components/examples/JWT_NOT_BEFORE_INVALID'
                JWT_NOT_BEFORE_LESS_THAN_EXPIRY:
                  $ref: '#/components/examples/JWT_NOT_BEFORE_LESS_THAN_EXPIRY'
                JWT_SECRET_REQUIRED:
                  $ref: '#/components/examples/JWT_SECRET_REQUIRED'
                JWT_SECRET_INVALID:
                  $ref: '#/components/examples/JWT_SECRET_INVALID'
                JWT_MAPPING_REQUIRED:
                  $ref: '#/components/examples/JWT_MAPPING_REQUIRED'
                JWT_MAPPING_INVALID:
                  $ref: '#/components/examples/JWT_MAPPING_INVALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_ALREADY_EXIST:
                  $ref: '#/components/examples/JWT_CONFIG_ALREADY_EXIST'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/jwt-clients/{jwtClientName}:
    delete:
      summary: Delete JWT IdP configuration
      operationId: DeleteJwtClientIdP
      description: Deletes an existing JWT-based Identity Provider (IdP) configuration for the Tenant using its AppName, permanently disabling authentication and federation with that IdP.
      tags:
        - JWT Clients
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/jwtClientName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    get:
      summary: Retrieve JWT IdP configuration
      operationId: GetJwtClientIdPConfigurationByAppName
      description: Retrieves the details of a specific JWT-based Identity Provider (IdP) configuration for the Tenant using the AppName, including algorithms, mapping, and endpoints associated with the application.
      tags:
        - JWT Clients
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/jwtClientName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JwtClientIdpResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    put:
      summary: Update JWT IdP configuration
      operationId: UpdateJwtClientIdPConfigurationByAppName
      description: Updates an existing JWT-based Identity Provider (IdP) configuration for the Tenant identified by the AppName, modifying details such as algorithms, mapping, or endpoint information.
      tags:
        - JWT Clients
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/jwtClientName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JwtClientIdpBaseModel'
        required: true
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JwtClientIdpResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                JWT_ALOGRITHM_INVALID:
                  $ref: '#/components/examples/JWT_ALOGRITHM_INVALID'
                JWT_RESPONSE_MODE_INVALID:
                  $ref: '#/components/examples/JWT_RESPONSE_MODE_INVALID'
                JWT_QUERY_STRING_PARAMETER_INVALID:
                  $ref: '#/components/examples/JWT_QUERY_STRING_PARAMETER_INVALID'
                JWT_LOGIN_URL_INVALID:
                  $ref: '#/components/examples/JWT_LOGIN_URL_INVALID'
                JWT_EXPIRY_TIME_INVALID:
                  $ref: '#/components/examples/JWT_EXPIRY_TIME_INVALID'
                JWT_NOT_BEFORE_INVALID:
                  $ref: '#/components/examples/JWT_NOT_BEFORE_INVALID'
                JWT_NOT_BEFORE_LESS_THAN_EXPIRY:
                  $ref: '#/components/examples/JWT_NOT_BEFORE_LESS_THAN_EXPIRY'
                JWT_SECRET_INVALID:
                  $ref: '#/components/examples/JWT_SECRET_INVALID'
                JWT_MAPPING_INVALID:
                  $ref: '#/components/examples/JWT_MAPPING_INVALID'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/jwt-clients/algo:
    get:
      summary: List supported JWT algorithms
      operationId: GetJwtClientSupportedAlgoList
      tags:
        - JWT Clients
      security:
        - M2MBearerToken: []
      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.
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      type: string
  /v2/manage/jwt-clients/data-mapping:
    get:
      summary: List JWT data mapping fields
      operationId: GetJwtClientDataMappingFieldsList
      description: Retrieves a list of available data mapping fields that can be used when configuring JWT-based Identity Provider (IdP) integrations for the Tenant, including all supported fields for mapping JWT claims to User profile attributes.
      tags:
        - JWT Clients
      security:
        - M2MBearerToken: []
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      type: string
  /v2/manage/custom-providers/jwt:
    get:
      summary: List JWT SP configurations
      operationId: GetAllJwtConfigSPConfigurations
      description: Retrieves a list of all Service Provider (SP) configurations associated with JWT clients for the Tenant, including endpoints, mapping, and other settings for each SP setup.
      tags:
        - JWT Custom Providers
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/JwtSpConfig'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    post:
      summary: Create JWT SP configuration
      operationId: CreateJwtSPClientConfiguration
      description: Creates a new Service Provider (SP) configuration for a JWT client in the Tenant, defining details such as endpoints, mapping, and other required settings.
      tags:
        - JWT Custom Providers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    AppName:
                      type: string
                      example: MyApp
                  required:
                    - AppName
                    - Algo
                    - Mapping
                - $ref: '#/components/schemas/JwtSpConfigBaseModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JwtSpConfig'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                RAAS_UPDATE_FIELDS_INVALID:
                  $ref: '#/components/examples/RAAS_UPDATE_FIELDS_INVALID'
                SSO_MAPPING_INVALID_JWT_SP:
                  $ref: '#/components/examples/SSO_MAPPING_INVALID_JWT_SP'
                ID_MAPPING_REQUIRED:
                  $ref: '#/components/examples/ID_MAPPING_REQUIRED'
                SSO_MAPPING_REQUIRED_JWT_SP:
                  $ref: '#/components/examples/SSO_MAPPING_REQUIRED_JWT_SP'
                JWT_CLOCK_SKEW_INVALID:
                  $ref: '#/components/examples/JWT_CLOCK_SKEW_INVALID'
                JWT_AUDIENCE_REQUIRED:
                  $ref: '#/components/examples/JWT_AUDIENCE_REQUIRED'
                JWT_ISSUER_REQUIRED:
                  $ref: '#/components/examples/JWT_ISSUER_REQUIRED'
                AUTO_LOOKUP_DOMAIN_INVALID:
                  $ref: '#/components/examples/AUTO_LOOKUP_DOMAIN_INVALID'
                DOMAIN_NAME_IS_REQUIRED_JWT_SP:
                  $ref: '#/components/examples/DOMAIN_NAME_IS_REQUIRED_JWT_SP'
                JWT_JWKSURL_INVALID:
                  $ref: '#/components/examples/JWT_JWKSURL_INVALID'
                JWT_KEY_INVALID:
                  $ref: '#/components/examples/JWT_KEY_INVALID'
                JWT_LOGIN_URL_INVALID_JWT_SP:
                  $ref: '#/components/examples/JWT_LOGIN_URL_INVALID_JWT_SP'
                JWT_ALOGRITHM_INVALID:
                  $ref: '#/components/examples/JWT_ALOGRITHM_INVALID'
                JWT_ALGORITHM_REQUIRED:
                  $ref: '#/components/examples/JWT_ALGORITHM_REQUIRED'
                SSO_APPNAME_INVALID_JWT_SP:
                  $ref: '#/components/examples/SSO_APPNAME_INVALID_JWT_SP'
                SSO_APPNAME_REQUIRED_JWT_SP:
                  $ref: '#/components/examples/SSO_APPNAME_REQUIRED_JWT_SP'
                SSO_APPNAME_LENGTH_EXCEEDED_JWT_SP:
                  $ref: '#/components/examples/SSO_APPNAME_LENGTH_EXCEEDED_JWT_SP'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MISSING_JWKSURL:
                  $ref: '#/components/examples/MISSING_JWKSURL'
                MISSING_JWT_KEY:
                  $ref: '#/components/examples/MISSING_JWT_KEY'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_ALREADY_EXIST:
                  $ref: '#/components/examples/JWT_CONFIG_ALREADY_EXIST'
                DOMAIN_NAME_ALREADY_EXISTS:
                  $ref: '#/components/examples/DOMAIN_NAME_ALREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/custom-providers/jwt/{jwtApp}:
    get:
      summary: Retrieve JWT SP configuration
      operationId: GetJwtSPClientConfigurationByAppName
      description: Retrieves the Service Provider (SP) configuration details for a JWT client in the Tenant using the AppName, including endpoints, mapping, and other configured settings.
      tags:
        - JWT Custom Providers
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/jwtApp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JwtSpConfig'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    put:
      summary: Update JWT SP configuration
      operationId: UpdateJwtSPClientConfigurationByAppName
      description: Updates an existing Service Provider (SP) configuration for a JWT client in the Tenant identified by the AppName, modifying settings such as endpoints, mapping, or other configuration details.
      tags:
        - JWT Custom Providers
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/jwtApp'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JwtSpConfigBaseModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JwtSpConfig'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                RAAS_UPDATE_FIELDS_INVALID:
                  $ref: '#/components/examples/RAAS_UPDATE_FIELDS_INVALID'
                SSO_MAPPING_INVALID_JWT_SP:
                  $ref: '#/components/examples/SSO_MAPPING_INVALID_JWT_SP'
                ID_MAPPING_REQUIRED:
                  $ref: '#/components/examples/ID_MAPPING_REQUIRED'
                SSO_MAPPING_REQUIRED_JWT_SP:
                  $ref: '#/components/examples/SSO_MAPPING_REQUIRED_JWT_SP'
                JWT_CLOCK_SKEW_INVALID:
                  $ref: '#/components/examples/JWT_CLOCK_SKEW_INVALID'
                JWT_AUDIENCE_REQUIRED:
                  $ref: '#/components/examples/JWT_AUDIENCE_REQUIRED'
                JWT_ISSUER_REQUIRED:
                  $ref: '#/components/examples/JWT_ISSUER_REQUIRED'
                AUTO_LOOKUP_DOMAIN_INVALID:
                  $ref: '#/components/examples/AUTO_LOOKUP_DOMAIN_INVALID'
                DOMAIN_NAME_IS_REQUIRED_JWT_SP:
                  $ref: '#/components/examples/DOMAIN_NAME_IS_REQUIRED_JWT_SP'
                JWT_JWKSURL_INVALID:
                  $ref: '#/components/examples/JWT_JWKSURL_INVALID'
                JWT_KEY_INVALID:
                  $ref: '#/components/examples/JWT_KEY_INVALID'
                JWT_LOGIN_URL_INVALID_JWT_SP:
                  $ref: '#/components/examples/JWT_LOGIN_URL_INVALID_JWT_SP'
                JWT_ALOGRITHM_INVALID:
                  $ref: '#/components/examples/JWT_ALOGRITHM_INVALID'
                JWT_ALGORITHM_REQUIRED:
                  $ref: '#/components/examples/JWT_ALGORITHM_REQUIRED'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND'
                MISSING_JWKSURL:
                  $ref: '#/components/examples/MISSING_JWKSURL'
                MISSING_JWT_KEY:
                  $ref: '#/components/examples/MISSING_JWT_KEY'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DOMAIN_NAME_ALREADY_EXISTS:
                  $ref: '#/components/examples/DOMAIN_NAME_ALREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    delete:
      summary: Delete JWT SP configuration
      operationId: DeleteJwtSPClientConfigurationByAppName
      description: Deletes the Service Provider (SP) configuration for a JWT client in the Tenant identified by the AppName, permanently disabling the application's service provider integration.
      tags:
        - JWT Custom Providers
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/jwtApp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/saml-clients:
    get:
      summary: List SAML IdP Integrations
      description: Retrieves a list of all configured SAML-based Identity Provider integrations for the Tenant, including metadata and settings for authentication.
      operationId: GetAllSamlClientIdPConfigurations
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  Data:
                    items:
                      $ref: '#/components/schemas/SamlClientIdpResponse'
                    type: array
          description: 'OK: The request was successful.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          content:
            application/json:
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Not Found: The server cannot find the requested resource.'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      tags:
        - SAML Clients
      security:
        - M2MBearerToken: []
    post:
      description: Creates a new SAML-based Identity Provider configuration for the Tenant, enabling authentication and federation with the specified IdP.
      operationId: CreateSamlClientIdPConfiguration
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    AppName:
                      type: string
                  required:
                    - AppName
                - $ref: '#/components/schemas/SamlClientIdpRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SamlClientIdpResponse'
          description: 'OK: The request was successful.'
        '400':
          content:
            application/json:
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                SSO_APPNAME_REQUIRED_SAML:
                  $ref: '#/components/examples/SSO_APPNAME_REQUIRED_SAML'
                SSO_APPNAME_LENGTH_EXCEEDED_SAML:
                  $ref: '#/components/examples/SSO_APPNAME_LENGTH_EXCEEDED_SAML'
                SSO_APPNAME_INVALID_SAML:
                  $ref: '#/components/examples/SSO_APPNAME_INVALID_SAML'
                SAML_IDP_LOCATION_BINDING_REQUIRED:
                  $ref: '#/components/examples/SAML_IDP_LOCATION_BINDING_REQUIRED'
                SAML_IDP_BINDING_INVALID:
                  $ref: '#/components/examples/SAML_IDP_BINDING_INVALID'
                SAML_IDP_LOCATION_REQUIRED:
                  $ref: '#/components/examples/SAML_IDP_LOCATION_REQUIRED'
                SAML_IDP_LOCATION_INVALID:
                  $ref: '#/components/examples/SAML_IDP_LOCATION_INVALID'
                SAML_SP_LOGOUT_URI_REQUIRED_IDP:
                  $ref: '#/components/examples/SAML_SP_LOGOUT_URI_REQUIRED_IDP'
                SAML_SP_LOGOUT_INVALID_IDP:
                  $ref: '#/components/examples/SAML_SP_LOGOUT_INVALID_IDP'
                SAML_LOGIN_URI_REQUIRED:
                  $ref: '#/components/examples/SAML_LOGIN_URI_REQUIRED'
                SAML_LOGIN_URI_INVALID:
                  $ref: '#/components/examples/SAML_LOGIN_URI_INVALID'
                SAML_AFTER_LOGOUT_URI_REQUIRED:
                  $ref: '#/components/examples/SAML_AFTER_LOGOUT_URI_REQUIRED'
                SAML_AFTER_LOGOUT_URI_INVALID:
                  $ref: '#/components/examples/SAML_AFTER_LOGOUT_URI_INVALID'
                SAML_SP_CERTIFICATE_INVALID:
                  $ref: '#/components/examples/SAML_SP_CERTIFICATE_INVALID'
                SAML_SP_CERTIFICATE_REQUIRED:
                  $ref: '#/components/examples/SAML_SP_CERTIFICATE_REQUIRED'
                SAML_ATTRIBUTE_FORMAT_REQUIRED:
                  $ref: '#/components/examples/SAML_ATTRIBUTE_FORMAT_REQUIRED'
                SAML_AUDIENCE_REQUIRED:
                  $ref: '#/components/examples/SAML_AUDIENCE_REQUIRED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          content:
            application/json:
              examples:
                SAML_CONFIG_ALREADY_ADDED:
                  $ref: '#/components/examples/SAML_CONFIG_ALREADY_ADDED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Internal Server Error: The server encountered an unexpected error.'
      summary: Create SAML IdP Configuration
      tags:
        - SAML Clients
      security:
        - M2MBearerToken: []
  /v2/manage/saml-clients/{samlApp}:
    delete:
      description: Deletes the SAML-based Identity Provider configuration for the Tenant identified by the application name, disabling authentication for the specified application.
      operationId: DeleteSamlClientIdPConfigurationByAppName
      parameters:
        - $ref: '#/components/parameters/samlApp'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
          description: 'OK: The request was successful.'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Internal Server Error: The server encountered an unexpected error.'
      summary: Delete SAML IdP Configuration
      tags:
        - SAML Clients
      security:
        - M2MBearerToken: []
    get:
      description: Retrieves the SAML-based Identity Provider configuration details for the Tenant using the application name, including metadata and settings.
      operationId: GetSamlClientIdPConfigurationByAppName
      parameters:
        - $ref: '#/components/parameters/samlApp'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SamlClientIdpResponse'
          description: 'OK: The request was successful.'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Retrieve SAML IdP client configuration by app name
      tags:
        - SAML Clients
      security:
        - M2MBearerToken: []
    put:
      operationId: UpdateSamlClientIdPConfigurationByAppName
      description: Updates an existing SAML-based Identity Provider configuration for the Tenant identified by the application name, modifying necessary settings.
      parameters:
        - $ref: '#/components/parameters/samlApp'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SamlClientIdpRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SamlClientIdpResponse'
          description: 'OK: The request was successful.'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                SAML_IDP_BINDING_INVALID:
                  $ref: '#/components/examples/SAML_IDP_BINDING_INVALID'
                SAML_IDP_LOCATION_INVALID:
                  $ref: '#/components/examples/SAML_IDP_LOCATION_INVALID'
                SAML_SP_LOGOUT_INVALID_IDP:
                  $ref: '#/components/examples/SAML_SP_LOGOUT_INVALID_IDP'
                SAML_LOGIN_URI_INVALID:
                  $ref: '#/components/examples/SAML_LOGIN_URI_INVALID'
                SAML_AFTER_LOGOUT_URI_INVALID:
                  $ref: '#/components/examples/SAML_AFTER_LOGOUT_URI_INVALID'
                SAML_SP_CERTIFICATE_INVALID:
                  $ref: '#/components/examples/SAML_SP_CERTIFICATE_INVALID'
                SAML_ATTRIBUTE_FORMAT_REQUIRED:
                  $ref: '#/components/examples/SAML_ATTRIBUTE_FORMAT_REQUIRED'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Update SAML IdP client configuration by app name
      tags:
        - SAML Clients
      security:
        - M2MBearerToken: []
  /saml-clients/{samlApp}/renew-certificate:
    post:
      description: Renews the SAML Identity Provider certificate to replace an expiring or compromised signing certificate.
      operationId: RenewSAMLIdpCertificate
      parameters:
        - $ref: '#/components/parameters/samlApp'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SamlClientIdpResponse'
          description: 'OK: The request was successful.'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          content:
            application/json:
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Not Found: The server cannot find the requested resource.'
        '409':
          content:
            application/json:
              examples:
                SAML_CONFIG_ALREADY_ADDED:
                  $ref: '#/components/examples/SAML_CONFIG_ALREADY_ADDED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Internal Server Error: The server encountered an unexpected error.'
      summary: Renew SAML IdP Certificate
      tags:
        - SAML Clients
      security:
        - M2MBearerToken: []
  /v2/manage/custom-providers/saml:
    get:
      summary: List SAML SP Configurations
      operationId: GetAllSAMLSPClientConfigurations
      description: Retrieves a list of all Service Provider configurations for SAML clients within the Tenant, including details such as datamap, endpoints, and certificates.
      tags:
        - SAML Custom Providers
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SamlSpConfig'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
      security:
        - M2MBearerToken: []
    post:
      summary: Create SAML SP Configuration
      operationId: CreateSAMLSPClientConfiguration
      description: Creates a new Service Provider configuration for a SAML client within the Tenant, defining necessary settings for SAML authentication flows.
      tags:
        - SAML Custom Providers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SamlSpConfigModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SamlSpConfig'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                SAML_PROVIDR_NAME_INVALID:
                  $ref: '#/components/examples/SAML_PROVIDR_NAME_INVALID'
                SAML_PROVIDR_NAME_LENGTH_EXCEEDED:
                  $ref: '#/components/examples/SAML_PROVIDR_NAME_LENGTH_EXCEEDED'
                SSO_FRIENDLY_PROVIDER_NAME_INVALID:
                  $ref: '#/components/examples/SSO_FRIENDLY_PROVIDER_NAME_INVALID'
                SAML_IDP_CERTIFICATE_IS_REQUIRED:
                  $ref: '#/components/examples/SAML_IDP_CERTIFICATE_IS_REQUIRED'
                SAML_IDP_CERTIFICATE_INVALID:
                  $ref: '#/components/examples/SAML_IDP_CERTIFICATE_INVALID'
                SSO_MAPPING_INVALID:
                  $ref: '#/components/examples/SSO_MAPPING_INVALID'
                SSO_MAPPING_REQUIRED:
                  $ref: '#/components/examples/SSO_MAPPING_REQUIRED'
                INVALID_DOMAIN_NAME_SP:
                  $ref: '#/components/examples/INVALID_DOMAIN_NAME_SP'
                DOMAIN_NAME_IS_REQUIRED_SP:
                  $ref: '#/components/examples/DOMAIN_NAME_IS_REQUIRED_SP'
                SAML_SP_LOGOUT_INVALID:
                  $ref: '#/components/examples/SAML_SP_LOGOUT_INVALID'
                SAML_SP_LOCATION_INVALID:
                  $ref: '#/components/examples/SAML_SP_LOCATION_INVALID'
                SAML_SP_LOGOUT_REQUIRED:
                  $ref: '#/components/examples/SAML_SP_LOGOUT_REQUIRED'
                SAML_SP_LOCATION_REQUIRED:
                  $ref: '#/components/examples/SAML_SP_LOCATION_REQUIRED'
                SAML_SP_BINDING_INVALID:
                  $ref: '#/components/examples/SAML_SP_BINDING_INVALID'
                SAML_SP_LOCATION_LOGOUT_BINDING_REQUIRED:
                  $ref: '#/components/examples/SAML_SP_LOCATION_LOGOUT_BINDING_REQUIRED'
                SAML_PROVIDR_NAME_REQUIRED:
                  $ref: '#/components/examples/SAML_PROVIDR_NAME_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DOMAIN_NAME_ALREADY_EXISTS:
                  $ref: '#/components/examples/DOMAIN_NAME_ALREADY_EXISTS'
                SAML_CONFIG_ALREADY_ADDED:
                  $ref: '#/components/examples/SAML_CONFIG_ALREADY_ADDED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/custom-providers/saml/keys:
    get:
      summary: Retrieve SAML SP Mapping Keys
      operationId: GetSamlSPClientMappingKeys
      description: Retrieves a list of mapping keys available for configuring attribute mappings in SAML Service Provider clients within the Tenant.
      tags:
        - SAML Custom Providers
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SamlKeys'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
      security:
        - M2MBearerToken: []
  /v2/manage/custom-providers/saml/{samlApp}:
    get:
      summary: Retrieve SAML SP Configuration
      operationId: GetSAMLSPClientConfigurationByAppName
      description: Retrieves the Service Provider configuration details for a SAML client within the Tenant, identified by the application name.
      tags:
        - SAML Custom Providers
      parameters:
        - $ref: '#/components/parameters/samlApp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SamlSpConfig'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    put:
      summary: Update SAML SP Configuration
      operationId: UpdateSAMLSPClientConfigurationByAppName
      description: Updates an existing Service Provider configuration for a SAML client within the Tenant, identified by the application name.
      tags:
        - SAML Custom Providers
      parameters:
        - $ref: '#/components/parameters/samlApp'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SamlSpConfigModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SamlSpConfig'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                SSO_FRIENDLY_PROVIDER_NAME_INVALID:
                  $ref: '#/components/examples/SSO_FRIENDLY_PROVIDER_NAME_INVALID'
                SAML_IDP_CERTIFICATE_INVALID:
                  $ref: '#/components/examples/SAML_IDP_CERTIFICATE_INVALID'
                SSO_MAPPING_INVALID:
                  $ref: '#/components/examples/SSO_MAPPING_INVALID'
                INVALID_DOMAIN_NAME_SP:
                  $ref: '#/components/examples/INVALID_DOMAIN_NAME_SP'
                DOMAIN_NAME_IS_REQUIRED_SP:
                  $ref: '#/components/examples/DOMAIN_NAME_IS_REQUIRED_SP'
                SAML_SP_LOGOUT_INVALID:
                  $ref: '#/components/examples/SAML_SP_LOGOUT_INVALID'
                SAML_SP_LOCATION_INVALID:
                  $ref: '#/components/examples/SAML_SP_LOCATION_INVALID'
                SAML_SP_BINDING_INVALID:
                  $ref: '#/components/examples/SAML_SP_BINDING_INVALID'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DOMAIN_NAME_ALREADY_EXISTS:
                  $ref: '#/components/examples/DOMAIN_NAME_ALREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    delete:
      summary: Delete SAML SP Configuration
      operationId: DeleteSAMLSPClientConfigurationByAppName
      description: Deletes the Service Provider configuration for a SAML client within the Tenant, identified by the application name.
      tags:
        - SAML Custom Providers
      parameters:
        - $ref: '#/components/parameters/samlApp'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/custom-providers/saml/{samlApp}/renew-certificate:
    post:
      description: Renews the SAML Service Provider certificate to replace an expiring or compromised certificate.
      operationId: RenewSAMLSppCertificate
      parameters:
        - $ref: '#/components/parameters/samlApp'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SamlSpConfig'
          description: 'OK: The request was successful.'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          content:
            application/json:
              examples:
                SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SAML_CONFIG_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Not Found: The server cannot find the requested resource.'
        '409':
          content:
            application/json:
              examples:
                SAML_CONFIG_ALREADY_ADDED:
                  $ref: '#/components/examples/SAML_CONFIG_ALREADY_ADDED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Conflict: The request could not be completed due to a conflict with the current state of the resource.'
        '500':
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Internal Server Error: The server encountered an unexpected error.'
      summary: Renew SAML SP Certificate
      tags:
        - SAML Custom Providers
      security:
        - M2MBearerToken: []
  /v2/manage/custom-fields:
    get:
      summary: List custom fields
      operationId: GetAllCustomFields
      description: Retrieves all Custom Fields created for the Tenant.
      tags:
        - Custom Fields
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RaasCustomField'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CUSTOM_FIELD_LIMIT_EXCEEDED:
                  $ref: '#/components/examples/CUSTOM_FIELD_LIMIT_EXCEEDED'
      security:
        - M2MBearerToken: []
    post:
      summary: Create custom field
      operationId: CreateCustomField
      description: Creates a new Custom Field for the Tenant.
      tags:
        - Custom Fields
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RaasCustomFieldModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RaasCustomField'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_FIELD_ALLREADY_EXISTS:
                  $ref: '#/components/examples/CUSTOM_FIELD_ALLREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    put:
      summary: Set custom field
      operationId: SetCustomField
      description: Updates or sets a Custom Field instance in RAAS to be displayed on forms for the Tenant.
      tags:
        - Custom Fields
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                Data:
                  type: array
                  items:
                    $ref: '#/components/schemas/RaasConfigData'
                  minLength: 1
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RaasConfig'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_FIELD_NOT_FOUND:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/custom-fields/{cfname}:
    delete:
      summary: Delete custom field
      operationId: DeleteCustomField
      description: Deletes a Custom Field by name for the Tenant.
      tags:
        - Custom Fields
      security:
        - M2MBearerToken: []
      parameters:
        - $ref: '#/components/parameters/CustomFieldsName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_FIELD_NOT_FOUND:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/custom-fields/list:
    get:
      summary: List custom fields
      operationId: ListCustomFields
      description: Retrieves all custom fields for the Tenant, returned as an array of strings.
      tags:
        - Custom Fields
      security:
        - M2MBearerToken: []
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      type: string
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOMER_REGISTRATION_CUSTOM_DATA_NOT_EXISTS:
                  $ref: '#/components/examples/CUSTOMER_REGISTRATION_CUSTOM_DATA_NOT_EXISTS'
  /v2/manage/custom-fields/active:
    get:
      summary: List active custom fields
      operationId: GetActiveCustomFields
      description: Retrieves all custom fields currently active in the registration form for the Tenant.
      tags:
        - Custom Fields
      security:
        - M2MBearerToken: []
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RaasConfig'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOMER_REGISTRATION_CUSTOM_DATA_NOT_EXISTS:
                  $ref: '#/components/examples/CUSTOMER_REGISTRATION_CUSTOM_DATA_NOT_EXISTS'
                CUSTOM_FIELD_NOT_FOUND:
                  $ref: '#/components/examples/CUSTOM_FIELD_NOT_FOUND'
  /v2/manage/custom-fields/limit:
    get:
      summary: Retrieve custom field limit
      operationId: GetCustomFieldLimit
      description: Retrieves the Custom Field Limit configured for the Tenant.
      tags:
        - Custom Fields
      security:
        - M2MBearerToken: []
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldLimitResponse'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /v2/manage/oauth-clients:
    get:
      description: Retrieves a comprehensive list of OAuth client configurations for the Tenant, including client IDs, redirect URIs, scopes, and other relevant settings.
      operationId: GetAllOAuthClientsConfigurations
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  Data:
                    items:
                      $ref: '#/components/schemas/OAuthClientResponse'
                    type: array
          description: 'OK: The request was successful.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '500':
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List OAuth clients
      tags:
        - OAuth Clients
      security:
        - M2MBearerToken: []
    post:
      description: Creates a new OAuth client configuration for the Tenant by specifying redirect URIs, scopes, and other necessary settings to enable OAuth authentication and authorization.
      operationId: CreateOAuthClientConfiguration
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    AppName:
                      type: string
                    Protocol:
                      type: string
                      enum:
                        - OAuth 2.0
                        - OpenID Connect 1.0
                  required:
                    - AppName
                    - Protocol
                    - ApplicationType
                    - TokenAuthMethod
                - $ref: '#/components/schemas/OAuthClientRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClientResponse'
          description: 'OK: The request was successful.'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                SSO_APPNAME_REQUIRED_OAUTH:
                  $ref: '#/components/examples/SSO_APPNAME_REQUIRED_OAUTH'
                SSO_APPNAME_LENGTH_EXCEEDED_OAUTH:
                  $ref: '#/components/examples/SSO_APPNAME_LENGTH_EXCEEDED_OAUTH'
                SSO_APPNAME_INVALID_OAUTH:
                  $ref: '#/components/examples/SSO_APPNAME_INVALID_OAUTH'
                OAUTH_AUDIENCE_SCOPES_INVALID:
                  $ref: '#/components/examples/OAUTH_AUDIENCE_SCOPES_INVALID'
                OAUTH_APPLICATION_TYPE_REQUIRED:
                  $ref: '#/components/examples/OAUTH_APPLICATION_TYPE_REQUIRED'
                OAUTH_APPLICATION_TYPE_INVALID:
                  $ref: '#/components/examples/OAUTH_APPLICATION_TYPE_INVALID'
                OAUTH_PROTOCOL_REQUIRED:
                  $ref: '#/components/examples/OAUTH_PROTOCOL_REQUIRED'
                OAUTH_PROTOCOL_INVALID:
                  $ref: '#/components/examples/OAUTH_PROTOCOL_INVALID'
                OAUTH_GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/OAUTH_GRANT_TYPE_INVALID'
                OAUTH_SERVICE_GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/OAUTH_SERVICE_GRANT_TYPE_INVALID'
                OAUTH_NON_SERVICE_GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/OAUTH_NON_SERVICE_GRANT_TYPE_INVALID'
                OAUTH_SCOPE_INVALID:
                  $ref: '#/components/examples/OAUTH_SCOPE_INVALID'
                OAUTH_TOKEN_AUTH_METHOD_INVALID:
                  $ref: '#/components/examples/OAUTH_TOKEN_AUTH_METHOD_INVALID'
                OAUTH_JWTCONFIG_TOKEN_TTL_INVALID:
                  $ref: '#/components/examples/OAUTH_JWTCONFIG_TOKEN_TTL_INVALID'
                OAUTH_REFRESH_TOKEN_TTL_INVALID:
                  $ref: '#/components/examples/OAUTH_REFRESH_TOKEN_TTL_INVALID'
                OAUTH_REFRESH_TOKEN_TTL_MUST_GT_TOKEN_TTL:
                  $ref: '#/components/examples/OAUTH_REFRESH_TOKEN_TTL_MUST_GT_TOKEN_TTL'
                OAUTH_LOGIN_REDIRECT_URL_INVALID:
                  $ref: '#/components/examples/OAUTH_LOGIN_REDIRECT_URL_INVALID'
                OAUTH_CORS_ORIGIN_INVALID:
                  $ref: '#/components/examples/OAUTH_CORS_ORIGIN_INVALID'
                OAUTH_DEVICE_CODE_BOTH_VERIFICATION_URL_REQUIRED:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_BOTH_VERIFICATION_URL_REQUIRED'
                OAUTH_DEVICE_CODE_VERIFICATION_URL_REQUIRED:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_VERIFICATION_URL_REQUIRED'
                OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_REQUIRED:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_REQUIRED'
                OAUTH_DEVICE_CODE_EXPIRE_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_EXPIRE_INVALID'
                OAUTH_DEVICE_CODE_POLLING_INTERVAL_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_POLLING_INTERVAL_INVALID'
                OAUTH_DEVICE_CODE_USER_CHAR_SET_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_USER_CHAR_SET_INVALID'
                OAUTH_DEVICE_CODE_USER_CODE_MASK_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_USER_CODE_MASK_INVALID'
                OAUTH_DEVICE_CODE_VERIFICATION_URL_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_VERIFICATION_URL_INVALID'
                OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_INVALID'
                OAUTH_LOGOUT_REDIRECT_URL_INVALID:
                  $ref: '#/components/examples/OAUTH_LOGOUT_REDIRECT_URL_INVALID'
                OAUTH_CIBA_TOKEN_TTL_INVALID:
                  $ref: '#/components/examples/OAUTH_CIBA_TOKEN_TTL_INVALID'
                OAUTH_CIBA_LOGOUT_URI_INVALID:
                  $ref: '#/components/examples/OAUTH_CIBA_LOGOUT_URI_INVALID'
                OAUTH_CIBA_LOGOUT_URI_REQUIRED:
                  $ref: '#/components/examples/OAUTH_CIBA_LOGOUT_URI_REQUIRED'
                OAUTH_SECRET_FORMAT_INVALID:
                  $ref: '#/components/examples/OAUTH_SECRET_FORMAT_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '409':
          description: 'Status Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              examples:
                OAUTH_CONFIG_ALREADY_EXIST:
                  $ref: '#/components/examples/OAUTH_CONFIG_ALREADY_EXIST'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Create OAuth client
      tags:
        - OAuth Clients
      security:
        - M2MBearerToken: []
  /v2/manage/oauth-clients/{oAuthClientName}:
    delete:
      description: Deletes the OAuth client configuration for the Tenant identified by the application name.
      operationId: DeleteOAuthClient
      parameters:
        - $ref: '#/components/parameters/oAuthClientName'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
          description: 'OK: The request was successful.'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_CONFIG_NOT_FOUND'
        '500':
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Delete OAuth Client Configuration
      tags:
        - OAuth Clients
      security:
        - M2MBearerToken: []
    get:
      description: Retrieves the OAuth client configuration details for the Tenant using the application name.
      operationId: GetOAuthClientConfigurationByAppName
      parameters:
        - $ref: '#/components/parameters/oAuthClientName'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClientResponse'
          description: 'OK: The request was successful.'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_CONFIG_NOT_FOUND'
        '500':
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Retrieve OAuth Client Configuration
      tags:
        - OAuth Clients
      security:
        - M2MBearerToken: []
    put:
      description: Updates the OAuth client configuration for the Tenant identified by the application name.
      operationId: UpdateOAuthClientConfigurationByAppName
      parameters:
        - $ref: '#/components/parameters/oAuthClientName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthClientRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClientResponse'
          description: 'OK: The request was successful.'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                OAUTH_AUDIENCE_SCOPES_INVALID:
                  $ref: '#/components/examples/OAUTH_AUDIENCE_SCOPES_INVALID'
                OAUTH_APPLICATION_TYPE_REQUIRED:
                  $ref: '#/components/examples/OAUTH_APPLICATION_TYPE_REQUIRED'
                OAUTH_APPLICATION_TYPE_INVALID:
                  $ref: '#/components/examples/OAUTH_APPLICATION_TYPE_INVALID'
                OAUTH_GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/OAUTH_GRANT_TYPE_INVALID'
                OAUTH_SERVICE_GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/OAUTH_SERVICE_GRANT_TYPE_INVALID'
                OAUTH_NON_SERVICE_GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/OAUTH_NON_SERVICE_GRANT_TYPE_INVALID'
                OAUTH_SCOPE_INVALID:
                  $ref: '#/components/examples/OAUTH_SCOPE_INVALID'
                OAUTH_TOKEN_AUTH_METHOD_INVALID:
                  $ref: '#/components/examples/OAUTH_TOKEN_AUTH_METHOD_INVALID'
                OAUTH_JWTCONFIG_TOKEN_TTL_INVALID:
                  $ref: '#/components/examples/OAUTH_JWTCONFIG_TOKEN_TTL_INVALID'
                OAUTH_REFRESH_TOKEN_TTL_INVALID:
                  $ref: '#/components/examples/OAUTH_REFRESH_TOKEN_TTL_INVALID'
                OAUTH_REFRESH_TOKEN_TTL_MUST_GT_TOKEN_TTL:
                  $ref: '#/components/examples/OAUTH_REFRESH_TOKEN_TTL_MUST_GT_TOKEN_TTL'
                OAUTH_LOGIN_REDIRECT_URL_INVALID:
                  $ref: '#/components/examples/OAUTH_LOGIN_REDIRECT_URL_INVALID'
                OAUTH_CORS_ORIGIN_INVALID:
                  $ref: '#/components/examples/OAUTH_CORS_ORIGIN_INVALID'
                OAUTH_DEVICE_CODE_BOTH_VERIFICATION_URL_REQUIRED:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_BOTH_VERIFICATION_URL_REQUIRED'
                OAUTH_DEVICE_CODE_VERIFICATION_URL_REQUIRED:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_VERIFICATION_URL_REQUIRED'
                OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_REQUIRED:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_REQUIRED'
                OAUTH_DEVICE_CODE_EXPIRE_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_EXPIRE_INVALID'
                OAUTH_DEVICE_CODE_POLLING_INTERVAL_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_POLLING_INTERVAL_INVALID'
                OAUTH_DEVICE_CODE_USER_CHAR_SET_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_USER_CHAR_SET_INVALID'
                OAUTH_DEVICE_CODE_USER_CODE_MASK_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_USER_CODE_MASK_INVALID'
                OAUTH_DEVICE_CODE_VERIFICATION_URL_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_VERIFICATION_URL_INVALID'
                OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_INVALID:
                  $ref: '#/components/examples/OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_INVALID'
                OAUTH_LOGOUT_REDIRECT_URL_INVALID:
                  $ref: '#/components/examples/OAUTH_LOGOUT_REDIRECT_URL_INVALID'
                OAUTH_CIBA_TOKEN_TTL_INVALID:
                  $ref: '#/components/examples/OAUTH_CIBA_TOKEN_TTL_INVALID'
                OAUTH_CIBA_LOGOUT_URI_INVALID:
                  $ref: '#/components/examples/OAUTH_CIBA_LOGOUT_URI_INVALID'
                OAUTH_CIBA_LOGOUT_URI_REQUIRED:
                  $ref: '#/components/examples/OAUTH_CIBA_LOGOUT_URI_REQUIRED'
                OAUTH_SECRET_FORMAT_INVALID:
                  $ref: '#/components/examples/OAUTH_SECRET_FORMAT_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_CONFIG_NOT_FOUND'
        '500':
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Update OAuth Client Configuration
      tags:
        - OAuth Clients
      security:
        - M2MBearerToken: []
  /v2/manage/oauth-clients/credentials/{oAuthClientName}:
    put:
      description: Resets the client secret for the OAuth client configuration identified by the AppName within the Tenant, generating a new client secret and invalidating the previous one to enhance security.
      operationId: ResetOAuthClientConfigurationSecretByAppName
      parameters:
        - $ref: '#/components/parameters/oAuthClientName'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClientSecretResetResponse'
          description: 'OK: The request was successful.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/OAUTH_CONFIG_NOT_FOUND'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OAUTH_CONFIG_CREDENTIALS_RESET_FAILED:
                  $ref: '#/components/examples/OAUTH_CONFIG_CREDENTIALS_RESET_FAILED'
        '500':
          description: 'Status Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Reset OAuth client secret
      tags:
        - OAuth Clients
      security:
        - M2MBearerToken: []
  /v2/manage/oauth-clients/connections-metadata:
    get:
      description: Retrieves metadata for OAuth client connections within the Tenant.
      operationId: GetOAuthClientConnectionsMetadata
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  CustomIdp:
                    type: array
                    items:
                      type: string
                  Enterprise:
                    type: array
                    items:
                      type: string
                  SocialLogins:
                    type: array
                    items:
                      type: string
          description: 'OK: The request was successful.'
        '403':
          content:
            application/json:
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Status Forbidden: The client does not have permission to access the resource.'
      summary: Retrieve OAuth Client Metadata
      tags:
        - OAuth Clients
      security:
        - M2MBearerToken: []
  /v2/manage/custom-providers/oauth:
    get:
      summary: List custom OAuth providers
      operationId: GetAllCustomOAuthProviders
      description: Retrieves all custom OAuth providers configured for the Tenant.
      tags:
        - OAuth Custom Providers
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OAuth2Provider'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ERROR_UNMARSHALLING_DATA:
                  $ref: '#/components/examples/ERROR_UNMARSHALLING_DATA'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_OAUTH_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/CUSTOM_OAUTH_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    post:
      summary: Create custom OAuth provider
      operationId: CreateCustomProvider
      description: Creates a new Custom OAuth provider for the Tenant.
      tags:
        - OAuth Custom Providers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomOAuth2Model'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuth2Provider'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_INVALID:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_INVALID'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                ERROR_UNMARSHALLING_DATA:
                  $ref: '#/components/examples/ERROR_UNMARSHALLING_DATA'
                INVALID_DOMAIN_NAME:
                  $ref: '#/components/examples/INVALID_DOMAIN_NAME'
                DOMAIN_NAME_IS_REQUIRED:
                  $ref: '#/components/examples/DOMAIN_NAME_IS_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DOMAIN_NAME_ALREADY_EXISTS:
                  $ref: '#/components/examples/DOMAIN_NAME_ALREADY_EXISTS'
                CUSTOM_OAUTH_PROVIDER_ALREADY_ADDED:
                  $ref: '#/components/examples/CUSTOM_OAUTH_PROVIDER_ALREADY_ADDED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    put:
      summary: Update custom OAuth provider
      operationId: UpdateCustomProvider
      description: Updates an existing Custom OAuth provider for the Tenant using the provider name specified in the request body.
      tags:
        - OAuth Custom Providers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomOAuth2UpdateModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuth2Provider'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
                ERROR_UNMARSHALLING_DATA:
                  $ref: '#/components/examples/ERROR_UNMARSHALLING_DATA'
                INVALID_DOMAIN_NAME:
                  $ref: '#/components/examples/INVALID_DOMAIN_NAME'
                DOMAIN_NAME_IS_REQUIRED:
                  $ref: '#/components/examples/DOMAIN_NAME_IS_REQUIRED'
                PROVIDER_IS_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_IS_NOT_VALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_OAUTH_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/CUSTOM_OAUTH_CONFIG_NOT_FOUND'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DOMAIN_NAME_ALREADY_EXISTS:
                  $ref: '#/components/examples/DOMAIN_NAME_ALREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    delete:
      summary: Delete custom OAuth provider
      operationId: DeleteCustomProvider
      description: Deletes an existing Custom OAuth provider for the Tenant using the provider name specified in the request body.
      tags:
        - OAuth Custom Providers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomOAuth2DeleteModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_DELETE_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_DELETE_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_REQUIRED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOM_OAUTH_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/CUSTOM_OAUTH_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /v2/manage/custom-providers/oauth/keys:
    get:
      summary: Retrieve custom OAuth provider keys
      operationId: GetCustomProviderKeys
      description: Retrieves all custom OAuth provider keys for the Tenant.
      tags:
        - OAuth Custom Providers
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomProviderKeys'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ERROR_RAAS_CONFIG_EMPTY:
                  $ref: '#/components/examples/ERROR_RAAS_CONFIG_EMPTY'
      security:
        - M2MBearerToken: []
  /v2/manage/password-policies:
    get:
      summary: Retrieve Password policy
      operationId: GetPasswordPolicy
      description: Retrieves the Password policy settings for a specific Tenant.
      tags:
        - Password Policy
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicy'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
    put:
      summary: Update Password policy
      operationId: UpdatePasswordPolicy
      description: Updates the Password policy settings for a specific Tenant.
      tags:
        - Password Policy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordPolicy'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicy'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_PUT_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_PUT_BODY_REQUIRED'
                INVALID_EXPIRATION_FREQUENCY_TYPE:
                  $ref: '#/components/examples/INVALID_EXPIRATION_FREQUENCY_TYPE'
                INVALID_EXPIRATION_FREQUENCY:
                  $ref: '#/components/examples/INVALID_EXPIRATION_FREQUENCY'
                INVALID_MAX_PASSWORD_HISTORY:
                  $ref: '#/components/examples/INVALID_MAX_PASSWORD_HISTORY'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
        '404':
          description: 'Not Found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CUSTOMER_REGISTRATION_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/CUSTOMER_REGISTRATION_CONFIG_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      security:
        - M2MBearerToken: []
  /identity:
    get:
      summary: Retrieve User's by pagination
      description: Retrieves User's data using the specified pagination parameters.
      servers:
        - url: https://cloud-api.loginradius.com
          description: LoginRadius Cloud API Prod Server
      tags:
        - Identity
      operationId: getUserProfilesByPageId
      parameters:
        - $ref: '#/components/parameters/Next'
        - $ref: '#/components/parameters/Region'
      responses:
        '200':
          description: Status Ok - The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfileResponse'
        '400':
          description: Bad Request - Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ApiKeySecretMissing:
                  $ref: '#/components/examples/ApiKeySecretMissing'
                ApiKeyMissing:
                  $ref: '#/components/examples/ApiKeyMissing'
                ApiSecretMissing:
                  $ref: '#/components/examples/ApiSecretMissing'
                ApiKeyInvalid:
                  $ref: '#/components/examples/ApiKeyInvalid'
                ApiSecretInvalid:
                  $ref: '#/components/examples/ApiSecretInvalid'
                NextParamInvalid:
                  $ref: '#/components/examples/NextParamInvalid'
                NextParamNotValid:
                  $ref: '#/components/examples/NextParamNotValid'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                AccessRestriction:
                  $ref: '#/components/examples/AccessRestriction'
        '403':
          description: Forbidden - Access to the resource is denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                NextParamMissing:
                  $ref: '#/components/examples/NextParamMissing'
                ApiKeyUnauthorized:
                  $ref: '#/components/examples/ApiKeyUnauthorized'
                ApiSecretUnauthorized:
                  $ref: '#/components/examples/ApiSecretUnauthorized'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
    post:
      summary: Retrieve User's by query
      description: Retrieves User's data based on specified query filters.
      servers:
        - url: https://cloud-api.loginradius.com
          description: LoginRadius Cloud API Prod Server
      parameters:
        - $ref: '#/components/parameters/Region'
      tags:
        - Identity
      operationId: queryUserProfiles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserProfileRequestBody'
      responses:
        '200':
          description: Status Ok -The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfileScrollResponse'
        '400':
          description: Bad Request - Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                PostBodyInvalid:
                  $ref: '#/components/examples/PostBodyInvalid'
                ApiKeySecretMissing:
                  $ref: '#/components/examples/ApiKeySecretMissing'
                ApiKeyMissing:
                  $ref: '#/components/examples/ApiKeyMissing'
                ApiSecretMissing:
                  $ref: '#/components/examples/ApiSecretMissing'
                ApiKeyInvalid:
                  $ref: '#/components/examples/ApiKeyInvalid'
                ApiSecretInvalid:
                  $ref: '#/components/examples/ApiSecretInvalid'
                ParameterBadFormat:
                  $ref: '#/components/examples/ParameterBadFormat'
                DateRangeMissing:
                  $ref: '#/components/examples/DateRangeMissing'
                DateRangeFromInvalidFormat:
                  $ref: '#/components/examples/DateRangeFromInvalidFormat'
                DateRangeToInvalidFormat:
                  $ref: '#/components/examples/DateRangeToInvalidFormat'
                DateRangeInvalid:
                  $ref: '#/components/examples/DateRangeInvalid'
                QueryFormatInvalid:
                  $ref: '#/components/examples/QueryFormatInvalid'
                QueryInvalid:
                  $ref: '#/components/examples/QueryInvalid'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                AccessRestriction:
                  $ref: '#/components/examples/AccessRestriction'
        '403':
          description: Forbidden - Access to the resource is denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ApiKeyUnauthorized:
                  $ref: '#/components/examples/ApiKeyUnauthorized'
                ApiSecretUnauthorized:
                  $ref: '#/components/examples/ApiSecretUnauthorized'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
  /identity/customobject:
    get:
      summary: Retrieve User's and Custom Object data by pagination
      description: Retrieves User's and Custom Object data per User based on the pagination parameters.
      servers:
        - url: https://cloud-api.loginradius.com
          description: LoginRadius Cloud API Prod Server
      tags:
        - Custom Objects
      operationId: getCustomObjectByQuery
      parameters:
        - $ref: '#/components/parameters/Region'
        - $ref: '#/components/parameters/CustomObject'
        - $ref: '#/components/parameters/Next'
      responses:
        '200':
          description: Status Ok - The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/userProfileNextResponseWithCustomObject'
        '400':
          description: Bad Request - Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ApiKeySecretMissing:
                  $ref: '#/components/examples/ApiKeySecretMissing'
                ApiKeyMissing:
                  $ref: '#/components/examples/ApiKeyMissing'
                ApiSecretMissing:
                  $ref: '#/components/examples/ApiSecretMissing'
                ApiKeyInvalid:
                  $ref: '#/components/examples/ApiKeyInvalid'
                ApiSecretInvalid:
                  $ref: '#/components/examples/ApiSecretInvalid'
                CustomObjectNameInvalid:
                  $ref: '#/components/examples/CustomObjectNameInvalid'
                CustomObjectNotAvailable:
                  $ref: '#/components/examples/CustomObjectNotAvailable'
                NextParamInvalid:
                  $ref: '#/components/examples/NextParamInvalid'
                NextParamNotValid:
                  $ref: '#/components/examples/NextParamNotValid'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                AccessRestriction:
                  $ref: '#/components/examples/AccessRestriction'
        '403':
          description: Forbidden - The request was valid, but the server is refusing to respond to it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                NextParamMissing:
                  $ref: '#/components/examples/NextParamMissing'
                ApiKeyUnauthorized:
                  $ref: '#/components/examples/ApiKeyUnauthorized'
                ApiSecretUnauthorized:
                  $ref: '#/components/examples/ApiSecretUnauthorized'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
    post:
      summary: Retrieve User's and Custom Object data by query
      description: Retrieves User's and Custom Objects data per User based on the query.
      servers:
        - url: https://cloud-api.loginradius.com
          description: LoginRadius Cloud API Prod Server
      tags:
        - Custom Objects
      operationId: postCustomObjectByQuery
      parameters:
        - $ref: '#/components/parameters/Region'
        - $ref: '#/components/parameters/CustomObject'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserProfileRequestBody'
      responses:
        '200':
          description: Status Ok - The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/userProfileScrollResponseWithCustomObject'
        '400':
          description: Bad Request - Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                PostBodyInvalid:
                  $ref: '#/components/examples/PostBodyInvalid'
                ApiKeySecretMissing:
                  $ref: '#/components/examples/ApiKeySecretMissing'
                ApiKeyMissing:
                  $ref: '#/components/examples/ApiKeyMissing'
                ApiSecretMissing:
                  $ref: '#/components/examples/ApiSecretMissing'
                ApiKeyInvalid:
                  $ref: '#/components/examples/ApiKeyInvalid'
                ApiSecretInvalid:
                  $ref: '#/components/examples/ApiSecretInvalid'
                ParameterBadFormat:
                  $ref: '#/components/examples/ParameterBadFormat'
                DateRangeMissing:
                  $ref: '#/components/examples/DateRangeMissing'
                DateRangeFromInvalidFormat:
                  $ref: '#/components/examples/DateRangeFromInvalidFormat'
                DateRangeToInvalidFormat:
                  $ref: '#/components/examples/DateRangeToInvalidFormat'
                DateRangeInvalid:
                  $ref: '#/components/examples/DateRangeInvalid'
                QueryFormatInvalid:
                  $ref: '#/components/examples/QueryFormatInvalid'
                QueryInvalid:
                  $ref: '#/components/examples/QueryInvalid'
                CustomObjectNameInvalid:
                  $ref: '#/components/examples/CustomObjectNameInvalid'
                CustomObjectNotAvailable:
                  $ref: '#/components/examples/CustomObjectNotAvailable'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                AccessRestriction:
                  $ref: '#/components/examples/AccessRestriction'
        '403':
          description: Forbidden - The request was valid, but the server is refusing to respond to it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ApiKeyUnauthorized:
                  $ref: '#/components/examples/ApiKeyUnauthorized'
                ApiSecretUnauthorized:
                  $ref: '#/components/examples/ApiSecretUnauthorized'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
  /customobject:
    get:
      summary: Retrieve Custom Object data by pagination
      description: Retrieves Custom Object data based on specified pagination parameters.
      servers:
        - url: https://cloud-api.loginradius.com
          description: LoginRadius Cloud API Prod Server
      tags:
        - Custom Objects
      operationId: getAllCustomObjectsByQuery
      parameters:
        - $ref: '#/components/parameters/CustomObject'
        - $ref: '#/components/parameters/Region'
        - $ref: '#/components/parameters/Next'
      responses:
        '200':
          description: Status Ok - The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfileNextResponse'
        '400':
          description: Bad Request - Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ApiKeySecretMissing:
                  $ref: '#/components/examples/ApiKeySecretMissing'
                ApiKeyMissing:
                  $ref: '#/components/examples/ApiKeyMissing'
                ApiSecretMissing:
                  $ref: '#/components/examples/ApiSecretMissing'
                ApiKeyInvalid:
                  $ref: '#/components/examples/ApiKeyInvalid'
                ApiSecretInvalid:
                  $ref: '#/components/examples/ApiSecretInvalid'
                CustomObjectNameMissing:
                  $ref: '#/components/examples/CustomObjectNameMissing'
                CustomObjectNameInvalid:
                  $ref: '#/components/examples/CustomObjectNameInvalid'
                CustomObjectSchemaNotSet:
                  $ref: '#/components/examples/CustomObjectSchemaNotSet'
                NextParamInvalid:
                  $ref: '#/components/examples/NextParamInvalid'
                NextParamNotValid:
                  $ref: '#/components/examples/NextParamNotValid'
                QueryInvalid:
                  $ref: '#/components/examples/QueryInvalid'
        '403':
          description: Forbidden - The request was valid, but the server is refusing to respond to it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                NextParamMissing:
                  $ref: '#/components/examples/NextParamMissing'
                ApiKeyUnauthorized:
                  $ref: '#/components/examples/ApiKeyUnauthorized'
                ApiSecretUnauthorized:
                  $ref: '#/components/examples/ApiSecretUnauthorized'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
    post:
      summary: Retrieve Custom Object data by query
      description: Retrieves Custom Object data based on specified query filters.
      servers:
        - url: https://cloud-api.loginradius.com
          description: LoginRadius Cloud API Prod Server
      tags:
        - Custom Objects
      operationId: postAllCustomObjectsByQuery
      parameters:
        - $ref: '#/components/parameters/CustomObject'
        - $ref: '#/components/parameters/Region'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserProfileRequestBody'
      responses:
        '200':
          description: Status Ok - The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfileScrollResponse'
        '400':
          description: Bad Request - Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                PostBodyInvalid:
                  $ref: '#/components/examples/PostBodyInvalid'
                ApiKeySecretMissing:
                  $ref: '#/components/examples/ApiKeySecretMissing'
                ApiKeyMissing:
                  $ref: '#/components/examples/ApiKeyMissing'
                ApiSecretMissing:
                  $ref: '#/components/examples/ApiSecretMissing'
                ApiKeyInvalid:
                  $ref: '#/components/examples/ApiKeyInvalid'
                ApiSecretInvalid:
                  $ref: '#/components/examples/ApiSecretInvalid'
                ParameterBadFormat:
                  $ref: '#/components/examples/ParameterBadFormat'
                CustomObjectNameMissing:
                  $ref: '#/components/examples/CustomObjectNameMissing'
                CustomObjectNameInvalid:
                  $ref: '#/components/examples/CustomObjectNameInvalid'
                CustomObjectSchemaNotSet:
                  $ref: '#/components/examples/CustomObjectSchemaNotSet'
                DateRangeMissing:
                  $ref: '#/components/examples/DateRangeMissing'
                DateRangeFromInvalidFormat:
                  $ref: '#/components/examples/DateRangeFromInvalidFormat'
                DateRangeToInvalidFormat:
                  $ref: '#/components/examples/DateRangeToInvalidFormat'
                DateRangeInvalid:
                  $ref: '#/components/examples/DateRangeInvalid'
                QueryFormatInvalid:
                  $ref: '#/components/examples/QueryFormatInvalid'
                QueryInvalid:
                  $ref: '#/components/examples/QueryInvalid'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                AccessRestriction:
                  $ref: '#/components/examples/AccessRestriction'
        '403':
          description: Forbidden - The request was valid, but the server is refusing to respond to it due to access restrictions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ApiKeyUnauthorized:
                  $ref: '#/components/examples/ApiKeyUnauthorized'
                ApiSecretUnauthorized:
                  $ref: '#/components/examples/ApiSecretUnauthorized'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
  /insights/userprofiles:
    post:
      summary: Retrieve User's data by filters
      description: Retrieves users based on specified query parameters.
      servers:
        - url: https://cloud-api.loginradius.com
          description: LoginRadius Cloud API Prod Server
      parameters:
        - $ref: '#/components/parameters/Region'
      tags:
        - Insights
      operationId: queryUserProfilesInsights
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/requestPayload'
      responses:
        '200':
          description: Successful response with User data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightsResponse'
        '400':
          description: Bad Request - The request was invalid or cannot be served.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ApiKeySecretMissing:
                  $ref: '#/components/examples/ApiKeySecretMissing'
                ApiKeyMissing:
                  $ref: '#/components/examples/ApiKeyMissing'
                ApiSecretMissing:
                  $ref: '#/components/examples/ApiSecretMissing'
                ApiKeyInvalid:
                  $ref: '#/components/examples/ApiKeyInvalid'
                ApiSecretInvalid:
                  $ref: '#/components/examples/ApiSecretInvalid'
                QueryInvalid:
                  $ref: '#/components/examples/QueryInvalid'
                PostBodyInvalid:
                  $ref: '#/components/examples/PostBodyInvalid'
        '401':
          description: Unauthorized - The request requires User authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                AccessRestriction:
                  $ref: '#/components/examples/AccessRestriction'
        '403':
          description: Forbidden - The request was valid, but the server is refusing to respond to it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                ApiKeyUnauthorized:
                  $ref: '#/components/examples/ApiKeyUnauthorized'
                ApiSecretUnauthorized:
                  $ref: '#/components/examples/ApiSecretUnauthorized'
      security:
        - APIKey: []
          APISecret: []
        - XLoginRadiusAPIKey: []
          XLoginRadiusAPISecret: []
  /api/jwt/{JwtAppName}/login:
    post:
      operationId: GetJWTTokenByLoginCredentials
      summary: Retrieve JWT token
      description: Retrieves a JWT token using login credentials such as Email, Phone, Username, and Password.
      parameters:
        - $ref: '#/components/parameters/JwtAppName'
        - $ref: '#/components/parameters/Nonce'
      requestBody:
        $ref: '#/components/requestBodies/JWTLoginRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWTSignature'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST_SSO'
                EMAIL_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/EMAIL_PAYLOAD_REQUIRED'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID_SSO'
                INVALID_HOST:
                  $ref: '#/components/examples/INVALID_HOST'
                INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/INVALID_PHONE_NUMBER_SSO'
                INVALID_POST_BODY:
                  $ref: '#/components/examples/INVALID_POST_BODY'
                JWT_APP_NAME_REQUIRED:
                  $ref: '#/components/examples/JWT_APP_NAME_REQUIRED'
                JWT_APP_NOT_MATCHED:
                  $ref: '#/components/examples/JWT_APP_NOT_MATCHED'
                PASSWORD_EMAIL_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_EMAIL_PAYLOAD_REQUIRED'
                PASSWORD_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_PAYLOAD_REQUIRED'
                PASSWORD_PHONE_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_PHONE_PAYLOAD_REQUIRED'
                PASSWORD_USERNAME_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_USERNAME_PAYLOAD_REQUIRED'
                PHONE_OR_EMAIL_OR_USER_REQUIRED_PARAM:
                  $ref: '#/components/examples/PHONE_OR_EMAIL_OR_USER_REQUIRED_PARAM_SSO'
                PHONE_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/PHONE_PAYLOAD_REQUIRED_SSO'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID_SSO'
                USERNAME_PAYLOAD_REQUIRED:
                  $ref: '#/components/examples/USERNAME_PAYLOAD_REQUIRED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND_SSO'
                JWT_CONFIG_NOT_VALID:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_VALID'
                USERNAME_OR_PASSWORD_WRONG:
                  $ref: '#/components/examples/USERNAME_OR_PASSWORD_WRONG_SSO'
                USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT:
                  $ref: '#/components/examples/USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT'
                USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT:
                  $ref: '#/components/examples/USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/ACCOUNT_NOT_ALLOWED_TO_LOGIN_SSO'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED_SSO'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_SSO'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT_SSO'
                APP_NOT_EXISTS:
                  $ref: '#/components/examples/APP_NOT_EXISTS'
                BREACHED_PASSWORD_LOGIN:
                  $ref: '#/components/examples/BREACHED_PASSWORD_LOGIN_SSO'
                CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/CAPTCHA_NOT_VALID_SSO'
                CHANGE_BREACHED_PASSWORD:
                  $ref: '#/components/examples/CHANGE_BREACHED_PASSWORD'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED_SSO'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED_SSO'
                EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/EMAIL_SEND_LIMIT_REACHED'
                EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED:
                  $ref: '#/components/examples/EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED'
                LOGIN_DISABLED:
                  $ref: '#/components/examples/LOGIN_DISABLED_SSO'
                LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_RECAPTCHA_SSO'
                LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION_SSO'
                LOGIN_WITH_PASSWORD_NOT_ENABLED:
                  $ref: '#/components/examples/LOGIN_WITH_PASSWORD_NOT_ENABLED_SSO'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_SSO'
                OTP_SEND_FAILED:
                  $ref: '#/components/examples/OTP_SEND_FAILED_SSO'
                PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/PHONE_NO_LOGIN_NOT_ENABLED_SSO'
                PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/PHONE_NOT_VERIFIED_SSO'
                PIN_IS_REQUIRED:
                  $ref: '#/components/examples/PIN_IS_REQUIRED_SSO'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED_SSO'
                RBA_ACCOUNT_IS_BLOCKED:
                  $ref: '#/components/examples/RBA_ACCOUNT_IS_BLOCKED'
                RBA_EMAIL_VERIFICATION:
                  $ref: '#/components/examples/RBA_EMAIL_VERIFICATION'
                RBA_SECURITY_ANSWER_VERIFICATION:
                  $ref: '#/components/examples/RBA_SECURITY_ANSWER_VERIFICATION'
                RBA_SMS_VERIFICATION:
                  $ref: '#/components/examples/RBA_SMS_VERIFICATION'
                SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/SMS_CONFIGURATION_NOT_EXISTS_SSO'
                SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/SMS_SEND_LIMIT_REACHED_SSO'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED_SSO'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED_SSO'
                USER_ID_LOCKED_SSO:
                  $ref: '#/components/examples/USER_ID_LOCKED_SSO'
                USER_ID_LOCKED_WITH_TIMEOUT_SSO:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT_SSO'
                USER_NAME_AUTHENTICATION_ENABLED_SSO:
                  $ref: '#/components/examples/USER_NAME_AUTHENTICATION_ENABLED_SSO'
                USER_NOT_EXISTS_SSO:
                  $ref: '#/components/examples/USER_NOT_EXISTS_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
      tags:
        - JWT
      x-order: 2
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/jwt/{JwtAppName}/token:
    get:
      operationId: GetJWTTokenByAccessToken
      summary: Retrieve JWT token by Access Token
      description: Retrieves a JWT token using an Access Token obtained after successful login.
      parameters:
        - $ref: '#/components/parameters/JwtAppName'
        - $ref: '#/components/parameters/Nonce'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWTSignature'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST_SSO'
                EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/EMAILID_ID_FORMAT_NOT_VALID_SSO'
                INVALID_HOST:
                  $ref: '#/components/examples/INVALID_HOST'
                INVALID_PROVIDER_IN_ORGANIZATION_SSO:
                  $ref: '#/components/examples/INVALID_PROVIDER_IN_ORGANIZATION_SSO'
                JWT_ACCESS_TOKEN_REQUIRED_SSO:
                  $ref: '#/components/examples/JWT_ACCESS_TOKEN_REQUIRED'
                JWT_APP_NAME_REQUIRED:
                  $ref: '#/components/examples/JWT_APP_NAME_REQUIRED'
                JWT_APP_NOT_MATCHED:
                  $ref: '#/components/examples/JWT_APP_NOT_MATCHED'
                OAUTH_TOKEN_CONFIG_NOT_FOUND_SSO:
                  $ref: '#/components/examples/OAUTH_TOKEN_CONFIG_NOT_FOUND_SSO'
                ORGANIZATION_NOT_FOUND_SSO:
                  $ref: '#/components/examples/ORGANIZATION_NOT_FOUND_SSO'
                SOCIAL_REGISTRATION_NOT_ALLOWED:
                  $ref: '#/components/examples/SOCIAL_REGISTRATION_NOT_ALLOWED'
                USER_ID_LOCKED_WITH_TIMEOUT_SSO:
                  $ref: '#/components/examples/USER_ID_LOCKED_WITH_TIMEOUT_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                JWT_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_FOUND_SSO'
                JWT_CONFIG_NOT_VALID:
                  $ref: '#/components/examples/JWT_CONFIG_NOT_VALID'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/ACCESS_TOKEN_EXPIRED_SSO'
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID_SSO'
                ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/ACTIVE_SESSIONS_EXCEEDED_SSO'
                AGE_UNDERAGE_SSO:
                  $ref: '#/components/examples/AGE_UNDERAGE_SSO'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_SSO'
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT_SSO'
                APP_NOT_EXISTS:
                  $ref: '#/components/examples/APP_NOT_EXISTS'
                AUTOLOOKUP_DOMAIN_NOT_MATCH:
                  $ref: '#/components/examples/AUTOLOOKUP_DOMAIN_NOT_MATCH'
                CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_SUBMITTED_SSO'
                CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/CONSENT_FORM_VALIDATION_FAILED'
                EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION_SSO:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION_SSO'
                EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER_SSO:
                  $ref: '#/components/examples/EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER_SSO'
                EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/EMAIL_NOT_VERIFIED_SSO'
                EMAILID_ALREADY_REGISTERED_SSO:
                  $ref: '#/components/examples/EMAILID_ALREADY_REGISTERED_SSO'
                JWT_SP_TOKEN_INVALID:
                  $ref: '#/components/examples/JWT_SP_TOKEN_INVALID_SSO'
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_SSO'
                ORGANIZATION_NOT_ACTIVE:
                  $ref: '#/components/examples/ORGANIZATION_NOT_ACTIVE_SSO'
                PHONE_NO_ALREADY_REGISTERED:
                  $ref: '#/components/examples/PHONE_NO_ALREADY_REGISTERED_SSO'
                PIN_IS_REQUIRED:
                  $ref: '#/components/examples/PIN_IS_REQUIRED_SSO'
                PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/PRIVACY_POLICY_MISMATCHED_SSO'
                PROVIDER_ID_MISSING:
                  $ref: '#/components/examples/PROVIDER_ID_MISSING_SSO'
                PROVIDER_NOT_CONFIGURED:
                  $ref: '#/components/examples/PROVIDER_NOT_CONFIGURED_SSO'
                PROVIDER_NOT_SUPPORTED:
                  $ref: '#/components/examples/PROVIDER_NOT_SUPPORTED_SSO'
                PROVIDER_NOT_VALID:
                  $ref: '#/components/examples/PROVIDER_NOT_VALID_SSO'
                PROVIDER_SIDE_ERROR:
                  $ref: '#/components/examples/PROVIDER_SIDE_ERROR_SSO'
                ROLE_DOES_NOT_EXISTS_SSO:
                  $ref: '#/components/examples/ROLE_DOES_NOT_EXISTS_SSO'
                SIGNUP_NOT_ALLOWED_IN_ORG:
                  $ref: '#/components/examples/SIGNUP_NOT_ALLOWED_IN_ORG'
                SOMETHING_GOING_WRONG_SSO:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG_SSO'
                THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER_SSO:
                  $ref: '#/components/examples/THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER_SSO'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED_SSO'
                TRIAL_PLAN_USER_LIMIT_REACHED_SSO:
                  $ref: '#/components/examples/TRIAL_PLAN_USER_LIMIT_REACHED_SSO'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_SSO:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_SSO'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_SSO_IN_EMAIL_VERIFCATION_DISABLED:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED_SSO'
                UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_PHONE_ID:
                  $ref: '#/components/examples/UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_PHONE_ID'
                USER_ID_BLOCKED:
                  $ref: '#/components/examples/USER_ID_BLOCKED_SSO'
                USER_NOT_EXISTS_SSO:
                  $ref: '#/components/examples/USER_NOT_EXISTS_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
          AccessToken: []
        - XLoginRadiusAPIKey: []
          BearerToken: []
      tags:
        - JWT
      x-order: 1
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/oauth/{OAuthAppName}/device:
    post:
      operationId: GetOAuthDeviceCode
      summary: Retrieve OAuth device code
      description: Retrieves an OAuth device code for device-based authentication.
      parameters:
        - $ref: '#/components/parameters/OAuthAppName'
      requestBody:
        $ref: '#/components/requestBodies/OAuthDeviceCodeRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthDeviceCodeResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                SCOPE_INVALID:
                  $ref: '#/components/examples/SCOPE_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                OAUTH_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OAUTH_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth
      x-order: 1
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/oauth/{OAuthAppName}/introspect:
    post:
      operationId: IntrospectOAuthToken
      summary: Introspect OAuth token
      description: Returns the active state and metadata of an OAuth access token (RFC 7662). Client must authenticate with client_id and client_secret (POST body or Basic). Invalid or expired tokens return active false.
      parameters:
        - $ref: '#/components/parameters/OAuthAppName'
      requestBody:
        $ref: '#/components/requestBodies/OAuthRevokeRefreshTokenRequest'
      responses:
        '200':
          description: 'OK: Introspection result (active true with claims, or active false).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OIDCTokenIntrospectResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED_SSO'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                OAUTH_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OAUTH_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth
      x-order: 4
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/oauth/{OAuthAppName}/revoke:
    post:
      operationId: RevokeOAuthRefreshToken
      summary: Revoke OAuth refresh token
      description: Revokes an OAuth refresh token to prevent further use.
      parameters:
        - $ref: '#/components/parameters/OAuthAppName'
      requestBody:
        $ref: '#/components/requestBodies/OAuthRevokeRefreshTokenRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                REFRESH_TOKEN_INVALID_SSO:
                  $ref: '#/components/examples/REFRESH_TOKEN_INVALID_SSO'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED_SSO'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                OAUTH_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OAUTH_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth
      x-order: 3
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/oauth/{OAuthAppName}/token:
    post:
      operationId: GetOAuthTokens
      summary: Retrieve OAuth tokens
      description: Retrieves OAuth tokens for authentication and authorization purposes.
      parameters:
        - $ref: '#/components/parameters/OAuthAppName'
      requestBody:
        $ref: '#/components/requestBodies/OAuthTokenRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                ACCESS_TOKEN_INVALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_SSO'
                ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO'
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CODE_EXPIRED:
                  $ref: '#/components/examples/CODE_EXPIRED'
                CODE_INVALID:
                  $ref: '#/components/examples/CODE_INVALID'
                CODE_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/CODE_INVALID_OR_EXPIRED'
                CODE_IS_ALREADY_USED:
                  $ref: '#/components/examples/CODE_IS_ALREADY_USED'
                CODE_REQUIRED:
                  $ref: '#/components/examples/CODE_REQUIRED'
                CODE_VERIFIER_INVALID:
                  $ref: '#/components/examples/CODE_VERIFIER_INVALID'
                CODE_VERIFIER_REQUIRED:
                  $ref: '#/components/examples/CODE_VERIFIER_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                DEVICE_AUTHORIZATION_PENDING:
                  $ref: '#/components/examples/DEVICE_AUTHORIZATION_PENDING'
                DEVICE_CODE_INVALID:
                  $ref: '#/components/examples/DEVICE_CODE_INVALID'
                DEVICE_CODE_REQUIRED:
                  $ref: '#/components/examples/DEVICE_CODE_REQUIRED'
                DEVICE_SLOW_DOWN:
                  $ref: '#/components/examples/DEVICE_SLOW_DOWN'
                GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/GRANT_TYPE_INVALID'
                GRANT_TYPE_REQUIRED:
                  $ref: '#/components/examples/GRANT_TYPE_REQUIRED'
                OAUTH_ACCESS_DENIED:
                  $ref: '#/components/examples/OAUTH_ACCESS_DENIED'
                OAUTH_ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_ACCESS_TOKEN_EXPIRED'
                OAUTH_ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/OAUTH_ACCOUNT_NOT_ALLOWED_TO_LOGIN'
                OAUTH_ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/OAUTH_ACTIVE_SESSIONS_EXCEEDED'
                OAUTH_APP_NOT_EXISTS:
                  $ref: '#/components/examples/OAUTH_APP_NOT_EXISTS'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_BREACHED_PASSWORD_LOGIN:
                  $ref: '#/components/examples/OAUTH_BREACHED_PASSWORD_LOGIN'
                OAUTH_CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/OAUTH_CAPTCHA_NOT_VALID'
                OAUTH_CHANGE_BREACHED_PASSWORD:
                  $ref: '#/components/examples/OAUTH_CHANGE_BREACHED_PASSWORD'
                OAUTH_CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/OAUTH_CONSENT_FORM_NOT_SUBMITTED'
                OAUTH_CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/OAUTH_CONSENT_FORM_VALIDATION_FAILED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/OAUTH_EMAIL_NOT_VERIFIED'
                OAUTH_EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/OAUTH_EMAIL_SEND_LIMIT_REACHED'
                OAUTH_EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/OAUTH_EMAILID_ID_FORMAT_NOT_VALID'
                OAUTH_EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED:
                  $ref: '#/components/examples/OAUTH_EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/OAUTH_INVALID_PHONE_NUMBER'
                OAUTH_LOGIN_DISABLED:
                  $ref: '#/components/examples/OAUTH_LOGIN_DISABLED'
                OAUTH_LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/OAUTH_LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                OAUTH_LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/OAUTH_LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                OAUTH_LOGIN_WITH_PASSWORD_NOT_ENABLED:
                  $ref: '#/components/examples/OAUTH_LOGIN_WITH_PASSWORD_NOT_ENABLED'
                OAUTH_OPERATION_FAILED:
                  $ref: '#/components/examples/OAUTH_OPERATION_FAILED'
                OAUTH_OTP_SEND_FAILED:
                  $ref: '#/components/examples/OAUTH_OTP_SEND_FAILED'
                OAUTH_PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/OAUTH_PHONE_NO_LOGIN_NOT_ENABLED'
                OAUTH_PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/OAUTH_PHONE_NOT_VERIFIED'
                OAUTH_PIN_IS_REQUIRED:
                  $ref: '#/components/examples/OAUTH_PIN_IS_REQUIRED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/OAUTH_PRIVACY_POLICY_MISMATCHED'
                OAUTH_RBA_ACCOUNT_IS_BLOCKED:
                  $ref: '#/components/examples/OAUTH_RBA_ACCOUNT_IS_BLOCKED'
                OAUTH_RBA_EMAIL_VERIFICATION:
                  $ref: '#/components/examples/OAUTH_RBA_EMAIL_VERIFICATION'
                OAUTH_RBA_SECURITY_ANSWER_VERIFICATION:
                  $ref: '#/components/examples/OAUTH_RBA_SECURITY_ANSWER_VERIFICATION'
                OAUTH_RBA_SMS_VERIFICATION:
                  $ref: '#/components/examples/OAUTH_RBA_SMS_VERIFICATION'
                OAUTH_SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/OAUTH_SMS_CONFIGURATION_NOT_EXISTS'
                OAUTH_SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/OAUTH_SMS_SEND_LIMIT_REACHED'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                OAUTH_USER_ID_BLOCKED:
                  $ref: '#/components/examples/OAUTH_USER_ID_BLOCKED'
                OAUTH_USER_ID_LOCKED_SSO:
                  $ref: '#/components/examples/OAUTH_USER_ID_LOCKED'
                OAUTH_USER_NAME_AUTHENTICATION_ENABLED_SSO:
                  $ref: '#/components/examples/OAUTH_USER_NAME_AUTHENTICATION_ENABLED'
                OAUTH_USER_NOT_EXISTS_SSO:
                  $ref: '#/components/examples/OAUTH_USER_NOT_EXISTS'
                OAUTH_USERNAME_OR_PASSWORD_WRONG:
                  $ref: '#/components/examples/OAUTH_USERNAME_OR_PASSWORD_WRONG'
                OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT:
                  $ref: '#/components/examples/OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT'
                OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT:
                  $ref: '#/components/examples/OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED_SSO'
                REDIRECT_URI_INVALID:
                  $ref: '#/components/examples/REDIRECT_URI_INVALID'
                REDIRECT_URI_REQUIRED:
                  $ref: '#/components/examples/REDIRECT_URI_REQUIRED'
                REFRESH_TOKEN_INVALID_SSO:
                  $ref: '#/components/examples/REFRESH_TOKEN_INVALID_SSO'
                REFRESH_TOKEN_REQUIRED_SSO:
                  $ref: '#/components/examples/REFRESH_TOKEN_REQUIRED_SSO'
                RESPONSE_TYPE_INVALID:
                  $ref: '#/components/examples/RESPONSE_TYPE_INVALID'
                SCOPE_INVALID:
                  $ref: '#/components/examples/SCOPE_INVALID'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED_SSO'
                USERNAME_REQUIRED_SSO:
                  $ref: '#/components/examples/USERNAME_REQUIRED_SSO'
                RESOURCE_PERMISSION_NOT_FOUND:
                  $ref: '#/components/examples/RESOURCE_PERMISSION_NOT_FOUND'
                USER_PERMISSION_NOT_FOUND:
                  $ref: '#/components/examples/USER_PERMISSION_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
                /DEVICE_ACCESS_TOKEN_EXPIRED_SSO:
                  $ref: '#/components/examples/DEVICE_ACCESS_TOKEN_EXPIRED'
                OAUTH_REDIRECT_URI_MISMATCH:
                  $ref: '#/components/examples/OAUTH_REDIRECT_URI_MISMATCH'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR_SSO'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OAUTH_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth
      x-order: 2
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/oidc/{OIDCAppName}/device:
    post:
      operationId: GetOIDCDeviceCode
      summary: Retrieve OIDC device code
      description: Retrieves an OIDC device code for device-based authentication.
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      requestBody:
        $ref: '#/components/requestBodies/OIDCDeviceCodeRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OIDCDeviceCodeResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                SCOPE_INVALID:
                  $ref: '#/components/examples/SCOPE_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                OPENID_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OPENID_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 5
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/oidc/{OIDCAppName}/introspect:
    post:
      operationId: IntrospectOIDCToken
      summary: Introspect OIDC token
      description: Returns the active state and metadata of an OIDC access token (RFC 7662). Client must authenticate with client_id and client_secret (POST body or Basic). Invalid or expired tokens return active false.
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      requestBody:
        $ref: '#/components/requestBodies/OAuthRevokeRefreshTokenRequest'
      responses:
        '200':
          description: 'OK: Introspection result (active true with claims, or active false).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OIDCTokenIntrospectResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED_SSO'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                OPENID_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OPENID_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 6
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/oidc/{OIDCAppName}/revoke:
    post:
      operationId: RevokeOIDCRefreshToken
      summary: Revoke OIDC refresh token
      description: Revokes an OIDC refresh token to terminate its validity.
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      requestBody:
        $ref: '#/components/requestBodies/OAuthRevokeRefreshTokenRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                REFRESH_TOKEN_INVALID_SSO:
                  $ref: '#/components/examples/REFRESH_TOKEN_INVALID_SSO'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED_SSO'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                OPENID_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OPENID_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 7
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /api/oidc/{OIDCAppName}/token:
    post:
      operationId: GetOIDCTokens
      summary: Retrieve OIDC tokens
      description: Retrieves OpenID Connect (OIDC) tokens for User authentication.
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      requestBody:
        $ref: '#/components/requestBodies/OIDCTokenRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OIDCTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                ACCESS_TOKEN_INVALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_SSO'
                ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO'
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CODE_EXPIRED:
                  $ref: '#/components/examples/CODE_EXPIRED'
                CODE_INVALID:
                  $ref: '#/components/examples/CODE_INVALID'
                CODE_INVALID_OR_EXPIRED:
                  $ref: '#/components/examples/CODE_INVALID_OR_EXPIRED'
                CODE_IS_ALREADY_USED:
                  $ref: '#/components/examples/CODE_IS_ALREADY_USED'
                CODE_REQUIRED:
                  $ref: '#/components/examples/CODE_REQUIRED'
                CODE_VERIFIER_INVALID:
                  $ref: '#/components/examples/CODE_VERIFIER_INVALID'
                CODE_VERIFIER_REQUIRED:
                  $ref: '#/components/examples/CODE_VERIFIER_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                DEVICE_AUTHORIZATION_PENDING:
                  $ref: '#/components/examples/DEVICE_AUTHORIZATION_PENDING'
                DEVICE_CODE_INVALID:
                  $ref: '#/components/examples/DEVICE_CODE_INVALID'
                DEVICE_CODE_REQUIRED:
                  $ref: '#/components/examples/DEVICE_CODE_REQUIRED'
                DEVICE_SLOW_DOWN:
                  $ref: '#/components/examples/DEVICE_SLOW_DOWN'
                GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/GRANT_TYPE_INVALID'
                GRANT_TYPE_REQUIRED:
                  $ref: '#/components/examples/GRANT_TYPE_REQUIRED'
                OAUTH_ACCESS_DENIED:
                  $ref: '#/components/examples/OAUTH_ACCESS_DENIED'
                OAUTH_ACCESS_TOKEN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_ACCESS_TOKEN_EXPIRED'
                OAUTH_ACCOUNT_NOT_ALLOWED_TO_LOGIN:
                  $ref: '#/components/examples/OAUTH_ACCOUNT_NOT_ALLOWED_TO_LOGIN'
                OAUTH_ACTIVE_SESSIONS_EXCEEDED:
                  $ref: '#/components/examples/OAUTH_ACTIVE_SESSIONS_EXCEEDED'
                OAUTH_APP_NOT_EXISTS:
                  $ref: '#/components/examples/OAUTH_APP_NOT_EXISTS'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_BREACHED_PASSWORD_LOGIN:
                  $ref: '#/components/examples/OAUTH_BREACHED_PASSWORD_LOGIN'
                OAUTH_CAPTCHA_NOT_VALID:
                  $ref: '#/components/examples/OAUTH_CAPTCHA_NOT_VALID'
                OAUTH_CHANGE_BREACHED_PASSWORD:
                  $ref: '#/components/examples/OAUTH_CHANGE_BREACHED_PASSWORD'
                OAUTH_CONSENT_FORM_NOT_SUBMITTED:
                  $ref: '#/components/examples/OAUTH_CONSENT_FORM_NOT_SUBMITTED'
                OAUTH_CONSENT_FORM_VALIDATION_FAILED:
                  $ref: '#/components/examples/OAUTH_CONSENT_FORM_VALIDATION_FAILED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_EMAIL_NOT_VERIFIED:
                  $ref: '#/components/examples/OAUTH_EMAIL_NOT_VERIFIED'
                OAUTH_EMAIL_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/OAUTH_EMAIL_SEND_LIMIT_REACHED'
                OAUTH_EMAILID_ID_FORMAT_NOT_VALID:
                  $ref: '#/components/examples/OAUTH_EMAILID_ID_FORMAT_NOT_VALID'
                OAUTH_EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED:
                  $ref: '#/components/examples/OAUTH_EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_INVALID_PHONE_NUMBER:
                  $ref: '#/components/examples/OAUTH_INVALID_PHONE_NUMBER'
                OAUTH_LOGIN_DISABLED:
                  $ref: '#/components/examples/OAUTH_LOGIN_DISABLED'
                OAUTH_LOGIN_IS_LOCKED_FOR_RECAPTCHA:
                  $ref: '#/components/examples/OAUTH_LOGIN_IS_LOCKED_FOR_RECAPTCHA'
                OAUTH_LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
                  $ref: '#/components/examples/OAUTH_LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION'
                OAUTH_LOGIN_WITH_PASSWORD_NOT_ENABLED:
                  $ref: '#/components/examples/OAUTH_LOGIN_WITH_PASSWORD_NOT_ENABLED'
                OAUTH_OPERATION_FAILED:
                  $ref: '#/components/examples/OAUTH_OPERATION_FAILED'
                OAUTH_OTP_SEND_FAILED:
                  $ref: '#/components/examples/OAUTH_OTP_SEND_FAILED'
                OAUTH_PHONE_NO_LOGIN_NOT_ENABLED:
                  $ref: '#/components/examples/OAUTH_PHONE_NO_LOGIN_NOT_ENABLED'
                OAUTH_PHONE_NOT_VERIFIED:
                  $ref: '#/components/examples/OAUTH_PHONE_NOT_VERIFIED'
                OAUTH_PIN_IS_REQUIRED:
                  $ref: '#/components/examples/OAUTH_PIN_IS_REQUIRED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_PRIVACY_POLICY_MISMATCHED:
                  $ref: '#/components/examples/OAUTH_PRIVACY_POLICY_MISMATCHED'
                OAUTH_RBA_ACCOUNT_IS_BLOCKED:
                  $ref: '#/components/examples/OAUTH_RBA_ACCOUNT_IS_BLOCKED'
                OAUTH_RBA_EMAIL_VERIFICATION:
                  $ref: '#/components/examples/OAUTH_RBA_EMAIL_VERIFICATION'
                OAUTH_RBA_SECURITY_ANSWER_VERIFICATION:
                  $ref: '#/components/examples/OAUTH_RBA_SECURITY_ANSWER_VERIFICATION'
                OAUTH_RBA_SMS_VERIFICATION:
                  $ref: '#/components/examples/OAUTH_RBA_SMS_VERIFICATION'
                OAUTH_SMS_CONFIGURATION_NOT_EXISTS:
                  $ref: '#/components/examples/OAUTH_SMS_CONFIGURATION_NOT_EXISTS'
                OAUTH_SMS_SEND_LIMIT_REACHED:
                  $ref: '#/components/examples/OAUTH_SMS_SEND_LIMIT_REACHED'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                OAUTH_USER_ID_BLOCKED:
                  $ref: '#/components/examples/OAUTH_USER_ID_BLOCKED'
                OAUTH_USER_ID_LOCKED_SSO:
                  $ref: '#/components/examples/OAUTH_USER_ID_LOCKED'
                OAUTH_USER_NAME_AUTHENTICATION_ENABLED_SSO:
                  $ref: '#/components/examples/OAUTH_USER_NAME_AUTHENTICATION_ENABLED'
                OAUTH_USER_NOT_EXISTS_SSO:
                  $ref: '#/components/examples/OAUTH_USER_NOT_EXISTS'
                OAUTH_USERNAME_OR_PASSWORD_WRONG:
                  $ref: '#/components/examples/OAUTH_USERNAME_OR_PASSWORD_WRONG'
                OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT:
                  $ref: '#/components/examples/OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT'
                OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT:
                  $ref: '#/components/examples/OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT'
                PASSWORD_REQUIRED:
                  $ref: '#/components/examples/PASSWORD_REQUIRED_SSO'
                REDIRECT_URI_INVALID:
                  $ref: '#/components/examples/REDIRECT_URI_INVALID'
                REDIRECT_URI_REQUIRED:
                  $ref: '#/components/examples/REDIRECT_URI_REQUIRED'
                REFRESH_TOKEN_INVALID_SSO:
                  $ref: '#/components/examples/REFRESH_TOKEN_INVALID_SSO'
                REFRESH_TOKEN_REQUIRED_SSO:
                  $ref: '#/components/examples/REFRESH_TOKEN_REQUIRED_SSO'
                RESPONSE_TYPE_INVALID:
                  $ref: '#/components/examples/RESPONSE_TYPE_INVALID'
                SCOPE_INVALID:
                  $ref: '#/components/examples/SCOPE_INVALID'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED_SSO'
                USERNAME_REQUIRED_SSO:
                  $ref: '#/components/examples/USERNAME_REQUIRED_SSO'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
                /DEVICE_ACCESS_TOKEN_EXPIRED_SSO:
                  $ref: '#/components/examples/DEVICE_ACCESS_TOKEN_EXPIRED'
                OAUTH_REDIRECT_URI_MISMATCH:
                  $ref: '#/components/examples/OAUTH_REDIRECT_URI_MISMATCH'
                GENERIC_AUTH_ERROR:
                  $ref: '#/components/examples/GENERIC_AUTH_ERROR_SSO'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OPENID_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OPENID_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 6
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/oauth/introspect:
    post:
      operationId: GetM2MTokenInfo
      summary: Retrieve M2M token info
      description: Retrieves information about a Machine-to-Machine (M2M) token.
      requestBody:
        $ref: '#/components/requestBodies/OAuthM2MTokenIntrospectRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthM2MIntrospectResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED_SSO'
                TOKEN_TYPE_HINT_INVALID:
                  $ref: '#/components/examples/TOKEN_TYPE_HINT_INVALID'
                TOKEN_TYPE_HINT_REQUIRED:
                  $ref: '#/components/examples/TOKEN_TYPE_HINT_REQUIRED'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                M2M_CONF_NOT_EXIST:
                  $ref: '#/components/examples/M2M_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth M2M
      x-order: 3
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/oauth/jwks:
    get:
      operationId: GetM2MJWKSConfig
      summary: Retrieve JSON Web Key Set
      description: Retrieves the JSON Web Key Set (JWKS) for verifying token signatures.
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWKSResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth M2M
      x-order: 1
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/oauth/revoke:
    post:
      operationId: RevokeM2MToken
      summary: Revoke M2M token
      description: Revokes a Machine-to-Machine (M2M) token to invalidate it.
      requestBody:
        $ref: '#/components/requestBodies/OAuthM2MTokenRevokeRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO'
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                TOKEN_EXPIRED:
                  $ref: '#/components/examples/TOKEN_EXPIRED'
                TOKEN_INVALID:
                  $ref: '#/components/examples/TOKEN_INVALID'
                TOKEN_REQUIRED:
                  $ref: '#/components/examples/TOKEN_REQUIRED_SSO'
                TOKEN_TYPE_HINT_INVALID:
                  $ref: '#/components/examples/TOKEN_TYPE_HINT_INVALID'
                TOKEN_TYPE_HINT_REQUIRED:
                  $ref: '#/components/examples/TOKEN_TYPE_HINT_REQUIRED'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                M2M_CONF_NOT_EXIST:
                  $ref: '#/components/examples/M2M_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth M2M
      x-order: 4
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/oauth/token:
    post:
      operationId: GenerateM2MToken
      summary: Generate M2M token
      description: Generates a Machine-to-Machine (M2M) token for application authentication.
      requestBody:
        $ref: '#/components/requestBodies/OAuthM2MTokenGenerateRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthM2MTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                AUDIENCE_REQUIRED:
                  $ref: '#/components/examples/AUDIENCE_REQUIRED'
                CLIENT_ID_REQUIRED:
                  $ref: '#/components/examples/CLIENT_ID_REQUIRED'
                CLIENT_SECRET_BASIC_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_BASIC_REQUIRED'
                CLIENT_SECRET_POST_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_POST_REQUIRED'
                CLIENT_SECRET_REQUIRED:
                  $ref: '#/components/examples/CLIENT_SECRET_REQUIRED'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                GRANT_TYPE_INVALID:
                  $ref: '#/components/examples/GRANT_TYPE_INVALID'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_POST_BODY_INVALID:
                  $ref: '#/components/examples/OAUTH_POST_BODY_INVALID'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                RESOURCE_PERMISSION_NOT_FOUND:
                  $ref: '#/components/examples/RESOURCE_PERMISSION_NOT_FOUND'
                USER_PERMISSION_NOT_FOUND:
                  $ref: '#/components/examples/USER_PERMISSION_NOT_FOUND'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '401':
          description: 'Status Unauthorized: The client must authenticate itself to get the requested response.'
          content:
            application/json:
              examples:
                CLIENT_ID_INVALID:
                  $ref: '#/components/examples/CLIENT_ID_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                CLIENT_SECRET_INVALID:
                  $ref: '#/components/examples/CLIENT_SECRET_INVALID'
                M2M_CONF_NOT_EXIST:
                  $ref: '#/components/examples/M2M_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth M2M
      x-order: 2
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/oidc/{OIDCAppName}/.well-known/openid-configuration:
    get:
      operationId: GetOIDCDiscoveryConfig
      summary: Discovery endpoint
      description: OIDC Discovery Endpoint
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OIDCDiscoveryResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                OPENID_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OPENID_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 1
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/oidc/{OIDCAppName}/.well-known/oauth-authorization-server:
    get:
      operationId: GetOAuthAuthorizationServerMetadataOIDC
      summary: OAuth Authorization Server Metadata (OIDC app)
      description: |
        Returns OAuth 2.0 Authorization Server Metadata (RFC 8414) for the given OIDC app.
        Use this endpoint for OAuth 2.0 client discovery when using the OIDC flow path.
        Response does not include OpenID Connect-specific fields (e.g. userinfo_endpoint, claims_supported).
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthAuthorizationServerMetadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 2
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /oauth/{OAuthAppName}/.well-known/oauth-authorization-server:
    get:
      operationId: GetOAuthAuthorizationServerMetadataOAuth
      summary: OAuth Authorization Server Metadata (OAuth app)
      description: |
        Returns OAuth 2.0 Authorization Server Metadata (RFC 8414) for the given OAuth app.
        Use this endpoint for OAuth 2.0 client discovery when using the OAuth flow path.
      parameters:
        - $ref: '#/components/parameters/OAuthAppName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthAuthorizationServerMetadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth
      x-order: 1
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /oauth/.well-known/oauth-authorization-server:
    get:
      operationId: GetOAuthAuthorizationServerMetadataOAuthNoApp
      summary: OAuth Authorization Server Metadata (no app name)
      description: |
        Returns OAuth 2.0 Authorization Server Metadata (RFC 8414) for the OAuth flow without an app name in the path.
        Issuer and endpoints use the base path /oauth.
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthAuthorizationServerMetadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth
      x-order: 2
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /oidc/.well-known/oauth-authorization-server:
    get:
      operationId: GetOAuthAuthorizationServerMetadataOIDCNoApp
      summary: OAuth Authorization Server Metadata (OIDC, no app name)
      description: |
        Returns OAuth 2.0 Authorization Server Metadata (RFC 8414) for the OIDC flow without an app name in the path.
        Issuer and endpoints use the base path /oidc.
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthAuthorizationServerMetadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 2
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /.well-known/oauth-authorization-server/service/oidc/{OIDCAppName}:
    get:
      operationId: GetOAuthAuthorizationServerMetadataWellKnownOIDC
      summary: OAuth Authorization Server Metadata (well-known URI, OIDC)
      description: |
        Returns OAuth 2.0 Authorization Server Metadata (RFC 8414) using the well-known URI pattern.
        Path format is /.well-known/oauth-authorization-server/service/oidc/{OIDCAppName}.
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthAuthorizationServerMetadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 1
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /.well-known/oauth-authorization-server/service/oauth/{OAuthAppName}:
    get:
      operationId: GetOAuthAuthorizationServerMetadataWellKnownOAuth
      summary: OAuth Authorization Server Metadata (well-known URI, OAuth)
      description: |
        Returns OAuth 2.0 Authorization Server Metadata (RFC 8414) using the well-known URI pattern.
        Path format is /.well-known/oauth-authorization-server/service/oauth/{OAuthAppName}.
      parameters:
        - $ref: '#/components/parameters/OAuthAppName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthAuthorizationServerMetadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OAuth
      x-order: 1
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/oidc/{OIDCAppName}/jwks:
    get:
      operationId: GetOIDCJWKSConfig
      summary: Retrieve JSON Web Key Set
      description: Retrieves the JSON Web Key Set (JWKS) for verifying token signatures.
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWKSResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                OPENID_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OPENID_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 2
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/oidc/{OIDCAppName}/userinfo:
    get:
      operationId: GetOIDCUserinfo
      summary: Retrieve OIDC User info
      description: Retrieves User information using OpenID Connect (OIDC) standards.
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OIDCUserinfoResponse'
            application/jwt:
              schema:
                $ref: '#/components/schemas/OIDCUserinfoJWTResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO'
                ACCESS_TOKEN_REQUIRED_SSO:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED_SSO'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                TOKEN_EXPIRED:
                  $ref: '#/components/examples/TOKEN_EXPIRED'
                TOKEN_INVALID:
                  $ref: '#/components/examples/TOKEN_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                OPENID_CONF_INVALID:
                  $ref: '#/components/examples/OPENID_CONF_INVALID'
                OPENID_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OPENID_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      security:
        - AccessToken: []
        - BearerToken: []
      tags:
        - OIDC
      x-order: 3
    post:
      operationId: GetOIDCUserinfoByPost
      summary: Retrieve OIDC User info via POST
      description: Retrieves User information using OpenID Connect (OIDC) standards via the POST method.
      parameters:
        - $ref: '#/components/parameters/OIDCAppName'
      requestBody:
        $ref: '#/components/requestBodies/OIDCUserinfoRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OIDCUserinfoResponse'
            application/jwt:
              schema:
                $ref: '#/components/schemas/OIDCUserinfoJWTResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO:
                  $ref: '#/components/examples/ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO'
                ACCESS_TOKEN_REQUIRED_SSO:
                  $ref: '#/components/examples/ACCESS_TOKEN_REQUIRED_SSO'
                CONTENT_TYPE_NOT_SUPPORTED:
                  $ref: '#/components/examples/CONTENT_TYPE_NOT_SUPPORTED'
                OAUTH_APP_RESTRICTED:
                  $ref: '#/components/examples/OAUTH_APP_RESTRICTED'
                OAUTH_DANGEROUS_REQUEST:
                  $ref: '#/components/examples/OAUTH_DANGEROUS_REQUEST'
                OAUTH_HOST_NOT_WHITELISTED:
                  $ref: '#/components/examples/OAUTH_HOST_NOT_WHITELISTED'
                OAUTH_TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/OAUTH_TRIAL_PLAN_EXPIRED'
                TOKEN_EXPIRED:
                  $ref: '#/components/examples/TOKEN_EXPIRED'
                TOKEN_INVALID:
                  $ref: '#/components/examples/TOKEN_INVALID'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                OPENID_CONF_INVALID:
                  $ref: '#/components/examples/OPENID_CONF_INVALID'
                OPENID_CONF_NOT_EXIST:
                  $ref: '#/components/examples/OPENID_CONF_NOT_EXIST'
                TOKEN_CONF_INVALID:
                  $ref: '#/components/examples/TOKEN_CONF_INVALID'
                TOKEN_CONF_NOT_EXIST:
                  $ref: '#/components/examples/TOKEN_CONF_NOT_EXIST'
              schema:
                $ref: '#/components/schemas/OAuthErrorResponse'
      tags:
        - OIDC
      x-order: 4
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /service/saml/idp/metadata:
    get:
      operationId: GetSAMLIDPMetadata
      summary: Retrieve SAML IDP metadata
      description: Retrieves metadata for a SAML Identity Provider (IDP).
      parameters:
        - $ref: '#/components/parameters/SamlAppName'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/SamlIdpMetadataResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST_SSO'
                INVALID_HOST:
                  $ref: '#/components/examples/INVALID_HOST'
                SAML_APP_NAME_REQUIRED:
                  $ref: '#/components/examples/SAML_APP_NAME_REQUIRED'
                SP_SAML_CONFIG_NOT_FOUND:
                  $ref: '#/components/examples/SP_SAML_CONFIG_NOT_FOUND'
                SP_SAML_CONFIG_NOT_VALID:
                  $ref: '#/components/examples/SP_SAML_CONFIG_NOT_VALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
                  $ref: '#/components/examples/APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT_SSO'
                SAML_METADATA_RESPONSE_INVALID:
                  $ref: '#/components/examples/SAML_METADATA_RESPONSE_INVALID'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - SAML
      servers:
        - description: LoginRadius Prod Tenant Endpoint
          url: https://{TenantName}.hub.loginradius.com
          variables:
            TenantName:
              default: TenantName
              description: Tenant Name
        - description: LoginRadius Prod Custom Domain Endpoint
          url: https://{CustomDomain}
          variables:
            CustomDomain:
              default: auth.example.com
              description: Tenant Custom Domain Name
  /sso/mobile/generate:
    get:
      operationId: GenerateQRCode
      summary: Retrieve QR code
      description: Retrieves a QR code for Cross Device SSO.
      parameters:
        - $ref: '#/components/parameters/CodeExpiryTTL'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QRCodeResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                API_KEY_NOT_WELL_FORMATTED_SSO:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED_SSO'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED_SSO'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST_SSO'
                EXPIRE_IN_INVALID_FORMAT_SSO:
                  $ref: '#/components/examples/EXPIRE_IN_INVALID_FORMAT_SSO'
                MOBILE_EXPIRY_PARAM_INVALID:
                  $ref: '#/components/examples/MOBILE_EXPIRY_PARAM_INVALID'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_SSO'
                SOMETHING_GOING_WRONG_SSO:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG_SSO'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
      servers:
        - description: LoginRadius Cloud API Endpoint
          url: https://cloud-api.loginradius.com
      tags:
        - Cross Device SSO
      x-order: 1
  /sso/mobile/token:
    get:
      operationId: GetAccessTokenByPing
      summary: Retrieve Access Token by ping
      description: Retrieves an Access Token by ping after a User scans a QR code during mobile login.
      parameters:
        - $ref: '#/components/parameters/QRCode'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenByPingQRCodeResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                API_KEY_NOT_WELL_FORMATTED_SSO:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED_SSO'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED_SSO'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST_SSO'
                MOBILE_ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO:
                  $ref: '#/components/examples/MOBILE_ACCESS_TOKEN_INVALID_OR_EXPIRED'
                MOBILE_CODE_NOT_VALID_OR_EXPIRED:
                  $ref: '#/components/examples/MOBILE_CODE_NOT_VALID_OR_EXPIRED'
                MOBILE_CODE_REQUIRED:
                  $ref: '#/components/examples/MOBILE_CODE_REQUIRED'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_SSO'
                SOMETHING_GOING_WRONG_SSO:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG_SSO'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
      servers:
        - description: LoginRadius Cloud API Endpoint
          url: https://cloud-api.loginradius.com
      tags:
        - Cross Device SSO
      x-order: 3
    post:
      operationId: MapQRCodeToAccessToken
      summary: Map QR code to Access Token
      description: Maps a scanned QR code to an Access Token during mobile login.
      requestBody:
        $ref: '#/components/requestBodies/QRCodeMapToTokenRequest'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QRCodeMapToTokenResponse'
        '400':
          description: 'Status Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              examples:
                API_KEY_NOT_WELL_FORMATTED_SSO:
                  $ref: '#/components/examples/API_KEY_NOT_WELL_FORMATTED_SSO'
                API_KEY_REQUIRED:
                  $ref: '#/components/examples/API_KEY_REQUIRED_SSO'
                CODE_AND_TOKEN_REQUIRED:
                  $ref: '#/components/examples/CODE_AND_TOKEN_REQUIRED'
                DANGEROUS_REQUEST:
                  $ref: '#/components/examples/DANGEROUS_REQUEST_SSO'
                INVALID_POST_BODY:
                  $ref: '#/components/examples/INVALID_POST_BODY'
                MOBILE_CODE_NOT_VALID_OR_EXPIRED:
                  $ref: '#/components/examples/MOBILE_CODE_NOT_VALID_OR_EXPIRED'
                MOBILE_CODE_REQUIRED:
                  $ref: '#/components/examples/MOBILE_CODE_REQUIRED'
                POST_BODY_INVALID:
                  $ref: '#/components/examples/POST_BODY_INVALID_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Status Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              examples:
                ACCESS_TOKEN_NOT_VALID:
                  $ref: '#/components/examples/ACCESS_TOKEN_NOT_VALID_SSO'
                API_KEY_NOT_VALID:
                  $ref: '#/components/examples/API_KEY_NOT_VALID_SSO'
                SOMETHING_GOING_WRONG_SSO:
                  $ref: '#/components/examples/SOMETHING_GOING_WRONG_SSO'
                TRIAL_PLAN_EXPIRED:
                  $ref: '#/components/examples/TRIAL_PLAN_EXPIRED_SSO'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
      servers:
        - description: LoginRadius Cloud API Endpoint
          url: https://cloud-api.loginradius.com
      tags:
        - Cross Device SSO
      x-order: 2
  /bulk/upsert:
    post:
      summary: Batch upload Users
      operationId: BatchUpload
      description: Uploads an array of Users with optional Password and migration configuration.
      tags:
        - User Migration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpload'
            examples:
              b2cBatchUplaod:
                $ref: '#/components/examples/b2cBatchUplaod'
              b2cBatchUplaodWithPasswordConfig:
                $ref: '#/components/examples/b2cBatchUplaodWithPasswordConfig'
              b2cDeltaBatchUplaod:
                $ref: '#/components/examples/b2cDeltaBatchUplaod'
              b2bBatchUplaod:
                $ref: '#/components/examples/b2bBatchUplaod'
              b2bBatchUplaodWithPasswordConfig:
                $ref: '#/components/examples/b2bBatchUplaodWithPasswordConfig'
              b2bDeltaBatchUplaod:
                $ref: '#/components/examples/b2bDeltaBatchUplaod'
              b2bBatchUplaodOnlyOrgs:
                $ref: '#/components/examples/b2bBatchUplaodOnlyOrgs'
              b2bBatchUplaodOnlyRoles:
                $ref: '#/components/examples/b2bBatchUplaodOnlyRoles'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUploadResponse'
              examples:
                success:
                  $ref: '#/components/examples/batchUploadSuccess'
                partial_success:
                  $ref: '#/components/examples/batchUploadPartialSuccess'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUploadErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                SUBKEYLENGTH_RANGE:
                  $ref: '#/components/examples/SUBKEYLENGTH_RANGE'
                SALTKEYLENGTH_RANGE:
                  $ref: '#/components/examples/SALTKEYLENGTH_RANGE'
                INVALID_PASSWORD_HASH_CONFIG:
                  $ref: '#/components/examples/INVALID_PASSWORD_HASH_CONFIG'
                INITIAL_PROFILE_BODY_VALIDATIONS:
                  $ref: '#/components/examples/ValidateIdentity'
                B2B_ORG_AND_ROLE_VALIDATION:
                  $ref: '#/components/examples/B2B_ORG_AND_ROLE_VALIDATION'
                IDENTITY_VALIDATION_ERRORS:
                  $ref: '#/components/examples/IDENTITY_VALIDATION_ERRORS'
                BATCH_MIGRATION_TOO_MANY_RECORDS:
                  $ref: '#/components/examples/BATCH_MIGRATION_TOO_MANY_RECORDS'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                MIGRATION_FAILED:
                  $ref: '#/components/examples/MIGRATION_FAILED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
      servers:
        - description: LoginRadius Migration Endpoint
          url: https://migration.loginradius.com/v2
      security:
        - APIKey: []
          APISecret: []
  /consent/options:
    get:
      summary: Retrieve Consent Options
      operationId: GetConsentOptions
      description: Lists all consent options available for a specific Tenant.
      security:
        - M2MBearerToken: []
      tags:
        - Consent
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ConsentOptions'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CONSENT_MANAGEMENT_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_MANAGEMENT_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    post:
      summary: Create Consent Option
      operationId: CreateConsentOption
      security:
        - M2MBearerToken: []
      description: Creates a new consent option for a specific Tenant.
      tags:
        - Consent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentOptionModel'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentOptions'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CONSENT_MANAGEMENT_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_MANAGEMENT_NOT_ENABLED'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_OPTION_ID_ALREADY_EXISTS:
                  $ref: '#/components/examples/CONSENT_OPTION_ID_ALREADY_EXISTS'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /consent/options/{optionId}:
    delete:
      summary: Delete Consent Option
      operationId: DeleteConsentOption
      description: Deletes the consent option identified by the option ID for the Tenant.
      security:
        - M2MBearerToken: []
      tags:
        - Consent
      parameters:
        - $ref: '#/components/parameters/OptionId'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CONSENT_MANAGEMENT_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_MANAGEMENT_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_OPTION_NOT_FOUND:
                  $ref: '#/components/examples/CONSENT_OPTION_NOT_FOUND'
        '409':
          description: 'Conflict: The request could not be completed due to a conflict with the current state of the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_OPTION_IN_USE:
                  $ref: '#/components/examples/CONSENT_OPTION_IN_USE'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /consent/forms:
    get:
      summary: Retrieve Consent Forms
      description: Retrieves all Consent Forms configured for the Tenant.
      operationId: GetConsentForms
      security:
        - M2MBearerToken: []
      tags:
        - Consent
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ConsentForm'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CONSENT_MANAGEMENT_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_MANAGEMENT_NOT_ENABLED'
        '500':
          description: 'Internal Server Error: An unexpected error occurred.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
    post:
      summary: Add Consent Form
      description: Adds a new Consent Form for the Tenant.
      operationId: AddConsentForm
      security:
        - M2MBearerToken: []
      tags:
        - Consent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentFormModel'
      responses:
        '200':
          description: 'Created: The Consent Form was successfully created.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentForm'
        '400':
          description: 'Bad Request: The request was invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JSON_POST_BODY_REQUIRED:
                  $ref: '#/components/examples/JSON_POST_BODY_REQUIRED'
                PARAMETER_NOT_WELL_FORMATTED:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED'
                CONSENT_OPTION_INVALID:
                  $ref: '#/components/examples/CONSENT_OPTION_INVALID'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CONSENT_MANAGEMENT_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_MANAGEMENT_NOT_ENABLED'
        '409':
          description: 'Conflict: The Consent Form already exists.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_FORM_ALREADY_EXISTS_FOR_EVENT_START_DATE:
                  $ref: '#/components/examples/CONSENT_FORM_ALREADY_EXISTS_FOR_EVENT_START_DATE'
        '500':
          description: 'Internal Server Error: An unexpected error occurred.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /consent/forms/{version}:
    delete:
      summary: Delete Consent Form
      operationId: DeleteConsentForm
      description: Deletes the Consent Form identified by the form version for the Tenant.
      security:
        - M2MBearerToken: []
      tags:
        - Consent
      parameters:
        - $ref: '#/components/parameters/FormVersion'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsDeleted'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PARAMETER_NOT_WELL_FORMATTED_INVALID_VERSION:
                  $ref: '#/components/examples/PARAMETER_NOT_WELL_FORMATTED_INVALID_VERSION'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CONSENT_MANAGEMENT_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_MANAGEMENT_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_FORM_NOT_FOUND:
                  $ref: '#/components/examples/CONSENT_FORM_NOT_FOUND'
        '410':
          description: 'Gone: The resource requested is no longer available and will not be available again.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_FORM_ALREADY_DELETED:
                  $ref: '#/components/examples/CONSENT_FORM_ALREADY_DELETED'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /consent/forms/active:
    get:
      summary: Retrieve Active Consent Forms
      operationId: GetActiveConsentForms
      description: Retrieves a list of active Consent Forms configured for the Tenant.
      security:
        - M2MBearerToken: []
      tags:
        - Consent
      parameters:
        - $ref: '#/components/parameters/Event'
      responses:
        '200':
          description: 'OK: The request was successful.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ConsentForm'
        '403':
          description: 'Forbidden: The client does not have permission to access the resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED_ACCESS:
                  $ref: '#/components/examples/UNAUTHORIZED_ACCESS'
                CONSENT_MANAGEMENT_NOT_ENABLED:
                  $ref: '#/components/examples/CONSENT_MANAGEMENT_NOT_ENABLED'
        '404':
          description: 'Not found: The server cannot find the requested resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CONSENT_FORMS_NOT_FOUND:
                  $ref: '#/components/examples/CONSENT_FORMS_NOT_FOUND'
        '500':
          description: 'Internal Server Error: The server encountered an unexpected error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                OPERATION_FAILED:
                  $ref: '#/components/examples/OPERATION_FAILED_PARTNER'
  /sso/bigcommerce/auth:
    get:
      summary: BigCommerce OAuth Authorization
      operationId: BigCommerceAuth
      description: Handles BigCommerce OAuth authorization callbacks. Accepts either an authorization code (for install flow) or a signed_payload (for load/uninstall callbacks). Returns an HTML page on success.
      tags:
        - BigCommerce SSO
      servers:
        - url: https://{domain}.hub.loginradius.com
          description: LoginRadius Hosted Plugins Server
          variables:
            domain:
              default: example
              description: LoginRadius Tenant Name
      parameters:
        - $ref: '#/components/parameters/BigCommerceCode'
        - $ref: '#/components/parameters/BigCommerceSignedPayload'
      responses:
        '200':
          description: 'OK: Authorization successful, returns HTML page.'
          content:
            text/html:
              schema:
                type: string
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /sso/bigcommerce/api/token:
    get:
      summary: Generate BigCommerce Login URL (GET)
      operationId: GetBigCommerceLoginUrl
      description: Generates a BigCommerce customer login URL using the provided LoginRadius access token. If the customer does not exist in BigCommerce, it creates one. Returns a login URL that can be used to authenticate the user into BigCommerce.
      tags:
        - BigCommerce SSO
      servers:
        - url: https://{domain}.hub.loginradius.com
          description: LoginRadius Hosted Plugins Server
          variables:
            domain:
              default: example
              description: LoginRadius Tenant Name
      parameters:
        - $ref: '#/components/parameters/AccessTokenRequired'
        - $ref: '#/components/parameters/BigCommerceStore'
        - $ref: '#/components/parameters/PasswordQuery'
        - $ref: '#/components/parameters/ReturnUrl'
      responses:
        '200':
          description: 'OK: BigCommerce login URL generated successfully.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigCommerceLoginUrlResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 'Unauthorized: The API key or access token is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Forbidden: The request is not allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
    post:
      summary: Generate BigCommerce Login URL (POST)
      operationId: PostBigCommerceLoginUrl
      description: Generates a BigCommerce customer login URL using the provided LoginRadius access token sent in the request body. If the customer does not exist in BigCommerce, it creates one. Returns a login URL that can be used to authenticate the user into BigCommerce.
      tags:
        - BigCommerce SSO
      servers:
        - url: https://{domain}.hub.loginradius.com
          description: LoginRadius Hosted Plugins Server
          variables:
            domain:
              default: example
              description: LoginRadius Tenant Name
      parameters:
        - $ref: '#/components/parameters/BigCommerceStore'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BigCommerceTokenPostRequest'
      responses:
        '200':
          description: 'OK: BigCommerce login URL generated successfully.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigCommerceLoginUrlResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 'Unauthorized: The API key or access token is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Forbidden: The request is not allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
  /sso/bigcommerce/api/validatepassword:
    post:
      summary: Validate BigCommerce Customer Password
      operationId: ValidateBigCommercePassword
      description: Validates a BigCommerce customer's password by checking the provided email and password against the BigCommerce store's customer records.
      tags:
        - BigCommerce SSO
      servers:
        - url: https://{domain}.hub.loginradius.com
          description: LoginRadius Hosted Plugins Server
          variables:
            domain:
              default: example
              description: LoginRadius Tenant Name
      parameters:
        - $ref: '#/components/parameters/BigCommerceStore'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BigCommerceValidatePasswordRequest'
      responses:
        '200':
          description: 'OK: Password validation result returned.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigCommerceValidatePasswordResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 'Unauthorized: The API key is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Forbidden: The request is not allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
  /sso/shopify/api/token:
    get:
      summary: Generate Shopify Multipass Login URL
      operationId: GetShopifyLoginUrl
      description: Generates a Shopify Multipass login URL using the provided LoginRadius access token. Uses Shopify's Multipass feature to create a single sign-on URL that authenticates the user into the Shopify store.
      tags:
        - Shopify SSO
      servers:
        - url: https://{domain}.hub.loginradius.com
          description: LoginRadius Hosted Plugins Server
          variables:
            domain:
              default: example
              description: LoginRadius Tenant Name
      parameters:
        - $ref: '#/components/parameters/AccessTokenRequired'
        - $ref: '#/components/parameters/ShopifyStore'
        - $ref: '#/components/parameters/ReturnUrl'
      responses:
        '200':
          description: 'OK: Shopify Multipass login URL generated successfully.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShopifyLoginUrlResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 'Unauthorized: The API key or access token is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Forbidden: The request is not allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
  /sso/perfectmind/session:
    get:
      summary: Generate PerfectMind Login Session
      operationId: GetPerfectMindSession
      description: Generates a PerfectMind login session using the provided LoginRadius access token. Returns a session ID and URL that can be used to authenticate the user into the PerfectMind platform.
      tags:
        - PerfectMind SSO
      servers:
        - url: https://{domain}.hub.loginradius.com
          description: LoginRadius Hosted Plugins Server
          variables:
            domain:
              default: example
              description: LoginRadius Tenant Name
      parameters:
        - $ref: '#/components/parameters/AccessTokenRequired'
        - $ref: '#/components/parameters/PerfectMindSiteName'
      responses:
        '200':
          description: 'OK: PerfectMind session generated successfully.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerfectMindSessionResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 'Unauthorized: The API key or access token is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Forbidden: The request is not allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
  /sso/perfectmind/contact:
    get:
      summary: Get PerfectMind Contact IDs
      operationId: GetPerfectMindContact
      description: Retrieves PerfectMind contact IDs associated with the user's email address. Uses the LoginRadius access token to look up the user and match them against PerfectMind contacts using email and birth date.
      tags:
        - PerfectMind SSO
      servers:
        - url: https://{domain}.hub.loginradius.com
          description: LoginRadius Hosted Plugins Server
          variables:
            domain:
              default: example
              description: LoginRadius Tenant Name
      parameters:
        - $ref: '#/components/parameters/AccessTokenRequired'
        - $ref: '#/components/parameters/PerfectMindSiteName'
        - $ref: '#/components/parameters/BirthDate'
        - $ref: '#/components/parameters/PerfectScanID'
      responses:
        '200':
          description: 'OK: PerfectMind contact information retrieved successfully.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerfectMindContactResponse'
        '400':
          description: 'Bad Request: The request could not be understood by the server due to malformed syntax.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 'Unauthorized: The API key or access token is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Forbidden: The request is not allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKey: []
        - XLoginRadiusAPIKey: []
components:
  securitySchemes:
    AccessToken:
      description: Access Token in QueryString
      in: query
      name: access_token
      type: apiKey
    BearerToken:
      type: http
      scheme: bearer
      description: Bearer token for user authentication
    APIKey:
      type: apiKey
      name: apikey
      in: query
      description: Tenant API Key for authentication
    APISecret:
      type: apiKey
      name: apisecret
      in: query
      description: Tenant API Secret for authentication
    ClientId:
      type: apiKey
      name: client_id
      in: query
      description: Application Client ID for authentication
    ClientSecret:
      type: apiKey
      name: client_secret
      in: query
      description: Application Client Secret for authentication
    M2MBearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: M2M Token for authentication
    Digest:
      type: apiKey
      name: digest
      in: header
      description: Request Signing Digest for authentication
    XRequestExpiresTime:
      type: apiKey
      name: X-Request-Expires
      in: header
      description: Request expiry time for API authentication
    ApiSecret:
      type: apiKey
      in: query
      name: secret
    XLoginRadiusAPISecret:
      type: apiKey
      in: header
      name: X-LoginRadius-ApiSecret
    XLoginRadiusAPIKey:
      type: apiKey
      in: header
      name: X-LoginRadius-ApiKey
  parameters:
    GoogleRecaptchaResponse:
      name: g-recaptcha-response
      in: query
      required: false
      schema:
        type: string
      description: Google reCAPTCHA response parameter which will be sent to the server for verification.
      example: 03AGdBq24e1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2v3w4x5y6z7a8b9c0d1e2f3g4h5i6j7k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z3a4b5c6d7e8f9g0h1i2j3k4l5m6n7o8p9q0r1s2t3u4v5w6x7y8z9
    GoogleRecaptchaResponseAlt:
      name: g_recaptcha_response
      in: query
      required: false
      schema:
        type: string
      description: Google reCAPTCHA Response
      example: 03AGdBq24e1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2v3w4x5y6z7a8b9c0d1e2f3g4h5i6j7k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z3a4b5c6d7e8f9g0h1i2j3k4l5m6n7o8p9q0r1s2t3u4v5w6x7y8z9
    PreventWebhook:
      name: prevent_webhook
      in: query
      required: false
      schema:
        type: boolean
      description: When true, suppresses webhook events for this operation.
      example: true
    XPreventWebhook:
      name: X-PreventWebhook
      in: header
      required: false
      schema:
        type: boolean
      description: When true, suppresses webhook events for this operation.
      example: true
    HCaptchaResponse:
      name: h-captcha-response
      in: query
      required: false
      schema:
        type: string
      description: hCaptcha Response
      example: 03AGdBq24e1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2v3w4x5y6z7a8b9c0d1e2f3g4h5i6j7k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z3a4b5c6d7e8f9g0h1i2j3k4l5m6n7o8p9q0r1s2t3u4v5w6x7y8z9
    QQCaptchaTicket:
      name: qq_captcha_ticket
      in: query
      required: false
      schema:
        type: string
      description: QQ Captcha ticket (required if Bot Protection is enabled)
      example: 03AGdBq24eJ9O8dpLsw0Pr0OTtWfkmK34K0jQde
    QQCaptchaRandstr:
      name: qq_captcha_randstr
      in: query
      required: false
      schema:
        type: string
      description: QQ Captcha rand string (required if Bot Protection is enabled)
      example: 03AGdBq24eJ9O8dpLsw0Pr0OTtWfkmK34K0jQde
    EmailTemplate:
      name: emailtemplate
      in: query
      required: false
      schema:
        type: string
      description: Name of the Email template to use for this notification.
      example: Email-Template
    ResetPasswordUrl:
      name: resetpasswordurl
      in: query
      required: false
      schema:
        type: string
      description: Callback URL for the Password Reset link in the Email.
      example: https://example.com/resetpassword
    QQRecaptchaTicket:
      name: qq_recaptcha_ticket
      in: query
      required: false
      schema:
        type: string
      description: QQ reCAPTCHA Response
      example: 03AGdBq24e1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2v3w4x5y6z7a8b9c0d1e2f3g4h5i6j7k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z3a4b5c6d7e8f9g0h1i2j3k4l5m6n7o8p9q0r1s2t3u4v5w6x7y8z9
    QQRecaptchaRandstr:
      name: qq_recaptcha_randstr
      in: query
      required: false
      schema:
        type: string
      description: QQ reCAPTCHA Response
      example: 03AGdBq24e1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2v3w4x5y6z7a8b9c0d1e2f3g4h5i6j7k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z3a4b5c6d7e8f9g0h1i2j3k4l5m6n7o8p9q0r1s2t3u4v5w6x7y8z9
    AccessToken:
      name: access_token
      in: query
      description: Access Token of the User
      required: false
      style: form
      explode: true
      schema:
        type: string
      example: 493318dd-487a-439b-8302-5e27f1110244
    SmsTemplate:
      name: smstemplate
      in: query
      required: false
      schema:
        type: string
      description: SMS Template
      example: SMS-Template
    IsVoiceOtp:
      name: isvoiceotp
      in: query
      required: false
      schema:
        type: boolean
      description: Boolean flag to enforce sending SMS content via Voice.
      example: true
    VerificationUrl:
      name: verificationurl
      in: query
      required: false
      schema:
        type: string
      description: Verification URL for the User which will be included in the Email template..
      example: https://example.com/verify?token=123456
    Sott:
      name: sott
      in: query
      required: false
      schema:
        type: string
      description: SOTT should be generated from the server side and passed here or in the X-LoginRadius-Sott header.
      example: UIsmfxExgK9McHpzD+rGVaV7UtZkZiptaz5WVYqY9W9nzW1JJ2J/vYbeQZJPNMzOs1o1gLfd+Ays87hyphDWsqFBzJv3wBNfNLVZJdAK/HE=*b8ca7b7afcca0254b8cfdce843dc6253
    WelcomeEmailTemplate:
      name: welcomeemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: Welcome Email Template
      example: Welcome-Email-Template
    Fields:
      name: fields
      in: query
      description: Comma-separated list of profile fields to include in the response.
      required: false
      style: form
      explode: true
      schema:
        type: string
      example: Email,username
    X-LoginRadius-Sott:
      name: X-LoginRadius-Sott
      in: header
      schema:
        type: string
      description: SOTT should be generated from the server side and passed here or in sott query parameter.
      example: UIsmfxExgK9McHpzD+rGVaV7UtZkZiptaz5WVYqY9W9nzW1JJ2J/vYbeQZJPNMzOs1o1gLfd+Ays87hyphDWsqFBzJv3wBNfNLVZJdAK/HE=*b8ca7b7afcca0254b8cfdce843dc6253
    Options:
      name: options
      in: query
      required: false
      schema:
        type: string
      description: Options value will be passed when don't want to send the Email to the User for the verification, i.e. preventverificationemail
      example: preventverificationemail
    InvitationToken:
      name: invitation_token
      in: query
      required: false
      schema:
        type: string
      description: Invitation token of an organization
      example: f7e7e0c9-cd54-426f-97a7-5ebd846ddcc5
    PasskeyIdentifier:
      name: identifier
      in: query
      description: Email of the User
      required: true
      style: form
      schema:
        type: string
      example: test@example.com
    LoginUrl:
      name: loginurl
      in: query
      required: false
      schema:
        type: string
      description: Login URL for the User which will come in the login logs from where the User logged in.
      example: https://example.com/login
    BreachedPasswordEmailTemplate:
      name: breachedpasswordemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: Email template name for breached Password notifications.
      example: Breached-PasswordEmail-Template
    BreachedPasswordSmsTemplate:
      name: breachedpasswordsmstemplate
      in: query
      required: false
      schema:
        type: string
      description: SMS template name for breached Password notifications.
      example: Breached-PasswordSMS-Template
    RbaBrowserEmailTemplate:
      name: rbabrowseremailtemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
      example: RBA-Browser-Email-Template
    RbaOneClickEmailTemplate:
      name: rbaoneclickemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA one click Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA is enabled for the Tenant with one click sign in as a MFA option.
      example: RBA-One-Click-Email-Template
    RbaCityEmailTemplate:
      name: rbacityemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
      example: RBA-City-Email-Template
    RbaCountryEmailTemplate:
      name: rbacountryemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
      example: RBA-Country-Email-Template
    RbaIPEmailTemplate:
      name: rbaipemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
      example: RBA-IP-Email-Template
    RbaDeviceEmailTemplate:
      name: rbadeviceemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
      example: RBA-Device-Email-Template
    RbaOtpSMSTemplate:
      name: rbaotpsmstemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA OTP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
      example: RBA-OTP-SMS-Template
    RbaBrowserSMSTemplate:
      name: rbabrowsersmstemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
      example: RBA-Browser-SMS-Template
    RbaCitySMSTemplate:
      name: rbacitysmstemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
      example: RBA-City-SMS-Template
    RbaCountrySMSTemplate:
      name: rbacountrysmstemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
      example: RBA-Country-SMS-Template
    RbaIPSMSTemplate:
      name: rbaipsmstemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
      example: RBA-IP-SMS-Template
    RbaDeviceSMSTemplate:
      name: rbadevicesmstemplate
      in: query
      required: false
      schema:
        type: string
      description: RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
      example: RBA-Device-SMS-Template
    EmailTemplate2FA:
      name: emailtemplate2fa
      in: query
      required: false
      schema:
        type: string
      description: Name of the 2FA Email template to use for this notification.
      example: Email-Template
    DuoRedirectUri:
      name: duoredirecturi
      in: query
      required: false
      schema:
        type: string
      description: Duo auth redirection url.
      example: https://example.com/duo/callback
    Email:
      name: email
      in: query
      required: false
      schema:
        type: string
        format: email
      description: Email address of the associated Account.
      example: test@gmail.com
    VerificationToken:
      name: verificationtoken
      in: query
      required: false
      schema:
        type: string
      description: Verification token received in the Email.
      example: '123456'
    Otp:
      name: otp
      in: query
      required: false
      schema:
        type: string
      description: One-time passcode sent to the User's Email.
      example: '123456'
    Uuid:
      name: uuid
      in: query
      required: false
      schema:
        type: string
      description: Email template for the welcome Email.
      example: Welcome-Email-Template
    Url:
      name: url
      in: query
      required: false
      schema:
        type: string
      description: URL to log the main domain in the database.
      example: https://example.com
    SecondFactorToken:
      name: secondfactorauthenticationtoken
      in: query
      required: true
      schema:
        type: string
      description: Second factor token
      example: 4asdf575-5678-4065-b717-fa0n7i5ca81a
    ClientGuid:
      name: clientguid
      in: query
      required: false
      schema:
        type: string
      description: Client GUID for the request.
      example: 12345678-1234-1234-1234-123456789012
    DeleteToken:
      name: deletetoken
      in: query
      required: false
      schema:
        type: string
      description: This is required if the OTP is not passed in the query parameter.
      example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    PreventRefresh:
      name: preventRefresh
      in: query
      required: false
      schema:
        type: boolean
      description: Whether to prevent the token from being refreshed (true/false).
      example: true
    Username:
      name: username
      in: query
      required: false
      schema:
        type: string
      description: Username of the associated Account.
      example: testuser
    NullSupport:
      name: nullsupport
      in: query
      description: Bool flag, if this flag is sent as true then the fields which are send in payload as null then in the profile as well that will be saved as null only
      required: false
      style: form
      explode: true
      schema:
        type: boolean
      example: true
    DeleteUrl:
      name: deleteurl
      in: query
      description: DeleteUrl URL which is being sent in the Email
      required: false
      style: form
      explode: true
      schema:
        type: string
      example: https://example.com/deleteurl
    passkeyId:
      name: passkeyId
      in: path
      description: Id asscociated with the Passkey
      required: true
      schema:
        type: string
      example: 133f5cf974b94726a6a7cebec917765c
    EmailId:
      name: emailid
      in: query
      required: false
      schema:
        type: string
        format: email
      description: The Email address of User
      example: test@gmail.com
    ResetPasskeyUrl:
      name: resetpasskeyurl
      in: query
      required: false
      schema:
        type: string
      description: Reset Passkey URL
      example: https://example.com/resetpasskey
    VToken:
      name: vtoken
      in: query
      required: false
      schema:
        type: string
      description: Verification token received in the Email.
      example: '123456'
    RedirectUrl:
      name: redirecturl
      in: query
      required: false
      schema:
        type: string
      description: The URL to which the User will be redirected after completing the operation, such as login or verification.
      example: https://example.com/redirect
    OneTouchLoginEmailTemplate:
      name: onetouchloginemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: One Touch Login Email Template
      example: One-Touch-Login-Email-Template
    SMSTemplate2FA:
      name: smstemplate2fa
      in: query
      required: false
      schema:
        type: string
      description: SMS template name to be used for sending the 2FA code to the User.
      example: SMS-Template
    ReAuthType:
      name: type
      in: path
      required: true
      schema:
        type: string
        enum:
          - backupcode
          - otp
          - googleauthenticatorcode
          - authenticatorcode
      description: The method of ReAuth MFA verification to use.
      example: otp
    Phone:
      name: phone
      in: query
      required: false
      schema:
        type: string
        format: phone
      description: Phone ID of the associated Account.
      example: '+1234567890'
    SmartLoginEmailTemplate:
      name: smartloginemailtemplate
      in: query
      required: false
      schema:
        type: string
      description: The template name for the smart login Email.
      example: Smart-Login-Email-Template
    ClientGuidRequired:
      name: clientguid
      in: query
      required: true
      schema:
        type: string
      description: Client GUID for the request.
      example: 12345678-1234-1234-1234-123456789012
    PasswordlessLoginTemplate:
      name: passwordlesslogintemplate
      in: query
      required: false
      schema:
        type: string
      description: Passwordless Login Template
      example: Passwordless-Login-Template
    SessionTokenQuery:
      name: session_token
      in: query
      required: true
      schema:
        type: string
      description: Session Token for PIN Auth
      example: 4asdf575-5678-4065-b717-fa0n7i5ca81a
    CustomObjectId:
      name: customobjectid
      in: query
      description: Unique identifier for the Custom Object record
      required: false
      schema:
        type: string
      example: customObject12
    ObjectName:
      name: objectname
      in: query
      description: Name of the Custom Object to be used in the request. The name should match the Custom Object configured in your LoginRadius account.
      required: false
      schema:
        type: string
      example: customObjectName1
    ObjectRecordId:
      name: objectrecordid
      in: path
      description: Unique identifier for the Custom Object record. The ID is used to target a specific Custom Object.
      required: true
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    UpdateType:
      name: updateType
      description: |
        The type of update to be performed on the Custom Object. This parameter is used to specify whether the update should be a full update or a partial update.
      in: query
      required: true
      schema:
        type: string
        enum:
          - partialreplace
          - replace
          - default
      example: partialreplace
    PinAuthTokenQuery:
      name: pinauthtoken
      in: query
      required: true
      schema:
        type: string
      description: Pin auth token to set the PIN on account
      example: 6******2-3**8-4**5-8**d-3**********9
    ResetPinURL:
      name: resetpinurl
      in: query
      required: false
      schema:
        type: string
      description: Reset PIN URL
      example: https://example.com/resetpin
    ConsentToken:
      name: consenttoken
      in: query
      required: true
      schema:
        type: string
      description: The consent token for the User.
      example: 8f2e1c3a-ab10-498c-8b12-a5b7c9e18dfc
    Event:
      name: event
      in: query
      description: Event type to filter consent verification (e.g., `login`).
      required: true
      schema:
        type: string
      example: login
    IsCustom:
      name: iscustom
      in: query
      description: This field value is used to filter the consent verification by custom events. The iscustom value should be a boolean. If true, it filters for custom events; if false, it filters for standard events.
      required: true
      schema:
        type: boolean
      example: true
    InvitationTokenPath:
      name: invitation_token
      in: path
      required: true
      description: The token of the invitation to retrieve.
      schema:
        type: string
      example: inv_aH840_snjODabaji
    tokenType:
      name: tokentype
      in: path
      description: 'Token purpose: `emailverification`, `forgotpin`, `addemail`, `deleteuser`, `onetouchlogin`, or `autologin`.'
      required: true
      schema:
        type: string
        enum:
          - emailverification
          - forgotpin
          - addemail
          - deleteuser
          - onetouchlogin
          - autologin
      example: emailverification
    smsOtpType:
      name: smsotptype
      in: path
      description: 'OTP purpose: `addphone`, `phoneidverification`, `forgotpassword`, `forgotpin`, `onetouchlogin`, `smartlogin`, `passwordlesslogin`, or `deleteuser`.'
      required: true
      schema:
        type: string
        enum:
          - addphone
          - phoneidverification
          - forgotpassword
          - forgotpin
          - onetouchlogin
          - smartlogin
          - passwordlesslogin
          - deleteuser
      example: addphone
    UidPathParam:
      name: uid
      in: path
      description: UID of the User
      required: true
      schema:
        type: string
      example: 680fada271a140ebc0716144
    ContextName:
      name: contextName
      in: path
      description: Name of the Role Context
      required: true
      schema:
        type: string
      example: Home
    UidQueryParam:
      name: uid
      in: query
      description: The UID associated with the User
      required: true
      schema:
        type: string
      example: 43e4417bd2de4a1fa82445274f864203
    RefreshToken:
      name: refresh_token
      description: Refresh Token
      in: query
      required: true
      schema:
        type: string
        description: The refresh token is a long-lived token that can be used to obtain a new Access Token without requiring the User to re-authenticate. It is typically issued alongside the Access Token during the initial authentication process and can be used to refresh the Access Token when it expires.
      example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    UidPath:
      name: uid
      in: path
      description: The UID associated with the User
      required: true
      schema:
        type: string
      example: 43e4417bd2de4a1fa82445274f864203
    QParam:
      name: q
      in: query
      required: false
      schema:
        type: string
      description: Query filter in `key:value` format. The key must be an indexed profile field.
      example: ID:1234567890
    SendEmail:
      name: sendemail
      in: query
      required: false
      schema:
        type: string
        enum:
          - 'true'
          - 'false'
      description: Indicates whether to send an Email with the forgot Password token.
      example: 'true'
    VType:
      name: vtype
      in: query
      required: true
      schema:
        type: string
        enum:
          - email
      description: The type of verification. Currently, only "Email" is supported.
      example: email
    ExpireIn:
      name: expires_in
      in: query
      required: false
      schema:
        type: string
        description: The expiration time for the token in seconds.
      example: '3600'
    IsWeb:
      name: isweb
      in: query
      description: Indicates if the request is from a web client
      required: false
      schema:
        type: string
      example: 'true'
    ExpiresIn:
      name: expiresin
      in: query
      description: The expiration time of the Access Token in seconds.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        format: int32
      example: 43333
    Token:
      name: token
      in: query
      required: true
      schema:
        type: string
        description: Access Token of the User.
      example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    AccessTokenRequired:
      name: access_token
      in: query
      description: Access Token of the User
      required: true
      schema:
        type: string
      example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    TokenNotRequired:
      name: token
      in: query
      required: false
      schema:
        type: string
        description: Access Token of the User.
      example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    ProfileId:
      name: profileid
      in: query
      description: Account ID of the User
      required: false
      schema:
        type: string
      example: 1234567890abcdef
    AccountId:
      name: accountid
      in: query
      description: Account ID of the User
      required: false
      schema:
        type: string
      example: 1234567890abcdef
    NativeProvider:
      name: nativeProvider
      in: path
      description: Indicates the provider for the native application. This parameter is used to specify the authentication provider for the native app.
      required: true
      schema:
        type: string
        enum:
          - applejwt
          - applert
          - facebookjwt
          - apple
          - jwt
          - facebook
          - foursquare
          - google
          - googlejwt
          - linkedin
          - twitter
          - wechat
          - qq
      example: google
    SocialAppName:
      name: socialappname
      in: query
      description: Indicates the name of the social application. This parameter is used to specify the social app for which the Access Token is being requested.
      required: false
      schema:
        type: string
      example: facebook_1
    RedirectUri:
      name: redirect_uri
      in: query
      description: The URI to redirect to after authentication. This parameter is used to specify the redirect URI for the native application.
      required: false
      schema:
        type: string
        format: uri
      example: https://example.com/callback
    ProviderName:
      name: providername
      in: query
      description: The name of the provider. This parameter is used to specify the provider for authentication.
      required: false
      schema:
        type: string
      example: google
    Code:
      name: code
      in: query
      description: The authorization code received from the apple, wechat, qq provider. The parameter is used to exchange the authorization code for an Access Token.
      required: false
      schema:
        type: string
        format: uuid
      example: 683987c4-9249-4165-b1f1-925f0b84021e
    TwitterToken:
      name: tw_access_token
      in: query
      description: The Access Token used for Twitter authentication. The parameter is used to authenticate the User with Twitter.
      required: false
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    TwitterSecret:
      name: tw_token_secret
      in: query
      description: The secret token used for Twitter authentication. The parameter is used to authenticate the User with Twitter.
      required: false
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    GoogleAuthCode:
      name: google_authcode
      in: query
      description: The authorization code received from Google. This parameter is used to exchange the authorization code for an Access Token.
      required: false
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    ClientId:
      name: client_id
      in: query
      required: false
      schema:
        type: string
      description: OIDC application Client ID for request authentication.
      example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    GoogleAccessToken:
      name: google_access_token
      in: query
      description: The Access Token received from Google. The parameter is used to authenticate the User with Google services.
      required: false
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    IdToken:
      name: id_token
      in: query
      description: The ID token used for googlejwt, facebookjwt, applejwt authentication. The parameter is used to verify the User's identity.
      required: false
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    FourSquareAccessToken:
      name: fs_access_token
      in: query
      description: The Access Token used for Foursquare authentication. The parameter is used to authenticate the User with Foursquare.
      required: false
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    LinkedInAccessToken:
      name: ln_access_token
      in: query
      description: The Access Token used for LinkedIn authentication. The parameter is used to authenticate the User with LinkedIn.
      required: false
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    FacebookAccessToken:
      name: fb_access_token
      in: query
      description: The Access Token used for Facebook authentication. The parameter is used to authenticate the User with Facebook.
      required: false
      schema:
        type: string
        format: uuid
      example: 123e4567-e89b-12d3-a456-426614174000
    InvitationId:
      name: invitationid
      in: path
      required: true
      schema:
        type: string
      example: inv_123456789
      description: The ID of the invitation. The ID is typically in the format *inv_<unique_id>*, where *<unique_id>* is a string of alphanumeric characters.
    InvitationUrl:
      name: invitation_url
      in: query
      schema:
        type: string
      example: https://example.com/accept-invite
      description: The URL to which the User will be redirected after accepting the invitation. This URL should be a valid URL and can include query parameters if needed.
    orgId:
      description: Organization ID
      in: path
      name: orgId
      required: true
      schema:
        type: string
      example: org_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    connId:
      description: Organization Connection ID
      in: path
      name: connId
      required: true
      schema:
        type: string
      example: conn_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    groupRoleId:
      description: Organization Connection Group Role ID
      in: path
      name: groupRoleId
      required: true
      schema:
        type: string
      example: group_role_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    domainId:
      description: Organization Domain ID
      in: path
      name: domainId
      required: true
      schema:
        type: string
      example: org_domain_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    permissionId:
      name: id
      in: path
      description: The unique identifier for the Permission
      required: true
      schema:
        type: string
      example: perm_2enk23n3
    roleId:
      name: id
      in: path
      description: Role ID
      required: true
      schema:
        type: string
      example: role_2enk23n3
    Uid:
      name: uid
      in: path
      description: UID of the User
      required: true
      schema:
        type: string
      example: '123456789'
    WorkflowId:
      name: workflowId
      in: path
      required: true
      description: The ID of the workflow.
      schema:
        type: string
      example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    Version:
      name: version
      in: path
      required: true
      schema:
        type: string
      description: The version identifier to delete.
      example: v1.0.0
    HookId:
      name: hookId
      in: path
      required: true
      schema:
        type: string
      description: Webhook ID
      example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    SmsTemplateType:
      name: templateType
      in: path
      required: true
      description: The type of SMS template to delete.
      schema:
        type: string
        enum:
          - verification
          - forgotpassword
          - welcome
          - changephoneno
          - onetimepasscode
          - secondfactorauthentication
          - noregistrationpasswordlesslogin
          - resetpassword
          - suspicious_ip_sms_to_user
          - suspicious_city_sms_to_user
          - suspicious_country_sms_to_user
          - suspicious_browser_sms_to_user
          - suspicious_device_sms_to_user
          - forgotpin
          - deleteuser
          - breached_password
      example: verification
    SecurityQuestionId:
      name: securityQuestionID
      in: path
      required: true
      schema:
        type: string
      example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    EmailTemplateType:
      name: templateType
      in: path
      required: true
      description: The type of Email template to delete.
      schema:
        type: string
        enum:
          - registration
          - forgotpassword
          - forgotprovider
          - deleteaccount
          - add_email
          - welcome
          - oneclicksignin
          - autologin
          - noregistrationpasswordlesslogin
          - resetpassword
          - suspicious_ip_email_to_user
          - suspicious_city_email_to_user
          - suspicious_country_email_to_user
          - suspicious_browser_email_to_user
          - risk_identified_to_admin
          - forgotpin
          - secondfactorauthentication
          - invite_user_to_organization
          - suspicious_device_email_to_user
          - breached_password
          - admin_notification_breached_password
          - add_passkey
          - delete_passkey
          - forget_passkey
      example: registration
    ProviderNamePath:
      name: provider
      in: path
      required: true
      schema:
        type: string
        enum:
          - FACEBOOK
          - GOOGLE
          - YAHOO
          - LIVE
          - TWITTER
          - LINKEDIN
          - FOURSQUARE
          - QQ
          - GITHUB
          - PAYPAL
          - SINAWEIBO
          - WECHAT
          - APPLE
          - SALESFORCE
          - AMAZON
      description: Provider Name
      example: FACEBOOK
    jwtClientName:
      description: JWT Client Name
      in: path
      name: jwtClientName
      required: true
      schema:
        type: string
      example: my-jwt-client
    jwtApp:
      name: jwtApp
      in: path
      description: The jwt App identifier
      required: true
      schema:
        type: string
      example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    samlApp:
      name: samlApp
      in: path
      description: The SAML App identifier
      required: true
      schema:
        type: string
      example: my-saml-app
    CustomFieldsName:
      name: cfname
      in: path
      required: true
      schema:
        type: string
        example: custom_field_name
      description: Custom Fields Name
      example: custom_field_name
    oAuthClientName:
      description: Name of the OAuth Client
      in: path
      name: oAuthClientName
      required: true
      schema:
        type: string
      example: my-oauth-client
    Next:
      name: next
      in: query
      description: |
        Scroll or pagination token for fetching the next set of results. This token is used to retrieve the next page of results in a paginated response.
        If not provided, the API will return the first page of results.
      schema:
        type: string
        example: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAABXcWem...
      required: false
      examples:
        example1:
          value: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAABXcWem...
    Region:
      name: region
      in: query
      description: The region to filter results by.
      schema:
        type: string
        example: us-east-1
      required: false
      examples:
        us-east-1:
          value: us-east-1
    CustomObject:
      name: customobject
      in: query
      description: |
        Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.
      schema:
        type: string
      required: false
      example: customObject123,customObject456
    JwtAppName:
      description: JWT App Name
      example: example_jwt_app
      in: path
      name: JwtAppName
      required: true
      schema:
        type: string
    Nonce:
      description: random nonce claim
      example: 3f444945100b4730810bf4598841769d
      in: query
      name: Nonce
      schema:
        type: string
    OAuthAppName:
      description: OAuth App Name
      example: example_oauth_app
      in: path
      name: OAuthAppName
      required: true
      schema:
        type: string
    OIDCAppName:
      description: OIDC App Name
      example: example_oidc_app
      in: path
      name: OIDCAppName
      required: true
      schema:
        type: string
    SamlAppName:
      description: Saml App Name
      example: example_saml_app
      in: query
      name: appName
      required: true
      schema:
        type: string
    CodeExpiryTTL:
      description: Code Expiry time (in second) in second, Min:0, Max:300
      example: '30'
      in: query
      name: expiry
      schema:
        type: string
        default: '60'
    QRCode:
      description: QR Code By Generate QR Code API
      example: MzUwOTczMDAtODM0MC00Y2FkLWE3MDgtNmY2ZDRiMDA4NjZlIzIwMjEtMTItMjlUMTc6NDk6MjIuNDY0Wg==
      in: query
      name: code
      schema:
        type: string
    OptionId:
      name: optionId
      in: path
      required: true
      schema:
        type: string
      description: The ID of the Consent option to delete.
      example: sms_consent_12
    FormVersion:
      name: version
      in: path
      required: true
      schema:
        type: string
      description: The version of the Consent form to delete.
      example: '3'
    BigCommerceCode:
      name: code
      in: query
      description: BigCommerce OAuth authorization code
      required: false
      schema:
        type: string
      example: abc123def456
    BigCommerceSignedPayload:
      name: signed_payload
      in: query
      description: BigCommerce signed payload for load/uninstall callbacks
      required: false
      schema:
        type: string
      example: eyJhbGciOiJIUzI1NiJ9...
    BigCommerceStore:
      name: store
      in: query
      description: BigCommerce store hash identifier
      required: true
      schema:
        type: string
      example: abc123
    PasswordQuery:
      name: password
      in: query
      description: User's password
      required: false
      schema:
        type: string
      example: MyPassword123
    ReturnUrl:
      name: return_url
      in: query
      description: URL to redirect the user to after login
      required: false
      schema:
        type: string
      example: https://example.com/dashboard
    ShopifyStore:
      name: store
      in: query
      description: Shopify store domain (e.g., mystore.myshopify.com)
      required: true
      schema:
        type: string
      example: mystore.myshopify.com
    PerfectMindSiteName:
      name: perfectmindsitename
      in: query
      description: PerfectMind site name identifier
      required: true
      schema:
        type: string
      example: mysite
    BirthDate:
      name: birthdate
      in: query
      description: User's birth date for PerfectMind contact lookup
      required: false
      schema:
        type: string
      example: '1990-01-15'
    PerfectScanID:
      name: perfectScanID
      in: query
      description: PerfectMind scan ID for contact lookup
      required: false
      schema:
        type: string
      example: scan123
  schemas:
    CaptchaModel:
      type: object
      properties:
        GoogleRecaptchaResponse:
          type: string
          description: The Google reCAPTCHA response which is sent to the server for verification.
          nullable: true
          example: 03AGdBq24...
        QQCaptchaTicket:
          type: string
          description: The QQ Captcha ticket which is sent to the server for verification.
          example: 03AGdBq24...
          nullable: true
        QQCaptchaRandomString:
          type: string
          description: The QQ Captcha random string which is sent to the server for verification.
          example: 03AGdBq24...
          nullable: true
        HCaptchaResponse:
          type: string
          description: The hCaptcha response which is sent to the server for verification.
          example: 03AGdBq24...
          nullable: true
    ResetPassword:
      oneOf:
        - allOf:
            - $ref: '#/components/schemas/CaptchaModel'
            - type: object
              properties:
                ResetToken:
                  type: string
                  description: The reset token received via Email.
                  example: xxxxxxxxxxxxxxxxxxxx
                Password:
                  type: string
                  description: The new Password for the Account.
                  example: new_secure_password
                welcomeemailtemplate:
                  type: string
                  description: Optional welcome Email template.
                  example: welcome_template
                ResetPasswordEmailTemplate:
                  type: string
                  description: Optional reset Password Email template.
                  example: reset_password_template
                SecurityAnswer:
                  type: object
                  additionalProperties:
                    type: string
                  nullable: true
                  description: A map of security question keys and their corresponding answers.
              required:
                - ResetToken
                - Password
        - allOf:
            - $ref: '#/components/schemas/CaptchaModel'
            - type: object
              properties:
                otp:
                  type: string
                  description: One-time passcode sent to the User's Email.
                  example: '123456'
                email:
                  type: string
                  format: email
                  description: User's Email address.
                  example: user@example.com
                Password:
                  type: string
                  description: The new Password for the Account.
                  example: new_secure_password
                welcomeemailtemplate:
                  type: string
                  description: Optional welcome Email template.
                  example: welcome_template
                ResetPasswordEmailTemplate:
                  type: string
                  description: Optional reset Password Email template.
                  example: reset_password_template
                SecurityAnswer:
                  type: object
                  additionalProperties:
                    type: string
                  nullable: true
                  description: A map of security question keys and their corresponding answers.
              required:
                - otp
                - email
                - Password
        - allOf:
            - $ref: '#/components/schemas/CaptchaModel'
            - type: object
              properties:
                otp:
                  type: string
                  description: One-Time Password for verification.
                  example: '123456'
                username:
                  type: string
                  description: Username of the Account.
                  example: user123
                Password:
                  type: string
                  description: The new Password for the Account.
                  example: new_secure_password
                welcomeemailtemplate:
                  type: string
                  description: Optional welcome Email template.
                  example: welcome_template
                ResetPasswordEmailTemplate:
                  type: string
                  description: Optional reset Password Email template.
                  example: reset_password_template
                SecurityAnswer:
                  type: object
                  additionalProperties:
                    type: string
                  nullable: true
                  description: A map of security question keys and their corresponding answers.
              required:
                - otp
                - username
                - Password
    SocialIdentity:
      type: object
      properties:
        TokenSignSecret:
          type: integer
          example: 12345
        FirstLogin:
          type: boolean
          example: true
        IsProtected:
          type: boolean
          example: false
        Hireable:
          type: boolean
          example: true
        FollowersCount:
          type: integer
          example: 1250
        FriendsCount:
          type: integer
          example: 458
        TotalStatusesCount:
          type: integer
          example: 2341
        NumRecommenders:
          type: integer
          example: 15
        TotalPrivateRepository:
          type: integer
          example: 8
        PublicGists:
          type: integer
          example: 23
        PrivateGists:
          type: integer
          example: 5
        PinsCount:
          type: integer
          example: 67
        BoardsCount:
          type: integer
          example: 12
        LikesCount:
          type: integer
          example: 892
        SessionLimit:
          type: integer
          example: 10
        ID:
          type: string
          example: usr_12345abc
        Provider:
          type: string
          example: facebook
        FullName:
          type: string
          nullable: true
          example: John Robert Smith
        FirstName:
          type: string
          example: John
        LastName:
          type: string
          example: Smith
        PhoneId:
          type: string
          example: +1-555-123-4567
        Prefix:
          type: string
          example: Mr.
        MiddleName:
          type: string
          example: Robert
        Suffix:
          type: string
          example: Jr.
        NickName:
          type: string
          example: Johnny
        ProfileName:
          type: string
          example: johnsmith
        BirthDate:
          type: string
          example: '1990-05-15'
        Gender:
          type: string
          example: male
        Website:
          type: string
          example: https://www.johnsmith.com
        ThumbnailImageUrl:
          type: string
          example: https://example.com/thumbnails/john.jpg
        ImageUrl:
          type: string
          example: https://example.com/images/john.jpg
        Favicon:
          type: string
          example: https://example.com/favicon.ico
        ProfileUrl:
          type: string
          example: https://example.com/profile/johnsmith
        HomeTown:
          type: string
          example: Boston
        State:
          type: string
          example: Massachusetts
        City:
          type: string
          example: Cambridge
        Industry:
          type: string
          example: Technology
        About:
          type: string
          example: Passionate software developer with 10+ years of experience
        TimeZone:
          type: string
          example: America/New_York
        LocalLanguage:
          type: string
          example: en-US
        CoverPhoto:
          type: string
          example: https://example.com/cover/john.jpg
        TagLine:
          type: string
          example: Building the future through code
        Language:
          type: string
          example: English
        Verified:
          type: string
          example: 'true'
        UpdatedTime:
          type: string
          example: '2024-03-20T15:30:00Z'
        IsGeoEnabled:
          type: string
          example: 'true'
        Associations:
          type: string
          example: IEEE, ACM
        Honors:
          type: string
          example: Best Developer Award 2023
        HttpsImageUrl:
          type: string
          example: https://example.com/secure/images/john.jpg
        MainAddress:
          type: string
          example: 123 Tech Street, Cambridge, MA 02142
        Created:
          type: string
          example: '2020-01-15T10:00:00Z'
        LocalCity:
          type: string
          example: Cambridge
        ProfileCity:
          type: string
          example: Cambridge
        LocalCountry:
          type: string
          example: United States
        ProfileCountry:
          type: string
          example: United States
        RelationshipStatus:
          type: string
          example: Married
        Quota:
          type: string
          example: '1000'
        Quote:
          type: string
          example: Stay hungry, stay foolish
        Religion:
          type: string
          example: Private
        Political:
          type: string
          example: Private
        PublicRepository:
          type: string
          example: '25'
        RepositoryUrl:
          type: string
          example: https://github.com/johnsmith
        Age:
          type: string
          example: '33'
        ProfessionalHeadline:
          type: string
          example: Senior Software Engineer at Tech Corp
        LRUserID:
          type: string
          example: LR123456
        Currency:
          type: string
          example: USD
        StarredUrl:
          type: string
          example: https://github.com/johnsmith?tab=stars
        GistsUrl:
          type: string
          example: https://gist.github.com/johnsmith
        Company:
          type: string
          example: Tech Corp
        GravatarImageUrl:
          type: string
          example: https://gravatar.com/avatar/123456
        CreatedDate:
          type: string
          format: date-time
          example: '2020-01-15T10:00:00Z'
        ModifiedDate:
          type: string
          format: date-time
          example: '2024-03-20T15:30:00Z'
        ProfileModifiedDate:
          type: string
          format: date-time
          example: '2024-03-19T12:00:00Z'
        LastLoginDate:
          type: string
          format: date-time
          example: '2024-03-20T16:45:00Z'
        SignupDate:
          type: string
          format: date-time
          example: '2020-01-15T10:00:00Z'
        Country:
          type: object
          nullable: true
          properties:
            Name:
              type: string
              example: United States
            Code:
              type: string
              example: US
        AgeRange:
          type: object
          nullable: true
          properties:
            Min:
              type: integer
              example: 30
            Max:
              type: integer
              example: 35
        KloutScore:
          type: object
          nullable: true
          properties:
            KloutId:
              type: string
              example: klout123456
            Score:
              type: integer
              example: 75
        Suggestions:
          type: object
          nullable: true
          properties:
            SuggestedFriends:
              type: array
              nullable: true
              items:
                type: string
              example:
                - user123
                - user456
                - user789
        Subscription:
          type: object
          nullable: true
          properties:
            Name:
              type: string
              example: Pro Plan
            Space:
              type: string
              example: 100GB
            PrivateRepos:
              type: string
              example: '50'
            Collaborators:
              type: string
              example: '10'
        ProviderAccessCredential:
          type: object
          nullable: true
          properties:
            AccessToken:
              type: string
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            TokenSecret:
              type: string
              example: abc123def456...
        ProfileImageUrls:
          type: object
          nullable: true
          additionalProperties:
            type: string
          example:
            small: https://example.com/images/small.jpg
            medium: https://example.com/images/medium.jpg
            large: https://example.com/images/large.jpg
        WebProfiles:
          type: object
          nullable: true
          additionalProperties:
            type: string
          example:
            linkedin: https://linkedin.com/in/johnsmith
            twitter: https://twitter.com/johnsmith
        PreviousUids:
          type: array
          nullable: true
          items:
            type: string
          example:
            - old_id_123
            - old_id_456
        InterestedIn:
          type: array
          nullable: true
          items:
            type: string
          example:
            - Technology
            - Innovation
            - AI
        Positions:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Position:
                type: string
                example: Senior Software Engineer
              Summary:
                type: string
                example: Leading backend development team
              StartDate:
                type: string
                format: date-time
                example: '2022-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2024-03-20T00:00:00Z'
              IsCurrent:
                type: boolean
                example: true
              Company:
                type: object
                nullable: true
                properties:
                  Name:
                    type: string
                    example: Tech Corp
                  Type:
                    type: string
                    example: Public Company
                  Industry:
                    type: string
                    example: Software Development
              Comapny:
                type: object
                nullable: true
                properties:
                  Name:
                    type: string
                    example: Tech Corp
                  Type:
                    type: string
                    example: Public Company
                  Industry:
                    type: string
                    example: Software Development
        Educations:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              School:
                type: string
                example: MIT
              Year:
                type: string
                example: '2012'
              Type:
                type: string
                example: Bachelor's
              Notes:
                type: string
                example: Computer Science Major
              Activities:
                type: string
                example: Robotics Club, Coding Competition
              Degree:
                type: string
                example: BS Computer Science
              FieldOfStudy:
                type: string
                example: Computer Science
              StartDate:
                type: string
                format: date-time
                example: '2008-09-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2012-05-30T00:00:00Z'
        PhoneNumbers:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              PhoneType:
                type: string
                example: Mobile
              PhoneNumber:
                type: string
                example: +1-555-123-4567
              op:
                type: string
                example: add
        IMAccounts:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              AccountType:
                type: string
                example: Skype
              AccountName:
                type: string
                example: johnsmith_skype
        Addresses:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Type:
                type: string
                example: Home
              AddressType:
                type: string
                example: Primary
              Address1:
                type: string
                example: 123 Tech Street
              Address2:
                type: string
                example: Apt 4B
              City:
                type: string
                example: Cambridge
              State:
                type: string
                example: MA
              PostalCode:
                type: string
                example: '02142'
              Region:
                type: string
                example: New England
              Op:
                type: string
                example: add
              Country:
                type: string
                example: USA
        Interests:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              InterestType:
                type: string
                example: Professional
              InterestName:
                type: string
                example: Software Architecture
        Sports:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: sport_123
              Name:
                type: string
                example: Basketball
        InspirationalPeople:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Name:
                type: string
                example: Linus Torvalds
              Id:
                type: string
                example: person_123
        Awards:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: award_123
              Name:
                type: string
                example: Best Developer Award
              Issuer:
                type: string
                example: Tech Conference 2023
        Skills:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: skill_123
              Name:
                type: string
                example: Python Programming
        CurrentStatus:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: status_123
              Text:
                type: string
                example: Working on exciting new project
              Source:
                type: string
                example: LinkedIn
              CreatedDate:
                type: string
                format: date-time
                example: '2024-03-20T15:30:00Z'
        Certifications:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: cert_123
              Name:
                type: string
                example: AWS Certified Solutions Architect
              Authority:
                type: string
                example: Amazon Web Services
              Number:
                type: string
                example: CERT123456
              StartDate:
                type: string
                format: date-time
                example: '2023-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2026-01-15T00:00:00Z'
        Courses:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: course_123
              Name:
                type: string
                example: Advanced Machine Learning
              Number:
                type: string
                example: CS701
        Volunteer:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Organization:
                type: string
                example: Code for America
              Role:
                type: string
                example: Technical Mentor
              Cause:
                type: string
                example: Education
              Id:
                type: string
                example: vol_123
        RecommendationsReceived:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: rec_123
              Recommender:
                type: string
                example: Jane Doe
              RecommendationText:
                type: string
                example: Excellent team player and technical leader
              RecommendationType:
                type: string
                example: Professional
        Languages:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: lang_123
              Name:
                type: string
                example: English
              Proficiency:
                type: string
                example: Native
              op:
                type: string
                example: add
        Projects:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: proj_123
              Name:
                type: string
                example: AI-Powered Analytics Platform
              Summary:
                type: string
                example: Led development of machine learning analytics solution
              StartDate:
                type: string
                format: date-time
                example: '2023-01-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2024-01-01T00:00:00Z'
              IsCurrent:
                type: string
                example: 'true'
              With:
                type: array
                nullable: true
                items:
                  type: object
                  nullable: true
                  properties:
                    Id:
                      type: string
                      example: user_123
                    Name:
                      type: string
                      example: Jane Doe
        Games:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: game_123
              Category:
                type: string
                example: Strategy
              Name:
                type: string
                example: Chess
              CreatedDate:
                type: string
                format: date-time
                example: '2024-01-15T10:30:00Z'
        Family:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: fam_123
              Name:
                type: string
                example: Jane Smith
              Relationship:
                type: string
                example: Spouse
        TelevisionShow:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: show_123
              Category:
                type: string
                example: Science Fiction
              Name:
                type: string
                example: Black Mirror
              CreatedDate:
                type: string
                format: date-time
                example: '2024-01-15T10:30:00Z'
        MutualFriends:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: friend_123
              Name:
                type: string
                example: Alice Johnson
              FirstName:
                type: string
                example: Alice
              LastName:
                type: string
                example: Johnson
              Birthday:
                type: string
                format: date-time
                example: '1992-05-15T00:00:00Z'
              Hometown:
                type: string
                example: Chicago
              Link:
                type: string
                example: https://example.com/profile/alice
              Gender:
                type: string
                example: female
        Movies:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              MovieName:
                type: string
                example: The Matrix
              Genre:
                type: string
                example: Science Fiction
        Books:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: book_123
              Category:
                type: string
                example: Technology
              Name:
                type: string
                example: Clean Code
              CreatedDate:
                type: string
                example: '2024-01-15'
        Patents:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: pat_123
              Title:
                type: string
                example: Novel Machine Learning Algorithm
              Date:
                type: string
                example: '2023-06-15'
        FavoriteThings:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Id:
                type: string
                example: fav_123
              Name:
                type: string
                example: Programming
              Type:
                type: string
                example: Hobby
        RelatedProfileViews:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              FirstName:
                type: string
                example: Sarah
              LastName:
                type: string
                example: Connor
              Id:
                type: string
                example: view_123
        PlacesLived:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Name:
                type: string
                example: San Francisco
              Operation:
                type: string
                example: add
              IsPrimary:
                type: boolean
                example: true
        Publications:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Title:
                type: string
                example: Modern Software Architecture
              Publisher:
                type: string
                example: Tech Publishing House
              Date:
                type: string
                format: date-time
                example: '2023-08-15T00:00:00Z'
              Id:
                type: string
                example: pub_123
              Url:
                type: string
                example: https://example.com/publications/123
              Summary:
                type: string
                example: A comprehensive guide to modern software architecture
              Authors:
                type: array
                nullable: true
                items:
                  type: object
                  nullable: true
                  properties:
                    Id:
                      type: string
                      example: author_123
                    Name:
                      type: string
                      example: John Smith
        JobBookmarks:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              IsApplied:
                type: boolean
                example: true
              IsSaved:
                type: boolean
                example: true
              ApplyTimestamp:
                type: string
                format: date-time
                example: '2024-02-15T14:30:00Z'
              SavedTimestamp:
                type: string
                format: date-time
                example: '2024-02-14T10:00:00Z'
              Job:
                type: object
                nullable: true
                properties:
                  Active:
                    type: boolean
                    example: true
                  Id:
                    type: string
                    example: job_123
                  DescriptionSnippet:
                    type: string
                    example: Senior Role in cloud architecture
                  PostingTimestamp:
                    type: string
                    format: date-time
                    example: '2024-02-01T09:00:00Z'
                  Compony:
                    type: object
                    nullable: true
                    properties:
                      Id:
                        type: string
                        example: comp_123
                      Name:
                        type: string
                        example: Tech Corp
                  Position:
                    type: object
                    nullable: true
                    properties:
                      Title:
                        type: string
                        example: Senior Cloud Architect
        Badges:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              BadgeId:
                type: string
                example: badge_123
              BageId:
                type: string
                example: badge_123
              Name:
                type: string
                example: Top Contributor
              BadgeMessage:
                type: string
                example: Awarded for exceptional contributions
              BageMessage:
                type: string
                example: Awarded for exceptional contributions
              Description:
                type: string
                example: Recognition for community support
              ImageUrl:
                type: string
                example: https://example.com/badges/top-contributor.png
        MemberUrlResources:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              UrlName:
                type: string
                example: Portfolio
              Url:
                type: string
                example: https://johnsmith.dev
        Email:
          type: array
          nullable: true
          items:
            type: object
            nullable: true
            properties:
              Type:
                type: string
                example: Primary
              Value:
                type: string
                example: john.smith@example.com
    Profile:
      type: object
      properties:
        IsPasswordBreached:
          type: boolean
          description: Indicates if the Password has been breached.
          example: false
        IsActive:
          type: boolean
          description: Indicates if the User Account is active.
          example: true
        IsDeleted:
          type: boolean
          description: Indicates if the User Account is deleted.
          example: false
        EmailVerified:
          type: boolean
          description: Indicates if the User's Email is verified.
          example: true
        IsLoginLocked:
          type: boolean
          description: Indicates if the User's login is locked.
          example: false
        IsRequiredFieldsFilledOnce:
          type: boolean
          description: Indicates if required fields have been filled at least once.
          example: true
        FirstLogin:
          type: boolean
          description: Indicates if this is the User's first login.
          example: true
          nullable: true
        IsProtected:
          type: boolean
          description: Indicates if the User Account is protected.
          example: false
        Hireable:
          type: boolean
          description: Indicates if the User is hireable.
          example: true
        IsSecurePassword:
          type: boolean
          description: Indicates if the Password is secure.
          nullable: true
          example: true
        IsCustomUid:
          type: boolean
          description: Indicates if the UID is custom.
          example: false
        PhoneIdVerified:
          type: boolean
          description: Indicates if the Phone ID is verified.
          example: true
        IsEmailSubscribed:
          type: boolean
          description: Indicates if the User is subscribed to emails.
          example: true
        NoOfLogins:
          type: integer
          description: Number of logins by the User.
          example: 10
        FollowersCount:
          type: integer
          description: Number of followers the User has.
          example: 1250
        FriendsCount:
          type: integer
          description: Number of friends the User has.
          example: 458
        TotalStatusesCount:
          type: integer
          description: Total number of statuses posted by the User.
          example: 2341
        NumRecommenders:
          type: integer
          description: Number of recommenders for the User.
          example: 15
        TotalPrivateRepository:
          type: integer
          description: Total number of private repositories.
          example: 8
        PublicGists:
          type: integer
          description: Total number of public gists.
          example: 23
        PrivateGists:
          type: integer
          description: Total number of private gists.
          example: 5
        PinsCount:
          type: integer
          description: Total number of PINs.
          example: 67
        BoardsCount:
          type: integer
          description: Total number of boards.
          example: 12
        LikesCount:
          type: integer
          description: Total number of likes.
          example: 892
        SessionLimit:
          type: integer
          example: 5
        ID:
          type: string
          description: Unique identifier for the User Profile.
          example: usr_12345abc
        Password:
          type: string
          example: '********'
        LoginLockedType:
          type: string
          example: None
        Provider:
          type: string
          description: Provider of the User Profile.
          example: facebook
        LastPasswordChangeToken:
          type: string
          example: tkn_abc123xyz
        FullName:
          type: string
          description: Full name of the User.
          nullable: true
          example: John Robert Smith
        FirstName:
          type: string
          nullable: true
          description: First name of the User.
          example: John
        LastName:
          type: string
          nullable: true
          description: Last name of the User.
          example: Smith
        RegistrationProvider:
          type: string
          example: google
        RegistrationSource:
          type: string
          example: web
        LastLoginLocation:
          type: string
          example: New York, USA
        ExternalUserLoginId:
          type: string
          example: ext_789xyz
        PhoneId:
          type: string
          description: Phone ID of the User.
          example: +1-555-123-4567
          nullable: true
        UserName:
          type: string
          nullable: true
          description: The Username of the User.
          example: john_doe
        Prefix:
          type: string
          nullable: true
          description: The prefix for the User's name.
          example: Mr.
        MiddleName:
          type: string
          description: The middle name of the User.
          example: Robert
          nullable: true
        Suffix:
          type: string
          nullable: true
          description: The suffix for the User's name.
          example: Jr.
        NickName:
          type: string
          nullable: true
          description: The nickname of the User.
          example: Johnny
        ProfileName:
          type: string
          nullable: true
          description: The profile name of the User.
          example: johnsmith
        BirthDate:
          type: string
          nullable: true
          description: The birth date of the User.
          example: '1990-05-15'
        Gender:
          type: string
          nullable: true
          description: The gender of the User.
          example: male
        Website:
          type: string
          nullable: true
          description: The website of the User.
          example: https://www.johnsmith.com
        ThumbnailImageUrl:
          type: string
          nullable: true
          description: The URL of the User's thumbnail image.
          example: https://example.com/thumbnails/john.jpg
        ImageUrl:
          type: string
          nullable: true
          description: The URL of the User's profile image.
          example: https://example.com/images/john.jpg
        Favicon:
          type: string
          nullable: true
          description: The URL of the User's favicon.
          example: https://example.com/favicon.ico
        ProfileUrl:
          type: string
          nullable: true
          description: The URL of the User's profile.
          example: https://example.com/profile/johnsmith
        HomeTown:
          type: string
          nullable: true
          description: The hometown of the User.
          example: Boston
        State:
          type: string
          nullable: true
          description: The state of the User.
          example: Massachusetts
        City:
          type: string
          nullable: true
          description: The city of the User.
          example: Cambridge
        Industry:
          type: string
          nullable: true
          description: The industry of the User.
          example: Technology
        About:
          type: string
          nullable: true
          description: A brief description about the User.
          example: Passionate software developer with 10+ years of experience
        TimeZone:
          type: string
          nullable: true
          description: The time zone of the User.
          example: America/New_York
        LocalLanguage:
          type: string
          nullable: true
          description: The local language of the User.
          example: en-US
        CoverPhoto:
          type: string
          nullable: true
          description: The URL of the User's cover photo.
          example: https://example.com/cover/john.jpg
        TagLine:
          type: string
          nullable: true
          description: The tagline of the User.
          example: Building the future through code
        Language:
          type: string
          nullable: true
          description: The language of the User.
          example: English
        Verified:
          type: string
          description: Indicates if the User is verified.
          example: 'true'
          nullable: true
        UpdatedTime:
          type: string
          nullable: true
          description: The last updated time of the User's profile.
          example: '2024-03-20T15:30:00Z'
        IsGeoEnabled:
          type: string
          nullable: true
          description: Indicates if geolocation is enabled for the User.
          example: 'true'
        Associations:
          type: string
          nullable: true
          description: The associations of the User.
          example: IEEE, ACM
        Honors:
          type: string
          nullable: true
          description: The honors received by the User.
          example: Best Developer Award 2023
        HttpsImageUrl:
          type: string
          nullable: true
          description: The HTTPS URL of the User's profile image.
          example: https://example.com/secure/images/john.jpg
        MainAddress:
          nullable: true
          type: string
          description: The main address of the User.
          example: 123 Tech Street, Cambridge, MA 02142
        Created:
          nullable: true
          type: string
          description: The creation date of the User's account.
          example: '2020-01-15T10:00:00Z'
        LocalCity:
          nullable: true
          type: string
          description: The local city of the User.
          example: Cambridge
        ProfileCity:
          nullable: true
          type: string
          description: The profile city of the User.
          example: Cambridge
        LocalCountry:
          type: string
          nullable: true
          description: The local country of the User.
          example: United States
        ProfileCountry:
          type: string
          nullable: true
          description: The profile country of the User.
          example: United States
        RelationshipStatus:
          type: string
          nullable: true
          description: The relationship status of the User.
          example: Married
        Quota:
          type: string
          nullable: true
          description: The quota assigned to the User.
          example: '1000'
        Quote:
          type: string
          nullable: true
          description: A quote associated with the User.
          example: Stay hungry, stay foolish
        Religion:
          type: string
          nullable: true
          description: The religion of the User.
          example: Private
        Political:
          type: string
          nullable: true
          description: The political views of the User.
          example: Private
        PublicRepository:
          type: string
          nullable: true
          description: The number of public repositories owned by the User.
          example: '25'
        RepositoryUrl:
          type: string
          nullable: true
          description: The URL of the User's repository.
          example: https://github.com/johnsmith
        Age:
          type: string
          description: The age of the User.
          example: '33'
          nullable: true
        ProfessionalHeadline:
          type: string
          nullable: true
          description: The professional headline of the User.
          example: Senior Software Engineer at Tech Corp
        LRUserID:
          type: string
          nullable: true
          description: The LoginRadius User ID.
          example: LR123456
        Currency:
          type: string
          nullable: true
          description: The preferred currency of the User.
          example: USD
        StarredUrl:
          type: string
          nullable: true
          description: The URL of the User's starred items.
          example: https://github.com/johnsmith?tab=stars
        GistsUrl:
          type: string
          nullable: true
          description: The URL of the User's gists.
          example: https://gist.github.com/johnsmith
        Company:
          type: string
          nullable: true
          description: The company the User is associated with.
          example: Tech Corp
        GravatarImageUrl:
          type: string
          nullable: true
          description: The URL of the User's Gravatar image.
          example: https://gravatar.com/avatar/123456
        LastPasswordChangeDate:
          nullable: true
          type: string
          format: date-time
          description: The date of the last Password change.
          example: '2024-03-15T10:00:00Z'
        PasswordExpirationDate:
          type: string
          format: date-time
          nullable: true
          description: The expiration date of the Password.
          example: '2024-06-15T10:00:00Z'
        CreatedDate:
          type: string
          format: date-time
          description: The date the Account was created.
          example: '2020-01-15T10:00:00Z'
        ModifiedDate:
          type: string
          format: date-time
          description: The date the Account was last modified.
          example: '2024-03-20T15:30:00Z'
        ProfileModifiedDate:
          type: string
          format: date-time
          nullable: true
          description: The date the Profile was last modified.
          example: '2024-03-19T12:00:00Z'
        LastLoginDate:
          nullable: true
          type: string
          format: date-time
          description: The date of the last login.
          example: '2024-03-20T16:45:00Z'
        SignupDate:
          type: string
          format: date-time
          description: The date the User signed up.
          example: '2020-01-15T10:00:00Z'
        PrivacyPolicy:
          type: object
          nullable: true
          properties:
            Version:
              type: string
              description: The version of the Privacy Policy.
              example: '1.0'
            AcceptSource:
              type: string
              description: The source of the Privacy Policy acceptance.
              example: Web
            AcceptDateTime:
              type: string
              format: date-time
              description: The date and time of Privacy Policy acceptance.
              example: '2024-03-20T15:30:00Z'
        Country:
          type: object
          nullable: true
          properties:
            Code:
              type: string
              description: The country code.
              example: US
            Name:
              type: string
              description: The country name.
              example: United States
        AgeRange:
          type: object
          nullable: true
          properties:
            Min:
              type: integer
              description: The minimum age in the range.
              example: 18
            Max:
              type: integer
              description: The maximum age in the range.
              example: 35
        KloutScore:
          type: object
          nullable: true
          properties:
            KloutId:
              type: string
              description: The Klout ID.
              example: klout_12345
            Score:
              type: number
              format: float
              description: The Klout score.
              example: 75.5
        Suggestions:
          type: object
          nullable: true
          properties:
            CompaniesToFollow:
              type: array
              description: List of companies suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The unique identifier.
                    example: company_12345
                  Name:
                    type: string
                    nullable: true
                    description: The name of the company.
                    example: Tech Corp
            IndustriesToFollow:
              type: array
              description: List of industries suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The unique identifier.
                    example: industry_12345
                  Name:
                    type: string
                    nullable: true
                    description: The name of the industry.
                    example: Software Development
            NewssourceToFollow:
              type: array
              description: List of news sources suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The unique identifier.
                    example: news_12345
                  Name:
                    type: string
                    nullable: true
                    description: The name of the news source.
                    example: Tech News Daily
            PeopleToFollow:
              type: array
              description: List of people suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The unique identifier.
                    example: person_12345
                  Name:
                    type: string
                    nullable: true
                    description: The name of the person.
                    example: John Doe
        Subscription:
          type: object
          nullable: true
          properties:
            Name:
              type: string
              description: The name of the subscription.
              example: Pro Plan
            Space:
              type: string
              description: The allocated space for the subscription.
              example: 100GB
            PrivateRepos:
              type: string
              description: The number of private repositories allowed.
              example: '50'
            Collaborators:
              type: string
              description: The number of collaborators allowed.
              example: '10'
        PIN:
          type: object
          nullable: true
          properties:
            Skipped:
              type: boolean
              description: Indicates if the PIN setup was skipped.
              example: false
            PIN:
              type: string
              description: The PIN value.
              example: '1234'
            LastPINChangeToken:
              type: string
              description: The token for the last PIN change.
              example: token_12345
              nullable: true
            LastPINChangeDate:
              nullable: true
              type: string
              format: date-time
              description: The date of the last PIN change.
              example: '2024-03-15T10:00:00Z'
            SkippedDate:
              nullable: true
              type: string
              format: date-time
              description: The date the PIN setup was skipped.
              example: '2024-03-10T10:00:00Z'
        ConsentProfile:
          type: object
          nullable: true
          description: Consent profile details.
          properties:
            AcceptedConsentVersions:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  IsCustom:
                    type: boolean
                    description: Indicates if the Consent version is custom.
                    example: false
                  Version:
                    type: integer
                    description: The version of the Consent.
                    example: 1
                  Event:
                    type: string
                    description: The event associated with the Consent.
                    example: Signup
            Consents:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  ConsentOptionId:
                    type: string
                    description: The ID of the Consent option.
                    example: 123e4567e89b12d3a456426614174000
                  AcceptOnDate:
                    nullable: true
                    type: string
                    format: date-time
                    description: The date the Consent was accepted.
                    example: '2024-03-20T15:30:00Z'
        RegistrationData:
          type: object
          nullable: true
          description: Registration data details.
          properties:
            Data:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  DataSource:
                    type: string
                    description: The source of the registration data.
                    example: Web
                  Value:
                    type: object
                    properties:
                      Id:
                        type: string
                        description: The ID of the registration data value.
                        example: data_12345
        ProviderAccessCredential:
          type: object
          nullable: true
          description: Provider access credential details.
          properties:
            AccessToken:
              type: string
              description: Access Token for the provider.
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            TokenSecret:
              type: string
              description: Token secret for the provider.
              example: abc123def456...
        CustomFields:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: Custom fields associated with the User.
          example:
            hobby: Photography
            favorite_color: Blue
        ProfileImageUrls:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: URLs of the User's profile images.
          example:
            small: https://example.com/small.jpg
            large: https://example.com/large.jpg
        WebProfiles:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: The User's web profiles.
          example:
            linkedin: https://linkedin.com/in/johndoe
            github: https://github.com/johndoe
        Roles:
          type: array
          nullable: true
          items:
            type: string
          description: Roles assigned to the User.
          example:
            - Admin
            - User
        Uid:
          type: string
          example: 577fabca-a33e-4a08-96e6-0ade8d846613
          description: the unique id which belongs to the Account
        PreviousUids:
          type: array
          nullable: true
          items:
            type: string
          description: Previous UIDs associated with the Account.
          example:
            - old_UID_123
            - old_UID_456
        InterestedIn:
          type: array
          nullable: true
          items:
            type: string
          description: Interests of the User.
          example:
            - Technology
            - Music
        ExternalIds:
          type: array
          nullable: true
          items:
            type: object
            properties:
              Operation:
                type: string
                description: The operation performed on the external ID.
                example: add
              Source:
                type: string
                description: The source of the external ID.
                example: LinkedIn
              SourceId:
                type: string
                description: The source ID of the external ID.
                example: source_12345
        UnverifiedEmail:
          type: array
          nullable: true
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of the Email.
                example: Primary
              Value:
                type: string
                description: The Email address.
                example: john.doe@example.com
        Positions:
          type: array
          nullable: true
          description: List of positions held by the User.
          items:
            type: object
            properties:
              Position:
                type: string
                description: The position held by the User.
                example: Senior Software Engineer
              Summary:
                type: string
                description: A summary of the position.
                example: Leading backend development team.
              StartDate:
                type: string
                format: date-time
                description: The start date of the position.
                example: '2022-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the position.
                example: '2024-03-20T00:00:00Z'
              IsCurrent:
                type: string
                description: Indicates if the position is current.
                example: 'true'
              Location:
                type: string
                description: The location of the position.
                example: New York
              Company:
                type: object
                properties:
                  Name:
                    type: string
                    description: The name of the company.
                    example: Tech Corp
                  Type:
                    type: string
                    description: The type of the company.
                    example: Public Company
                  Industry:
                    type: string
                    description: The industry of the company.
                    example: Software Development
        Educations:
          type: array
          nullable: true
          description: List of educational qualifications of the User.
          items:
            type: object
            properties:
              School:
                type: string
                description: The name of the school.
                example: MIT
              Year:
                type: string
                description: The year of graduation.
                example: '2012'
              Type:
                type: string
                description: The type of degree.
                example: Bachelor's
              Notes:
                type: string
                description: Additional notes about the education.
                example: Computer Science Major
              Activities:
                type: string
                description: Activities participated in during education.
                example: Robotics Club, Coding Competition
              Degree:
                type: string
                description: The degree obtained.
                example: BS Computer Science
              FieldOfStudy:
                type: string
                description: The field of study.
                example: Computer Science
              StartDate:
                type: string
                format: date-time
                description: The start date of the education.
                example: '2008-09-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the education.
                example: '2012-05-30T00:00:00Z'
        PhoneNumbers:
          type: array
          nullable: true
          description: List of Phone numbers associated with the User.
          items:
            type: object
            properties:
              PhoneType:
                type: string
                description: The type of Phone (e.g., Mobile, Home).
                example: Mobile
              PhoneNumber:
                type: string
                description: The Phone number.
                example: +1-555-123-4567
              Operation:
                type: string
                description: The operation performed on the Phone number.
                example: add
        IMAccounts:
          type: array
          nullable: true
          description: List of instant messaging accounts associated with the User.
          items:
            type: object
            properties:
              AccountType:
                type: string
                description: The type of instant messaging account.
                example: Skype
              AccountName:
                type: string
                description: The name of the instant messaging account.
                example: johnsmith_skype
        Addresses:
          type: array
          nullable: true
          description: List of addresses associated with the User.
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of address (e.g., Home, Work).
                example: Home
              Address1:
                type: string
                description: The first line of the address.
                example: 123 Tech Street
              Address2:
                type: string
                description: The second line of the address.
                example: Apt 4B
              City:
                type: string
                description: The city of the address.
                example: Cambridge
              State:
                type: string
                description: The state of the address.
                example: MA
              PostalCode:
                type: string
                description: The postal code of the address.
                example: '02142'
              Region:
                type: string
                description: The region of the address.
                example: New England
              Country:
                type: string
                description: The country of the address.
                example: USA
              Operation:
                type: string
                description: The operation performed on the address.
                example: add
        Interests:
          type: array
          nullable: true
          description: List of interests of the User.
          items:
            type: object
            properties:
              InterestedType:
                type: string
                description: The type of interest (e.g., Professional, Personal).
                example: Professional
              InterestedName:
                type: string
                description: The name of the interest.
                example: Software Architecture
        Sports:
          type: array
          nullable: true
          description: List of sports the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the sport.
                example: sport_123
              Name:
                type: string
                description: The name of the sport.
                example: Basketball
        InspirationalPeople:
          type: array
          nullable: true
          description: List of inspirational people for the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the person.
                example: person_123
              Name:
                type: string
                description: The name of the person.
                example: Linus Torvalds
        Awards:
          type: array
          nullable: true
          description: List of awards received by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the award.
                example: award_123
              Name:
                type: string
                description: The name of the award.
                example: Best Developer Award
              Issuer:
                type: string
                description: The issuer of the award.
                example: Tech Conference 2023
        Skills:
          type: array
          nullable: true
          description: List of skills possessed by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the skill.
                example: skill_123
              Name:
                type: string
                description: The name of the skill.
                example: Python Programming
        CurrentStatus:
          type: array
          nullable: true
          description: List of current statuses of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the status.
                example: status_123
              Text:
                type: string
                description: The text of the status.
                example: Working on exciting new project
              Source:
                type: string
                description: The source of the status.
                example: LinkedIn
              CreatedDate:
                type: string
                format: date-time
                description: The date the status was created.
                example: '2024-03-20T15:30:00Z'
        Certifications:
          type: array
          nullable: true
          description: List of certifications obtained by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the certification.
                example: cert_123
              Name:
                type: string
                description: The name of the certification.
                example: AWS Certified Solutions Architect
              Authority:
                type: string
                description: The authority issuing the certification.
                example: Amazon Web Services
              Number:
                type: string
                description: The certification number.
                example: CERT123456
              StartDate:
                type: string
                format: date-time
                description: The start date of the certification.
                example: '2023-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the certification.
                example: '2026-01-15T00:00:00Z'
        Courses:
          type: array
          nullable: true
          description: List of courses completed by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the course.
                example: course_123
              Name:
                type: string
                description: The name of the course.
                example: Advanced Machine Learning
              Number:
                type: string
                description: The course number.
                example: CS701
        Volunteer:
          type: array
          nullable: true
          description: List of volunteer activities by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the volunteer activity.
                example: vol_123
              Role:
                type: string
                description: The Role in the volunteer activity.
                example: Technical Mentor
              Organization:
                type: string
                description: The organization for the volunteer activity.
                example: Code for America
              Cause:
                type: string
                description: The cause of the volunteer activity.
                example: Education
        RecommendationsReceived:
          type: array
          nullable: true
          description: List of recommendations received by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the recommendation.
                example: rec_123
              RecommendationType:
                type: string
                description: The type of recommendation.
                example: Professional
              RecommendationText:
                type: string
                description: The text of the recommendation.
                example: Excellent team player and technical leader
              Recommender:
                type: string
                description: The name of the recommender.
                example: Jane Doe
        Languages:
          type: array
          nullable: true
          description: List of languages known by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the language.
                example: lang_123
              Name:
                type: string
                description: The name of the language.
                example: English
              Proficiency:
                type: string
                description: The proficiency level in the language.
                example: Native
        Projects:
          type: array
          nullable: true
          description: List of projects undertaken by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the project.
                example: proj_123
              Name:
                type: string
                description: The name of the project.
                example: AI-Powered Analytics Platform
              Summary:
                type: string
                description: A summary of the project.
                example: Led development of machine learning analytics solution
              StartDate:
                type: string
                format: date-time
                description: The start date of the project.
                example: '2023-01-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the project.
                example: '2024-01-01T00:00:00Z'
              IsCurrent:
                type: string
                description: Indicates if the project is current.
                example: 'true'
        Games:
          type: array
          nullable: true
          description: List of games the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the game.
                example: game_123
              Category:
                type: string
                description: The category of the game.
                example: Strategy
              Name:
                type: string
                description: The name of the game.
                example: Chess
              CreatedDate:
                type: string
                format: date-time
                description: The date the game was added.
                example: '2024-01-15T10:30:00Z'
        Family:
          type: array
          nullable: true
          description: List of family members of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the family member.
                example: fam_123
              Relationship:
                type: string
                description: The relationship with the family member.
                example: Spouse
              Name:
                type: string
                description: The name of the family member.
                example: Jane Smith
        TelevisionShow:
          type: array
          nullable: true
          description: List of television shows the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the television show.
                example: show_123
              Category:
                type: string
                description: The category of the television show.
                example: Science Fiction
              Name:
                type: string
                description: The name of the television show.
                example: Black Mirror
              CreatedDate:
                type: string
                format: date-time
                description: The date the television show was added.
                example: '2024-01-15T10:30:00Z'
        MutualFriends:
          type: array
          nullable: true
          description: List of mutual friends of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the mutual friend.
                example: friend_123
              Name:
                type: string
                description: The name of the mutual friend.
                example: Alice Johnson
              FirstName:
                type: string
                description: The first name of the mutual friend.
                example: Alice
              LastName:
                type: string
                description: The last name of the mutual friend.
                example: Johnson
              Birthday:
                type: string
                format: date-time
                description: The birthday of the mutual friend.
                example: '1992-05-15T00:00:00Z'
              Hometown:
                type: string
                description: The hometown of the mutual friend.
                example: Chicago
              Link:
                type: string
                description: The profile link of the mutual friend.
                example: https://example.com/profile/alice
              Gender:
                type: string
                description: The gender of the mutual friend.
                example: female
        Movies:
          type: array
          nullable: true
          description: List of movies the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the movie.
                example: movie_123
              Category:
                type: string
                description: The category of the movie.
                example: Science Fiction
              Name:
                type: string
                description: The name of the movie.
                example: The Matrix
        Books:
          type: array
          nullable: true
          description: List of books the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the book.
                example: book_123
              Category:
                type: string
                description: The category of the book.
                example: Technology
              Name:
                type: string
                description: The name of the book.
                example: Clean Code
              CreatedDate:
                type: string
                format: date-time
                description: The date the book was added.
                example: '2023-10-01T00:00:00Z'
        Patents:
          type: array
          nullable: true
          description: List of patents owned by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the patent.
                example: pat_123
              Title:
                type: string
                description: The title of the patent.
                example: Novel Machine Learning Algorithm
              Date:
                type: string
                format: date-time
                description: The date the patent was filed.
                example: '2023-10-01T00:00:00Z'
        FavoriteThings:
          type: array
          nullable: true
          description: List of favorite things of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the favorite thing.
                example: fav_123
              Name:
                type: string
                description: The name of the favorite thing.
                example: Programming
              Type:
                type: string
                description: The type of the favorite thing.
                example: Hobby
        RelatedProfileViews:
          type: array
          nullable: true
          description: List of related profile views of the User.
          items:
            type: object
            properties:
              FirstName:
                type: string
                description: The first name of the related profile.
                example: Sarah
              LastName:
                type: string
                description: The last name of the related profile.
                example: Connor
              Id:
                type: string
                description: The ID of the related profile.
                example: view_123
        PlacesLived:
          type: array
          nullable: true
          description: List of places the User has lived.
          items:
            type: object
            properties:
              Name:
                type: string
                description: The name of the place.
                example: San Francisco
              Operation:
                type: string
                description: The operation performed on the place.
                example: add
              IsPrimary:
                type: boolean
                description: Indicates if the place is the primary residence.
                example: true
        Publications:
          type: array
          nullable: true
          description: List of publications by the User.
          items:
            type: object
            properties:
              Title:
                type: string
                description: The title of the publication.
                example: Modern Software Architecture
              Publisher:
                type: string
                description: The publisher of the publication.
                example: Tech Publishing House
              Date:
                type: string
                format: date-time
                description: The date the publication was released.
                example: '2023-08-15T00:00:00Z'
              Id:
                type: string
                description: The ID of the publication.
                example: pub_123
              Url:
                type: string
                description: The URL of the publication.
                example: https://example.com/publications/123
              Summary:
                type: string
                description: A summary of the publication.
                example: A comprehensive guide to modern software architecture
              Authors:
                type: array
                nullable: true
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      description: The ID of the author.
                      example: author_123
                    Name:
                      type: string
                      description: The name of the author.
                      example: John Smith
        JobBookmarks:
          type: array
          nullable: true
          description: List of job bookmarks by the User.
          items:
            type: object
            properties:
              IsApplied:
                type: boolean
                description: Indicates if the job has been applied for.
                example: true
              IsSaved:
                type: boolean
                description: Indicates if the job has been saved.
                example: true
              ApplyTimestamp:
                type: string
                format: date-time
                description: The timestamp of the job application.
                example: '2024-02-15T14:30:00Z'
              SavedTimestamp:
                type: string
                format: date-time
                description: The timestamp of the job being saved.
                example: '2024-02-14T10:00:00Z'
              Job:
                type: object
                properties:
                  Active:
                    type: boolean
                    description: Indicates if the job is active.
                    example: true
                  Id:
                    type: string
                    description: The ID of the job.
                    example: job_123
                  DescriptionSnippet:
                    type: string
                    description: A snippet of the job description.
                    example: Senior Role in cloud architecture
                  PostingTimestamp:
                    type: string
                    format: date-time
                    description: The timestamp of the job posting.
                    example: '2024-02-01T09:00:00Z'
        Badges:
          type: array
          nullable: true
          description: List of badges earned by the User.
          items:
            type: object
            properties:
              BadgeId:
                type: string
                description: The ID of the badge.
                example: badge_123
              Name:
                type: string
                description: The name of the badge.
                example: Top Contributor
              BadgeMessage:
                type: string
                description: The message associated with the badge.
                example: Awarded for exceptional contributions
              Description:
                type: string
                description: A description of the badge.
                example: Recognition for community support
              ImageUrl:
                type: string
                description: The URL of the badge image.
                example: https://example.com/badges/top-contributor.png
        MemberUrlResources:
          type: array
          nullable: true
          description: List of member URL resources.
          items:
            type: object
            properties:
              Url:
                type: string
                description: The URL of the resource.
                example: https://johnsmith.dev
              UrlName:
                type: string
                description: The name of the URL resource.
                example: Portfolio
        Organizations:
          type: array
          nullable: true
          description: List of organizations associated with the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the organization.
                example: org_123
              Name:
                type: string
                description: The name of the organization.
                example: Acme Corp
              LogoURL:
                type: string
                description: The logo URL of the organization.
                example: https://cdn.example.com/orgs/acme/logo.png
        Email:
          type: array
          nullable: true
          description: List of Email addresses associated with the User.
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of the Email (e.g., Primary, Secondary).
                example: Primary
              Value:
                type: string
                description: The Email address.
                example: john.doe@example.com
        PasskeyLogin:
          type: object
          nullable: true
          description: Passkey login details for the User.
          properties:
            ProgressiveFlag:
              type: boolean
              example: true
            LocalEnrollmentFlag:
              type: boolean
              example: false
            ProgressiveEnrollmentDate:
              nullable: true
              type: string
              format: date-time
              description: The date of progressive enrollment.
              example: '2024-03-15T10:00:00Z'
        Identities:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/SocialIdentity'
    AuthResponse:
      type: object
      properties:
        Profile:
          $ref: '#/components/schemas/Profile'
        access_token:
          type: string
          example: 68***-91**-****-b**b-e**********9
          description: Bearer token for authenticating API requests.
        refresh_token:
          type: string
          example: 68***-91**-****-b**b-e**********9
          description: Long-lived token for obtaining new Access Tokens.
        expires_in:
          type: string
          format: date-time
          example: '2023-10-01T12:00:00Z'
          description: Expiration time of the Access Token in seconds.
    ResetPasswordResponse:
      properties:
        IsPosted:
          type: boolean
        Data:
          $ref: '#/components/schemas/AuthResponse'
    ApiError:
      type: object
      properties:
        ErrorCode:
          type: integer
          format: int32
          description: The error code
        Message:
          type: string
          description: The error message
        Description:
          type: string
          description: A detailed description of the error
    EmailUserNameModel:
      type: object
      properties:
        Email:
          type: string
          description: The Email address of the User
          example: test@gmail.com
          format: email
        UserName:
          type: string
          description: The Username of the User
          example: testuser
    IsPostedResponse:
      type: object
      properties:
        IsPosted:
          type: boolean
          description: Indicates whether the item is posted
    changePassword:
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            OldPassword:
              type: string
              description: User's current password
              example: xxxxxxx
            NewPassword:
              type: string
              description: User's new password
              example: xxxxxxxxxxx
      required:
        - OldPassword
        - NewPassword
    ErrorResponse:
      type: object
      properties:
        Message:
          type: string
          description: Brief message describing the error.
        Description:
          type: string
          description: Detailed description of the error.
        ErrorCode:
          type: integer
          description: Error code for identifying the error type.
        Code:
          type: integer
          description: HTTP status code associated with the error.
          nullable: true
    ResetPasswordWithOTP:
      allOf:
        - type: object
          description: Reset Password by Phone and otp
          properties:
            resetpasswordemailtemplate:
              type: string
              description: Email template for Password reset (optional)
              example: reset_template_v1
            resetPasswordSmsTemplate:
              type: string
              description: SMS template for Password reset (optional)
              example: sms_reset_v1
            smstemplate:
              type: string
              description: SMS template (optional)
              example: otp_template_v1
            SecurityAnswer:
              type: object
              description: Map of security question answers
              additionalProperties:
                type: string
              example:
                What is your pet's name?: Fluffy
                What is your mother's maiden name?: Smith
            Password:
              type: string
              description: New password
              example: StrongP@ssw0rd!
            otp:
              type: string
              description: One-Time Password received via SMS/email
              example: '123456'
            phone:
              type: string
              description: Phone number for OTP delivery
              example: '+919999999999'
          required:
            - Password
            - otp
            - phone
        - $ref: '#/components/schemas/CaptchaModel'
    ForgotPasswordPhoneModel:
      type: object
      properties:
        Phone:
          type: string
          description: Phone number associated with the Account for Password reset.
          example: '+1234567890'
        g-recaptcha-response:
          type: string
          nullable: true
          example: 03AGdBq24...
        qq_captcha_ticket:
          type: string
          nullable: true
          example: 03AGdBq24eJ9O8dpLsw0Pr0OTtWfkmK34K0jQde
        qq_captcha_randstr:
          type: string
          nullable: true
          example: 03AGdBq24eJ9O8dpLsw0Pr0OTtWfkmK34K0jQde
        h-captcha-response:
          type: string
          nullable: true
          example: 03AGdBq24e1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2v3w4x5y6z7a8b9c0d1e2f3g4h5i6j7k8l9m0n1o2p3q4r5s6t7u8v9w0x1y2z3a4b5c6d7e8f9g0h1i2j3k4l5m6n7o8p9q0r1s2t3u4v5w6x7y8z9
      required:
        - Phone
    SMSResponseData:
      type: object
      description: SMS response data details
      required:
        - Sid
      properties:
        AccountSid:
          type: string
          nullable: true
          description: The unique identifier for the Account
          example: ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
        Sid:
          type: string
          description: The unique identifier for the SMS message
          example: SMXXXXXXXXXXXXXXXX
    SMSResponse:
      type: object
      required:
        - IsPosted
        - Data
      properties:
        IsPosted:
          type: boolean
          description: Indicates whether the SMS was successfully posted
          example: true
        Data:
          $ref: '#/components/schemas/SMSResponseData'
    ResetPasswordBySecurityAnswer:
      type: object
      required:
        - SecurityAnswer
        - password
      properties:
        SecurityAnswer:
          type: object
          additionalProperties:
            type: string
          description: A map of question IDs or keys to answers
          example:
            mother_maiden_name: Smith
        ResetPasswordEmailTemplate:
          type: string
          description: Optional Email template to use for Password reset
          example: reset-password-template
        password:
          type: string
          description: New Password to set
          example: MySecureP@ssw0rd
        Phone:
          type: string
          description: User's Phone number
          example: '+919876543210'
        Email:
          type: string
          description: User's Email address
          example: user@example.com
        UserName:
          type: string
          description: Optional username
          example: john_doe
        userid:
          type: string
          description: Optional User ID
          example: abc123
    EmailModel:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The User's Email address
          example: xyz@example.com
      required:
        - email
    ProfileRequestModel:
      type: object
      properties:
        UserName:
          type: string
          example: johndoe123
        PhoneId:
          type: string
          example: '15555551234'
        Gender:
          type: string
          example: M
        BirthDate:
          type: string
          example: '1990-01-01'
        Prefix:
          type: string
          example: Mr.
        FirstName:
          type: string
          example: John
        MiddleName:
          type: string
          example: Robert
        LastName:
          type: string
          example: Doe
        Suffix:
          type: string
          example: Jr.
        NickName:
          type: string
          example: Johnny
        ProfileName:
          type: string
          example: John R. Doe
        About:
          type: string
          example: Software developer passionate about creating great User experiences
        Company:
          type: string
          example: Tech Corp Inc.
        ImageUrl:
          type: string
          example: https://example.com/images/profile.jpg
        TimeZone:
          type: string
          example: America/New_York
        Website:
          type: string
          example: https://johndoe.com
        ThumbnailImageUrl:
          type: string
          example: https://example.com/images/thumbnail.jpg
        Favicon:
          type: string
          example: https://example.com/favicon.ico
        ProfileUrl:
          type: string
          example: https://example.com/profile/johndoe
        HomeTown:
          type: string
          example: Boston
        State:
          type: string
          example: Massachusetts
        City:
          type: string
          example: Cambridge
        Industry:
          type: string
          example: Technology
        LocalLanguage:
          type: string
          example: en-US
        Language:
          type: string
          example: English
        CoverPhoto:
          type: string
          example: https://example.com/images/cover.jpg
        TagLine:
          type: string
          example: Building the future of technology
        MainAddress:
          type: string
          example: 123 Tech Street
        LocalCity:
          type: string
          example: Cambridge
        ProfileCity:
          type: string
          example: Cambridge
        LocalCountry:
          type: string
          example: United States
        ProfileCountry:
          type: string
          example: United States
        Quota:
          type: string
          example: premium
        Religion:
          type: string
          example: Prefer not to say
        Political:
          type: string
          example: Independent
        RelationshipStatus:
          type: string
          example: Married
        HttpsImageUrl:
          type: string
          example: https://example.com/images/secure/profile.jpg
        IsGeoEnabled:
          type: string
          example: 'true'
        Associations:
          type: string
          example: IEEE, ACM
        Honors:
          type: string
          example: Best Developer Award 2023
        PublicRepository:
          type: string
          example: '10'
        RepositoryUrl:
          type: string
          example: https://github.com/johndoe
        ProfessionalHeadline:
          type: string
          example: Senior Software Engineer
        Currency:
          type: string
          example: USD
        StarredUrl:
          type: string
          example: https://github.com/johndoe?tab=stars
        GistsUrl:
          type: string
          example: https://gist.github.com/johndoe
        GravatarImageUrl:
          type: string
          example: https://gravatar.com/avatar/123456
        ExternalUserLoginId:
          type: string
          example: github|12345
        InterestedIn:
          type: array
          items:
            type: string
          example:
            - Technology
            - AI
            - Machine Learning
        FollowersCount:
          type: integer
          example: 1000
        FriendsCount:
          type: integer
          example: 500
        TotalStatusesCount:
          type: integer
          example: 250
        NumRecommenders:
          type: integer
          example: 50
        TotalPrivateRepository:
          type: integer
          example: 5
        PublicGists:
          type: integer
          example: 15
        PrivateGists:
          type: integer
          example: 10
        SessionLimit:
          type: integer
          example: 5
        CustomFields:
          type: object
          additionalProperties:
            type: string
          example:
            skill_level: expert
            availability: full-time
        ProfileImageUrls:
          type: object
          additionalProperties:
            type: string
          example:
            small: https://example.com/images/small.jpg
            medium: https://example.com/images/medium.jpg
            large: https://example.com/images/large.jpg
        WebProfiles:
          type: object
          additionalProperties:
            type: string
          example:
            linkedin: https://linkedin.com/in/johndoe
            twitter: https://twitter.com/johndoe
        SecurityQuestionAnswer:
          type: object
          additionalProperties:
            type: string
          example:
            First pet's name?: Spot
            Mother's maiden name?: Smith
        Country:
          type: object
          properties:
            Name:
              type: string
              example: United States
            Code:
              type: string
              example: US
        ProviderAccessCredential:
          type: object
          properties:
            AccessToken:
              type: string
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            RefreshToken:
              type: string
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            ExpiresIn:
              type: integer
              example: 3600
        Suggestions:
          type: object
          properties:
            CompaniesToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: comp_123
                  Name:
                    type: string
                    example: Microsoft
            IndustriesToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: ind_456
                  Name:
                    type: string
                    example: Software Development
            NewssourceToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: news_789
                  Name:
                    type: string
                    example: TechCrunch
            PeopleToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: user_101
                  Name:
                    type: string
                    example: Jane Smith
        Subscription:
          type: object
          properties:
            Name:
              type: string
              example: Premium Plan
            Space:
              type: string
              example: 50GB
            PrivateRepos:
              type: string
              example: Unlimited
            Collaborators:
              type: string
              example: '10'
            AgeRange:
              type: object
              properties:
                Min:
                  type: integer
                  example: 25
                Max:
                  type: integer
                  example: 34
        PrivacyPolicy:
          type: object
          properties:
            Version:
              type: string
              example: 2.1.0
        PINInfo:
          type: object
          properties:
            PIN:
              type: string
              example: '123456'
            Skipped:
              type: boolean
              example: false
        Addresses:
          type: array
          items:
            type: object
            properties:
              Type:
                type: string
                example: Home
              AddressType:
                type: string
                example: Primary
              Address1:
                type: string
                example: 123 Main Street
              Address2:
                type: string
                example: Apt 4B
              City:
                type: string
                example: Boston
              State:
                type: string
                example: MA
              PostalCode:
                type: string
                example: '02108'
              Region:
                type: string
                example: New England
              Op:
                type: string
                example: add
              Country:
                type: string
                example: USA
        Positions:
          type: array
          items:
            type: object
            properties:
              Position:
                type: string
                example: Senior Software Engineer
              Summary:
                type: string
                example: Leading the frontend development team
              StartDate:
                type: string
                format: date-time
                example: '2020-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2023-06-30T00:00:00Z'
              IsCurrent:
                type: boolean
                nullable: true
                example: true
              Company:
                type: object
                properties:
                  Name:
                    type: string
                    example: Tech Solutions Inc
                  Type:
                    type: string
                    example: Private
                  Industry:
                    type: string
                    example: Information Technology
        Educations:
          type: array
          items:
            type: object
            properties:
              School:
                type: string
                example: MIT
              Year:
                type: string
                example: '2019'
              Type:
                type: string
                example: University
              Notes:
                type: string
                example: Graduated with honors
              Activities:
                type: string
                example: Robotics Club, Chess Team
              Degree:
                type: string
                example: Bachelor of Science
              FieldOfStudy:
                type: string
                example: Computer Science
              StartDate:
                type: string
                format: date-time
                example: '2015-09-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2019-05-30T00:00:00Z'
        PhoneNumbers:
          type: array
          items:
            type: object
            properties:
              PhoneType:
                type: string
                example: Mobile
              PhoneNumber:
                type: string
                example: +1-555-555-0123
              op:
                type: string
                example: add
        IMAccounts:
          type: array
          items:
            type: object
            properties:
              AccountType:
                type: string
                example: Skype
              AccountName:
                type: string
                example: john.doe.123
        Interests:
          type: array
          items:
            type: object
            properties:
              InterestType:
                type: string
                example: Professional
              InterestName:
                type: string
                example: Artificial Intelligence
        Sports:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: sport_123
              Name:
                type: string
                example: Basketball
        InspirationalPeople:
          type: array
          items:
            type: object
            properties:
              Name:
                type: string
                example: Ada Lovelace
              Id:
                type: string
                example: insp_789
        Awards:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: award_456
              Name:
                type: string
                example: Innovation Excellence Award
              Issuer:
                type: string
                example: Tech Industry Association
        Skills:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: skill_123
              Name:
                type: string
                example: React.js
        CurrentStatus:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: status_789
              Text:
                type: string
                example: Working on an exciting new project!
              Source:
                type: string
                example: LinkedIn
              CreatedDate:
                type: string
                format: date-time
                example: '2023-12-01T09:00:00Z'
        Certifications:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: cert_456
              Name:
                type: string
                example: AWS Certified Solutions Architect
              Authority:
                type: string
                example: Amazon Web Services
              Number:
                type: string
                example: CERT123456
              StartDate:
                type: string
                format: date-time
                example: '2023-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2026-01-14T23:59:59Z'
        Courses:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: course_789
              Name:
                type: string
                example: Advanced Machine Learning
              Number:
                type: string
                example: CS501
        Volunteer:
          type: array
          items:
            type: object
            properties:
              Organization:
                type: string
                example: Code for Good
              Role:
                type: string
                example: Technical Mentor
              Cause:
                type: string
                example: Education
              Id:
                type: string
                example: vol_123
        RecommendationsReceived:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: rec_456
              Recommender:
                type: string
                example: Jane Smith
              RecommendationText:
                type: string
                example: John is an exceptional developer with great leadership skills
              RecommendationType:
                type: string
                example: Professional
        Languages:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: lang_789
              Name:
                type: string
                example: Spanish
              Proficiency:
                type: string
                example: Advanced
              op:
                type: string
                example: add
        Projects:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: proj_123
              Name:
                type: string
                example: AI-Powered Analytics Platform
              Summary:
                type: string
                example: Developed a machine learning platform for business analytics
              StartDate:
                type: string
                format: date-time
                example: '2023-03-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2023-11-30T00:00:00Z'
              IsCurrent:
                type: string
                example: 'false'
              With:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      example: user_456
                    Name:
                      type: string
                      example: Sarah Johnson
        Games:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: game_789
              Category:
                type: string
                example: Strategy
              Name:
                type: string
                example: Chess
              CreatedDate:
                type: string
                format: date-time
                example: '2023-01-01T00:00:00Z'
        Family:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: fam_123
              Name:
                type: string
                example: Jane Doe
              Relationship:
                type: string
                example: Spouse
        TeleVisionShow:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: show_456
              Category:
                type: string
                example: Science Fiction
              Name:
                type: string
                example: Black Mirror
              CreatedDate:
                type: string
                format: date-time
                example: '2023-06-15T00:00:00Z'
        MutualFriends:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: friend_789
              Name:
                type: string
                example: Mike Wilson
              FirstName:
                type: string
                example: Mike
              LastName:
                type: string
                example: Wilson
              Birthday:
                type: string
                format: date-time
                example: '1992-04-15T00:00:00Z'
              Hometown:
                type: string
                example: Chicago
              Link:
                type: string
                example: https://example.com/profile/mikewilson
              Gender:
                type: string
                example: M
        Movies:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: movie_123
              Category:
                type: string
                example: Drama
              Name:
                type: string
                example: The Social Network
              CreatedDate:
                type: string
                format: date-time
                example: '2023-07-20T00:00:00Z'
        Books:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: book_456
              Category:
                type: string
                example: Technology
              Name:
                type: string
                example: Clean Code
              CreatedDate:
                type: string
                example: '2023-08-01'
        Patents:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: pat_789
              Title:
                type: string
                example: Method for Efficient Data Processing
              Date:
                type: string
                example: '2023-09-15'
        FavoriteThings:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: fav_123
              Name:
                type: string
                example: Coffee
              Type:
                type: string
                example: Beverage
        RelatedProfileViews:
          type: array
          items:
            type: object
            properties:
              FirstName:
                type: string
                example: Alice
              LastName:
                type: string
                example: Brown
              Id:
                type: string
                example: view_456
        PlacesLived:
          type: array
          items:
            type: object
            properties:
              Name:
                type: string
                example: San Francisco, CA
              Operation:
                type: string
                example: add
              IsPrimary:
                type: boolean
                example: true
        Publications:
          type: array
          items:
            type: object
            properties:
              Title:
                type: string
                example: Modern Web Development Practices
              Publisher:
                type: string
                example: Tech Publishing House
              Date:
                type: string
                format: date-time
                example: '2023-10-01T00:00:00Z'
              Id:
                type: string
                example: pub_789
              Url:
                type: string
                example: https://example.com/publications/modern-web-dev
              Summary:
                type: string
                example: A comprehensive guide to modern web development techniques
              Authors:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      example: author_123
                    Name:
                      type: string
                      example: John Doe
        JobBookmarks:
          type: array
          items:
            type: object
            properties:
              IsApplied:
                type: boolean
                example: true
              IsSaved:
                type: boolean
                example: true
              ApplyTimestamp:
                type: string
                format: date-time
                example: '2023-11-15T14:30:00Z'
              SavedTimestamp:
                type: string
                format: date-time
                example: '2023-11-14T10:00:00Z'
              Job:
                type: object
                properties:
                  Active:
                    type: boolean
                    example: true
                  Id:
                    type: string
                    example: job_456
                  DescriptionSnippet:
                    type: string
                    example: Senior developer position for an innovative startup
                  PostingTimestamp:
                    type: string
                    format: date-time
                    example: '2023-11-10T09:00:00Z'
                  Compony:
                    type: object
                    properties:
                      Id:
                        type: string
                        example: comp_789
                      Name:
                        type: string
                        example: Innovation Tech
                  Position:
                    type: object
                    properties:
                      Title:
                        type: string
                        example: Senior Full Stack Developer
        Badges:
          type: array
          items:
            type: object
            properties:
              BadgeId:
                type: string
                example: badge_123
              BageId:
                type: string
                example: badge_123
              Name:
                type: string
                example: Top Contributor
              BadgeMessage:
                type: string
                example: Awarded for exceptional contributions
              BageMessage:
                type: string
                example: Awarded for exceptional contributions
              Description:
                type: string
                example: This badge is awarded to top 1% contributors
              ImageUrl:
                type: string
                example: https://example.com/badges/top-contributor.png
        MemberUrlResources:
          type: array
          items:
            type: object
            properties:
              UrlName:
                type: string
                example: Portfolio
              Url:
                type: string
                example: https://johndoe.dev
        ExternalIds:
          type: array
          items:
            type: object
            properties:
              Operation:
                type: string
                example: add
              Source:
                type: string
                example: GitHub
              SourceId:
                type: string
                example: gh_123456
        IsEmailSubscribed:
          type: boolean
          example: true
        IsProtected:
          type: boolean
          example: false
        Hireable:
          type: boolean
          example: true
        IsTwoFactorAuthenticationEnabled:
          type: boolean
          example: true
        DisableLogin:
          type: boolean
          example: false
        AcceptPrivacyPolicy:
          type: boolean
          example: true
        recaptcha_response_field:
          type: string
          example: 03AGdBq24PGRwz...
        recaptcha_challenge_field:
          type: string
          example: challenge_xyz789
        CaptchaModel:
          type: object
          properties:
            CaptchaId:
              type: string
              example: cap_123456
            CaptchaValue:
              type: string
              example: 7X4K9
        RegistrationSource:
          type: string
          example: Website
        FullName:
          type: string
          nullable: true
          example: John Robert Doe Jr.
        Consents:
          type: object
          properties:
            Events:
              type: array
              items:
                type: object
                properties:
                  IsCustom:
                    type: boolean
                    example: false
                  Event:
                    type: string
                    example: marketing_emails
            Data:
              type: array
              items:
                type: object
                properties:
                  IsAccepted:
                    type: boolean
                    example: true
                  ConsentOptionId:
                    type: string
                    example: 123e4567e89b12d3a456426614174000
        Password:
          type: string
          example: SecureP@ssw0rd123
        Email:
          type: array
          items:
            type: object
            properties:
              Type:
                type: string
                example: Primary
              Value:
                type: string
                example: john.doe@example.com
    ProfileWithoutIdentities:
      type: object
      properties:
        IsPasswordBreached:
          type: boolean
          example: false
        IsActive:
          type: boolean
          example: true
        IsDeleted:
          type: boolean
          example: false
        EmailVerified:
          type: boolean
          example: true
        IsLoginLocked:
          type: boolean
          example: false
        IsRequiredFieldsFilledOnce:
          type: boolean
          example: true
        FirstLogin:
          type: boolean
          example: false
        IsProtected:
          type: boolean
          example: false
        Hireable:
          type: boolean
          example: true
        IsSecurePassword:
          type: boolean
          nullable: true
          example: true
        IsCustomUid:
          type: boolean
          example: false
        PhoneIdVerified:
          type: boolean
          example: true
        IsEmailSubscribed:
          type: boolean
          example: true
        NoOfLogins:
          type: integer
          example: 42
        FollowersCount:
          type: integer
          example: 150
        FriendsCount:
          type: integer
          example: 89
        TotalStatusesCount:
          type: integer
          example: 234
        NumRecommenders:
          type: integer
          example: 12
        TotalPrivateRepository:
          type: integer
          example: 5
        PublicGists:
          type: integer
          example: 8
        PrivateGists:
          type: integer
          example: 3
        PinsCount:
          type: integer
          example: 25
        BoardsCount:
          type: integer
          example: 6
        LikesCount:
          type: integer
          example: 342
        SessionLimit:
          type: integer
          example: 5
        ID:
          type: string
          example: usr_12345
        Password:
          type: string
          example: '********'
        LoginLockedType:
          type: string
          example: None
        Provider:
          type: string
          example: email
        LastPasswordChangeToken:
          type: string
          example: tkn_abc123xyz
        FullName:
          type: string
          nullable: true
          example: John Michael Doe
        FirstName:
          type: string
          example: John
        LastName:
          type: string
          example: Doe
        Uid:
          type: string
          example: u123456789
        RegistrationProvider:
          type: string
          example: google
        RegistrationSource:
          type: string
          example: web
        LastLoginLocation:
          type: string
          example: New York, USA
        ExternalUserLoginId:
          type: string
          example: ext_789xyz
        PhoneId:
          type: string
          example: '+1234567890'
        UserName:
          type: string
          example: johndoe
        Prefix:
          type: string
          example: Mr
        MiddleName:
          type: string
          example: Michael
        Suffix:
          type: string
          example: Jr
        NickName:
          type: string
          example: Johnny
        ProfileName:
          type: string
          example: John.Doe
        BirthDate:
          type: string
          example: '1980-01-01'
        Gender:
          type: string
          example: male
        Website:
          type: string
          example: https://johndoe.com
        ThumbnailImageUrl:
          type: string
          example: https://example.com/thumb/profile.jpg
        ImageUrl:
          type: string
          example: https://example.com/profile.jpg
        Favicon:
          type: string
          example: https://example.com/favicon.ico
        ProfileUrl:
          type: string
          example: https://example.com/johndoe
        HomeTown:
          type: string
          example: Boston
        State:
          type: string
          example: Massachusetts
        City:
          type: string
          example: Boston
        Industry:
          type: string
          example: Technology
        About:
          type: string
          example: Software developer passionate about creating great User experiences
        TimeZone:
          type: string
          example: America/New_York
        LocalLanguage:
          type: string
          example: en-US
        CoverPhoto:
          type: string
          example: https://example.com/cover.jpg
        TagLine:
          type: string
          example: Building the future of tech
        Language:
          type: string
          example: English
        Verified:
          type: string
          example: 'true'
        UpdatedTime:
          type: string
          example: '2024-03-20T15:30:00Z'
        IsGeoEnabled:
          type: string
          example: 'true'
        Associations:
          type: string
          example: IEEE, ACM
        Honors:
          type: string
          example: Best Developer Award 2023
        HttpsImageUrl:
          type: string
          example: https://example.com/secure/profile.jpg
        MainAddress:
          type: string
          example: 123 Tech Street
        Created:
          type: string
          example: '2023-01-01T10:00:00Z'
        LocalCity:
          type: string
          example: Boston
        ProfileCity:
          type: string
          example: Boston
        LocalCountry:
          type: string
          example: United States
        ProfileCountry:
          type: string
          example: United States
        RelationshipStatus:
          type: string
          example: Single
        Quota:
          type: string
          example: '1000'
        Quote:
          type: string
          example: Code is poetry
        Religion:
          type: string
          example: Prefer not to say
        Political:
          type: string
          example: Independent
        PublicRepository:
          type: string
          example: '15'
        RepositoryUrl:
          type: string
          example: https://github.com/johndoe
        Age:
          type: string
          example: '35'
        ProfessionalHeadline:
          type: string
          example: Senior Software Engineer
        LRUserID:
          type: string
          example: lr_123456
        Currency:
          type: string
          example: USD
        StarredUrl:
          type: string
          example: https://github.com/johndoe?tab=stars
        GistsUrl:
          type: string
          example: https://gist.github.com/johndoe
        Company:
          type: string
          example: Tech Corp Inc.
        GravatarImageUrl:
          type: string
          example: https://gravatar.com/avatar/123
        LastPasswordChangeDate:
          type: string
          format: date-time
          example: '2024-02-15T14:30:00Z'
        PasswordExpirationDate:
          type: string
          format: date-time
          example: '2024-05-15T14:30:00Z'
        CreatedDate:
          type: string
          format: date-time
          example: '2023-01-01T10:00:00Z'
        ModifiedDate:
          type: string
          format: date-time
          example: '2024-03-20T15:30:00Z'
        ProfileModifiedDate:
          type: string
          format: date-time
          example: '2024-03-15T12:30:00Z'
        LastLoginDate:
          type: string
          format: date-time
          example: '2024-03-20T09:30:00Z'
        SignupDate:
          type: string
          format: date-time
          example: '2023-01-01T10:00:00Z'
        PrivacyPolicy:
          type: object
          properties:
            Version:
              type: string
              example: '2.0'
            AcceptSource:
              type: string
              example: web
            AcceptDateTime:
              type: string
              format: date-time
              example: '2023-01-01T10:00:00Z'
        Country:
          type: object
          properties:
            Name:
              type: string
              example: United States
            Code:
              type: string
              example: US
        AgeRange:
          type: object
          properties:
            Min:
              type: integer
              example: 25
            Max:
              type: integer
              example: 34
        KloutScore:
          type: object
          properties:
            KloutId:
              type: string
              example: klout_123
            Score:
              type: integer
              example: 63
        Suggestions:
          type: object
          properties:
            CompaniesToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: comp_123
                  Name:
                    type: string
                    example: Tech Corp
            IndustriesToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: ind_123
                  Name:
                    type: string
                    example: Software Development
            NewssourceToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: news_123
                  Name:
                    type: string
                    example: Tech Daily
            PeopleToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: usr_789
                  Name:
                    type: string
                    example: Jane Smith
        Subscription:
          type: object
          properties:
            Name:
              type: string
              example: Pro Plan
            Space:
              type: string
              example: 50GB
            PrivateRepos:
              type: string
              example: '10'
            Collaborators:
              type: string
              example: '5'
        PIN:
          type: object
          properties:
            Skipped:
              type: boolean
              example: false
            LastPINChangeToken:
              type: string
              example: pin_token_123
            LastPINChangeDate:
              type: string
              format: date-time
              example: '2024-02-01T12:00:00Z'
            SkippedDate:
              type: string
              format: date-time
              example: '2024-01-01T10:00:00Z'
            PINHashingConfig:
              type: string
              example: sha256
            PIN:
              type: string
              example: '****'
            IsPINSet:
              type: boolean
              example: true
        ConsentProfile:
          type: object
          properties:
            Consents:
              type: array
              items:
                type: object
                properties:
                  ConsentOptionId:
                    type: string
                    example: 123e4567e89b12d3a456426614174000
                  AcceptedOn:
                    type: string
                    format: date-time
                    example: '2024-03-20T15:30:00Z'
            AcceptedConsentVersions:
              type: array
              items:
                type: object
                properties:
                  IsCustom:
                    type: boolean
                    example: false
                  Event:
                    type: string
                    example: signup
                  Version:
                    type: string
                    example: '1.0'
        RegistrationData:
          type: object
          properties:
            Data:
              type: array
              items:
                type: object
                properties:
                  DataSource:
                    type: string
                    example: web_form
                  Value:
                    type: object
                    properties:
                      Id:
                        type: string
                        example: reg_123
        ProviderAccessCredential:
          type: object
          properties:
            AccessToken:
              type: string
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            TokenSecret:
              type: string
              example: secret_token_xyz
        CustomFields:
          type: object
          additionalProperties:
            type: string
            example: custom_value
        ProfileImageUrls:
          type: object
          additionalProperties:
            type: string
            example: https://example.com/images/profile_small.jpg
        WebProfiles:
          type: object
          additionalProperties:
            type: string
            example: https://linkedin.com/in/johndoe
        Roles:
          type: array
          items:
            type: string
            example: admin
          example:
            - admin
            - user
        PreviousUids:
          type: array
          items:
            type: string
            example: old_UID_123
          example:
            - old_UID_123
            - old_UID_456
        InterestedIn:
          type: array
          items:
            type: string
            example: software development
          example:
            - technology
            - sports
        ExternalIds:
          type: array
          items:
            type: object
            properties:
              Operation:
                type: string
                example: link
              Source:
                type: string
                example: github
              SourceId:
                type: string
                example: gh_123456
        UnverifiedEmail:
          type: array
          items:
            type: object
            properties:
              Type:
                type: string
                example: work
              Value:
                type: string
                example: john.doe@company.com
        Positions:
          type: array
          items:
            type: object
            properties:
              Position:
                type: string
                example: Senior Software Engineer
              Summary:
                type: string
                example: Leading backend development team
              StartDate:
                type: string
                format: date-time
                example: '2022-01-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2024-03-20T00:00:00Z'
              IsCurrent:
                type: boolean
                example: true
              Company:
                type: object
                properties:
                  Name:
                    type: string
                    example: Tech Corp Inc.
                  Type:
                    type: string
                    example: Public Company
                  Industry:
                    type: string
                    example: Information Technology
        Educations:
          type: array
          items:
            type: object
            properties:
              School:
                type: string
                example: MIT
              Year:
                type: string
                example: '2020'
              Type:
                type: string
                example: University
              Notes:
                type: string
                example: Dean's List
              Activities:
                type: string
                example: Robotics Club, Coding Competition
              Degree:
                type: string
                example: Master of Science
              FieldOfStudy:
                type: string
                example: Computer Science
              StartDate:
                type: string
                format: date-time
                example: '2018-09-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2020-05-30T00:00:00Z'
        PhoneNumbers:
          type: array
          items:
            type: object
            properties:
              PhoneType:
                type: string
                example: mobile
              PhoneNumber:
                type: string
                example: +1-555-123-4567
              op:
                type: string
                example: add
        IMAccounts:
          type: array
          items:
            type: object
            properties:
              AccountType:
                type: string
                example: skype
              AccountName:
                type: string
                example: john.doe.123
        Addresses:
          type: array
          items:
            type: object
            properties:
              Type:
                type: string
                example: home
              AddressType:
                type: string
                example: primary
              Address1:
                type: string
                example: 123 Tech Street
              Address2:
                type: string
                example: Apt 4B
              City:
                type: string
                example: San Francisco
              State:
                type: string
                example: CA
              PostalCode:
                type: string
                example: '94105'
              Region:
                type: string
                example: Bay Area
              Op:
                type: string
                example: add
              Country:
                type: string
                example: United States
        Interests:
          type: array
          items:
            type: object
            properties:
              InterestType:
                type: string
                example: professional
              InterestName:
                type: string
                example: Artificial Intelligence
        Sports:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: sport_123
              Name:
                type: string
                example: Basketball
        InspirationalPeople:
          type: array
          items:
            type: object
            properties:
              Name:
                type: string
                example: Ada Lovelace
              Id:
                type: string
                example: insp_123
        Awards:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: award_123
              Name:
                type: string
                example: Innovation Award
              Issuer:
                type: string
                example: Tech Association
        Skills:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: skill_123
              Name:
                type: string
                example: Python Programming
        CurrentStatus:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: status_123
              Text:
                type: string
                example: Working on exciting AI project
              Source:
                type: string
                example: linkedin
              CreatedDate:
                type: string
                format: date-time
                example: '2024-03-20T15:30:00Z'
        Certifications:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: cert_123
              Name:
                type: string
                example: AWS Certified Solutions Architect
              Authority:
                type: string
                example: Amazon Web Services
              Number:
                type: string
                example: CERT-123-45678
              StartDate:
                type: string
                format: date-time
                example: '2023-01-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2026-01-01T00:00:00Z'
        Courses:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: course_123
              Name:
                type: string
                example: Advanced Machine Learning
              Number:
                type: string
                example: CS-401
        Volunteer:
          type: array
          items:
            type: object
            properties:
              Organization:
                type: string
                example: Code for Good
              Role:
                type: string
                example: Technical Mentor
              Cause:
                type: string
                example: Education
              Id:
                type: string
                example: vol_123
        RecommendationsReceived:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: rec_123
              Recommender:
                type: string
                example: Jane Smith
              RecommendationText:
                type: string
                example: Excellent team player and technical leader
              RecommendationType:
                type: string
                example: professional
        Languages:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: lang_123
              Name:
                type: string
                example: Spanish
              Proficiency:
                type: string
                example: fluent
              op:
                type: string
                example: add
        Projects:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: proj_123
              Name:
                type: string
                example: AI-Powered Analytics Platform
              Summary:
                type: string
                example: Led development of machine learning pipeline
              StartDate:
                type: string
                format: date-time
                example: '2023-06-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2024-02-28T00:00:00Z'
              IsCurrent:
                type: string
                example: 'false'
              With:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      example: user_789
                    Name:
                      type: string
                      example: Sarah Johnson
        Games:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: game_123
              Category:
                type: string
                example: Strategy
              Name:
                type: string
                example: Chess
              CreatedDate:
                type: string
                format: date-time
                example: '2024-01-15T10:30:00Z'
        Family:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: fam_123
              Name:
                type: string
                example: Jane Doe
              Relationship:
                type: string
                example: Spouse
        TelevisionShow:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: show_123
              Category:
                type: string
                example: Science Fiction
              Name:
                type: string
                example: Black Mirror
              CreatedDate:
                type: string
                format: date-time
                example: '2024-02-01T12:00:00Z'
        MutualFriends:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: friend_123
              Name:
                type: string
                example: Alice Smith
              FirstName:
                type: string
                example: Alice
              LastName:
                type: string
                example: Smith
              Birthday:
                type: string
                format: date-time
                example: '1985-03-15T00:00:00Z'
              Hometown:
                type: string
                example: Chicago
              Link:
                type: string
                example: https://example.com/alice.smith
              Gender:
                type: string
                example: female
        Movies:
          type: array
          items:
            type: object
            properties:
              MovieName:
                type: string
                example: The Matrix
              Genre:
                type: string
                example: Science Fiction
        Books:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: book_123
              Category:
                type: string
                example: Non-fiction
              Name:
                type: string
                example: Clean Code
              CreatedDate:
                type: string
                example: '2024-01-01'
        Patents:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: pat_123
              Title:
                type: string
                example: AI-Based Data Processing System
              Date:
                type: string
                example: '2023-06-15'
        FavoriteThings:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: fav_123
              Name:
                type: string
                example: Photography
              Type:
                type: string
                example: Hobby
        RelatedProfileViews:
          type: array
          items:
            type: object
            properties:
              FirstName:
                type: string
                example: Robert
              LastName:
                type: string
                example: Johnson
              Id:
                type: string
                example: view_123
        PlacesLived:
          type: array
          items:
            type: object
            properties:
              Name:
                type: string
                example: Seattle, WA
              Operation:
                type: string
                example: add
              IsPrimary:
                type: boolean
                example: true
        Publications:
          type: array
          items:
            type: object
            properties:
              Title:
                type: string
                example: Modern Software Architecture
              Publisher:
                type: string
                example: Tech Publishing House
              Date:
                type: string
                format: date-time
                example: '2023-08-15T00:00:00Z'
              Id:
                type: string
                example: pub_123
              Url:
                type: string
                example: https://example.com/publication/123
              Summary:
                type: string
                example: A comprehensive guide to modern software architecture patterns
              Authors:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      example: auth_123
                    Name:
                      type: string
                      example: John Doe
        JobBookmarks:
          type: array
          items:
            type: object
            properties:
              IsApplied:
                type: boolean
                example: true
              IsSaved:
                type: boolean
                example: true
              ApplyTimestamp:
                type: string
                format: date-time
                example: '2024-02-15T14:30:00Z'
              SavedTimestamp:
                type: string
                format: date-time
                example: '2024-02-10T09:15:00Z'
              Job:
                type: object
                properties:
                  Active:
                    type: boolean
                    example: true
                  Id:
                    type: string
                    example: job_123
                  DescriptionSnippet:
                    type: string
                    example: Senior Software Engineer position
                  PostingTimestamp:
                    type: string
                    format: date-time
                    example: '2024-02-01T00:00:00Z'
                  Compony:
                    type: object
                    properties:
                      Id:
                        type: string
                        example: comp_123
                      Name:
                        type: string
                        example: Tech Corp Inc.
                  Position:
                    type: object
                    properties:
                      Title:
                        type: string
                        example: Senior Software Engineer
        Badges:
          type: array
          items:
            type: object
            properties:
              BadgeId:
                type: string
                example: badge_123
              BageId:
                type: string
                example: badge_123
              Name:
                type: string
                example: Top Contributor
              BadgeMessage:
                type: string
                example: Awarded for exceptional contributions
              BageMessage:
                type: string
                example: Awarded for exceptional contributions
              Description:
                type: string
                example: Recognition for outstanding community support
              ImageUrl:
                type: string
                example: https://example.com/badges/top-contributor.png
        MemberUrlResources:
          type: array
          items:
            type: object
            properties:
              UrlName:
                type: string
                example: Portfolio
              Url:
                type: string
                example: https://johndoe.com
        Organizations:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: org_123
              Name:
                type: string
                example: Acme Corp
              LogoURL:
                type: string
                example: https://cdn.example.com/orgs/acme/logo.png
        Email:
          type: array
          items:
            type: object
            properties:
              Type:
                type: string
                example: work
              Value:
                type: string
                example: john.doe@company.com
        PasskeyLogin:
          type: object
          nullable: true
          properties:
            ProgressiveFlag:
              type: boolean
              example: true
            LocalEnrollmentFlag:
              type: boolean
              example: false
            ProgressiveEnrollmentDate:
              type: string
              format: date-time
              example: '2024-03-01T12:00:00Z'
    AuthResponseWithoutIdentites:
      properties:
        Profile:
          $ref: '#/components/schemas/ProfileWithoutIdentities'
        access_token:
          type: string
          example: 684920ba-917b-4168-b59b-eae70b430209
          description: Bearer token for authenticating API requests.
        refresh_token:
          type: string
          example: 684920ba-917b-4168-b59b-eae70b430209
          description: Long-lived token for obtaining new Access Tokens.
        expires_in:
          type: string
          example: '3600'
          description: Expiration time of the Access Token in seconds.
    RegistrationResponse:
      properties:
        IsPosted:
          type: boolean
        Data:
          $ref: '#/components/schemas/AuthResponseWithoutIdentites'
    PublicKeyCredentialCreationOptions:
      type: object
      description: |
        The parameters for creating a new public key credential.
        This contains all the necessary information for the client to generate
        a new credential and for the authenticator to attest to that credential.
      required:
        - rp
        - user
        - challenge
        - pubKeyCredParams
      properties:
        rp:
          type: object
          description: |
            Information about the Relying Party (the website or service) requesting
            the credential creation.
          required:
            - name
            - id
          properties:
            id:
              type: string
              description: |
                The domain name of the Relying Party. This is used by the authenticator
                to ensure credentials are created for the correct domain.
              example: example.com
            name:
              type: string
              description: |
                The human-readable name of the Relying Party, which may be displayed
                to the User by the authenticator.
              example: Example Corporation
            icon:
              type: string
              description: |
                Optional. A URL pointing to an image resource for the Relying Party,
                which may be displayed to the User by the authenticator.
              example: https://example.com/icon.png
        user:
          type: object
          description: |
            Information about the User for whom the credential is being created.
            This information will be stored in the authenticator.
          required:
            - id
            - name
            - displayName
          properties:
            id:
              type: string
              description: |
                A unique identifier for the User. This should be opaque but stable
                across different sessions for the same User.
              example: MIIBkzCCATigAwIBAjCCAZMwggE4oAMCAQIwggGTMII=
            name:
              type: string
              description: |
                The User's Username or Email address, which may be displayed to the User
                by the authenticator.
              example: user@example.com
            displayName:
              type: string
              description: |
                The User's display name, which may be shown to the User by the authenticator
                during credential creation.
              example: John Doe
            icon:
              type: string
              description: |
                Optional. A URL pointing to an image resource for the User, which may be
                displayed to the User by the authenticator.
              example: https://example.com/user-icon.png
        challenge:
          type: string
          description: |
            A cryptographically random challenge generated by the Relying Party server.
            This is used to prevent replay attacks and ensure the credential creation
            is fresh.
          example: Vu8M80YRTOBz3wMFXFJJKCrDf6pfuOQTlPp1GH_8-Jc
        pubKeyCredParams:
          type: array
          description: |
            An array of acceptable public key credential types and cryptographic algorithms.
            The client will select one from this list based on the capabilities of the
            authenticator.
          items:
            type: object
            required:
              - type
              - alg
            properties:
              type:
                type: string
                description: |
                  The type of credential to be created. For WebAuthn this is always "public-key".
                enum:
                  - public-key
                example: public-key
              alg:
                type: integer
                description: |
                  The COSE identifier for the cryptographic algorithm to be used.
                  Common values are -7 (ES256), -257 (RS256), -8 (EdDSA).
                example: -7
        timeout:
          type: integer
          description: |
            Optional. The time, in milliseconds, that the User has to respond to the
            credential creation request before it times out.
          example: 60000
        excludeCredentials:
          type: array
          description: |
            Optional. An array of credentials that should not be created again.
            This is used to prevent a User from registering the same credential
            multiple times.
          items:
            type: object
            required:
              - id
              - type
            properties:
              id:
                type: string
                description: |
                  The credential ID of the credential to exclude.
                example: LFdoCFJTyB82ZzSJUHc-c72yraRc_1mPvGX8ToE8su39xX26Jcqd31LUP5iRLBop
              type:
                type: string
                description: |
                  The type of credential to exclude. For WebAuthn this is always "public-key".
                enum:
                  - public-key
                example: public-key
              transports:
                type: array
                description: |
                  Optional. Hints as to how the client might communicate with the
                  authenticator of the credential to exclude.
                items:
                  type: string
                  enum:
                    - usb
                    - nfc
                    - ble
                    - internal
                    - hybrid
                    - smart-card
                example:
                  - internal
                  - usb
        authenticatorSelection:
          type: object
          description: |
            Optional. Specifies requirements for the authenticator to be used for
            credential creation.
          properties:
            authenticatorAttachment:
              type: string
              description: |
                Optional. Specifies whether the authenticator should be a platform
                authenticator (like TouchID, Windows Hello) or a cross-platform
                authenticator (like a security key).
              enum:
                - platform
                - cross-platform
              example: platform
            requireResidentKey:
              type: boolean
              description: |
                Optional. Indicates whether the authenticator must be capable of
                storing the credential on the device (resident key / discoverable credential).
              example: true
            residentKey:
              type: string
              description: |
                Optional. Specifies the Relying Party's requirements for client-side
                discoverable credentials (resident keys).
              enum:
                - discouraged
                - preferred
                - required
              example: preferred
            userVerification:
              type: string
              description: |
                Optional. Specifies whether User verification is required, preferred,
                or discouraged for credential creation.
              enum:
                - required
                - preferred
                - discouraged
              example: preferred
        attestation:
          type: string
          description: |
            Optional. Specifies whether the authenticator should attach attestation
            information to the credential.
          enum:
            - none
            - indirect
            - direct
            - enterprise
          example: direct
        extensions:
          type: object
          description: Optional WebAuthn extensions to influence authenticator behavior
          properties:
            credProps:
              type: boolean
              description: Requests information about the credential’s properties (e.g., if it's discoverable)
              example: true
            exampleExtension:
              type: string
              description: Placeholder for other extension values (can be vendor-specific)
              example: some-value
    PasskeyCredentialCreationResponse:
      type: object
      description: |
        CredentialCreationResponse represents the response from a client when creating new credentials.
        It is the result of the navigator.credentials.create() call on the client side and is
        sent to the server for verification during the registration process.
      required:
        - id
        - rawId
        - response
        - type
      properties:
        id:
          type: string
          description: |
            Base64URL-encoded string representing the ID of the newly created credential.
            This is typically the same as rawId, but encoded as a string.
          example: AUiVKBdB9M_87caeOwmagMqNO0zrQwV3yV74qnGzDiA4ky6d9OHmQQGHN0kCogAiHeuMKJKoNJ6xwTXM6xjQwx3fEKfW3yQb4P8mJ2iQPgTOdHweeDGHUF8_UWTUyoxJ
        rawId:
          type: string
          description: |
            Base64URL-encoded ArrayBuffer containing the credential ID. This ID is used by the
            Relying Party to identify the credential for future authentications.
          example: c29tZS1leGFtcGxlLXJhd0lk
        response:
          type: object
          description: |
            The authenticator's response to the client's request to create a credential.
            Contains attestation information that can be used to verify the credential's origin.
          required:
            - clientDataJSON
            - attestationObject
          properties:
            clientDataJSON:
              type: string
              description: |
                Base64URL-encoded JSON serialized client data. Contains information about the
                credential creation like the challenge, origin, and type of credential.
              example: c29tZS1leGFtcGxlLXJhd0lk
            attestationObject:
              type: string
              description: |
                Base64URL-encoded attestation object. Contains the attestation statement and 
                authenticator data used to verify the credential's provenance.
              example: c29tZS1leGFtcGxlLXJhd0lk
            transports:
              type: array
              items:
                type: string
                enum:
                  - usb
                  - nfc
                  - ble
                  - internal
                  - hybrid
              description: |
                List of transports supported by the authenticator for this credential.
                May be included by the client or extracted from attestation metadata.
              example:
                - usb
                - nfc
        type:
          type: string
          description: |
            String describing the credential type. For WebAuthn, this is always "public-key".
          enum:
            - public-key
          example: public-key
        clientExtensionResults:
          type: object
          description: Results of any WebAuthn extensions processed by the client.
          properties:
            credProps:
              type: object
              description: Credential Properties Extension results.
              properties:
                rk:
                  type: boolean
        authenticatorAttachment:
          type: string
          description: |
            Indicates the authenticator attachment modality used during credential creation. This helps
            identify the type of authenticator used, either a platform authenticator integrated into the 
            device or a roaming authenticator that can be connected to different devices.
          enum:
            - platform
            - cross-platform
          example: platform
    ProfileRequestEmailOnly:
      type: object
      properties:
        Gender:
          type: string
          example: M
        BirthDate:
          type: string
          example: '1990-01-01'
        Prefix:
          type: string
          example: Mr.
        FirstName:
          type: string
          example: John
        MiddleName:
          type: string
          example: Robert
        LastName:
          type: string
          example: Doe
        Suffix:
          type: string
          example: Jr.
        NickName:
          type: string
          example: Johnny
        ProfileName:
          type: string
          example: John R. Doe
        About:
          type: string
          example: Software developer passionate about creating great User experiences
        Company:
          type: string
          example: Tech Corp Inc.
        ImageUrl:
          type: string
          example: https://example.com/images/profile.jpg
        TimeZone:
          type: string
          example: America/New_York
        Website:
          type: string
          example: https://johndoe.com
        ThumbnailImageUrl:
          type: string
          example: https://example.com/images/thumbnail.jpg
        Favicon:
          type: string
          example: https://example.com/favicon.ico
        ProfileUrl:
          type: string
          example: https://example.com/profile/johndoe
        HomeTown:
          type: string
          example: Boston
        State:
          type: string
          example: Massachusetts
        City:
          type: string
          example: Cambridge
        Industry:
          type: string
          example: Technology
        LocalLanguage:
          type: string
          example: en-US
        Language:
          type: string
          example: English
        CoverPhoto:
          type: string
          example: https://example.com/images/cover.jpg
        TagLine:
          type: string
          example: Building the future of technology
        MainAddress:
          type: string
          example: 123 Tech Street
        LocalCity:
          type: string
          example: Cambridge
        ProfileCity:
          type: string
          example: Cambridge
        LocalCountry:
          type: string
          example: United States
        ProfileCountry:
          type: string
          example: United States
        Quota:
          type: string
          example: premium
        Religion:
          type: string
          example: Prefer not to say
        Political:
          type: string
          example: Independent
        RelationshipStatus:
          type: string
          example: Married
        HttpsImageUrl:
          type: string
          example: https://example.com/images/secure/profile.jpg
        IsGeoEnabled:
          type: string
          example: 'true'
        Associations:
          type: string
          example: IEEE, ACM
        Honors:
          type: string
          example: Best Developer Award 2023
        PublicRepository:
          type: string
          example: '10'
        RepositoryUrl:
          type: string
          example: https://github.com/johndoe
        ProfessionalHeadline:
          type: string
          example: Senior Software Engineer
        Currency:
          type: string
          example: USD
        StarredUrl:
          type: string
          example: https://github.com/johndoe?tab=stars
        GistsUrl:
          type: string
          example: https://gist.github.com/johndoe
        GravatarImageUrl:
          type: string
          example: https://gravatar.com/avatar/123456
        ExternalUserLoginId:
          type: string
          example: github|12345
        InterestedIn:
          type: array
          items:
            type: string
          example:
            - Technology
            - AI
            - Machine Learning
        FollowersCount:
          type: integer
          example: 1000
        FriendsCount:
          type: integer
          example: 500
        TotalStatusesCount:
          type: integer
          example: 250
        NumRecommenders:
          type: integer
          example: 50
        TotalPrivateRepository:
          type: integer
          example: 5
        PublicGists:
          type: integer
          example: 15
        PrivateGists:
          type: integer
          example: 10
        SessionLimit:
          type: integer
          example: 5
        CustomFields:
          type: object
          additionalProperties:
            type: string
          example:
            skill_level: expert
            availability: full-time
        ProfileImageUrls:
          type: object
          additionalProperties:
            type: string
          example:
            small: https://example.com/images/small.jpg
            medium: https://example.com/images/medium.jpg
            large: https://example.com/images/large.jpg
        WebProfiles:
          type: object
          additionalProperties:
            type: string
          example:
            linkedin: https://linkedin.com/in/johndoe
            twitter: https://twitter.com/johndoe
        SecurityQuestionAnswer:
          type: object
          additionalProperties:
            type: string
          example:
            First pet's name?: Spot
            Mother's maiden name?: Smith
        Country:
          type: object
          properties:
            Name:
              type: string
              example: United States
            Code:
              type: string
              example: US
        Suggestions:
          type: object
          properties:
            CompaniesToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: comp_123
                  Name:
                    type: string
                    example: Microsoft
            IndustriesToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: ind_456
                  Name:
                    type: string
                    example: Software Development
            NewssourceToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: news_789
                  Name:
                    type: string
                    example: TechCrunch
            PeopleToFollow:
              type: array
              items:
                type: object
                properties:
                  Id:
                    type: string
                    example: user_101
                  Name:
                    type: string
                    example: Jane Smith
        Subscription:
          type: object
          properties:
            Name:
              type: string
              example: Premium Plan
            Space:
              type: string
              example: 50GB
            PrivateRepos:
              type: string
              example: Unlimited
            Collaborators:
              type: string
              example: '10'
            AgeRange:
              type: object
              properties:
                Min:
                  type: integer
                  example: 25
                Max:
                  type: integer
                  example: 34
        PrivacyPolicy:
          type: object
          properties:
            Version:
              type: string
              example: 2.1.0
        PINInfo:
          type: object
          properties:
            PIN:
              type: string
              example: '123456'
            Skipped:
              type: boolean
              example: false
        Addresses:
          type: array
          items:
            type: object
            properties:
              Type:
                type: string
                example: Home
              AddressType:
                type: string
                example: Primary
              Address1:
                type: string
                example: 123 Main Street
              Address2:
                type: string
                example: Apt 4B
              City:
                type: string
                example: Boston
              State:
                type: string
                example: MA
              PostalCode:
                type: string
                example: '02108'
              Region:
                type: string
                example: New England
              Op:
                type: string
                example: add
              Country:
                type: string
                example: USA
        Positions:
          type: array
          items:
            type: object
            properties:
              Position:
                type: string
                example: Senior Software Engineer
              Summary:
                type: string
                example: Leading the frontend development team
              StartDate:
                type: string
                format: date-time
                example: '2020-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2023-06-30T00:00:00Z'
              IsCurrent:
                type: boolean
                nullable: true
                example: true
              Company:
                type: object
                properties:
                  Name:
                    type: string
                    example: Tech Solutions Inc
                  Type:
                    type: string
                    example: Private
                  Industry:
                    type: string
                    example: Information Technology
        Educations:
          type: array
          items:
            type: object
            properties:
              School:
                type: string
                example: MIT
              Year:
                type: string
                example: '2019'
              Type:
                type: string
                example: University
              Notes:
                type: string
                example: Graduated with honors
              Activities:
                type: string
                example: Robotics Club, Chess Team
              Degree:
                type: string
                example: Bachelor of Science
              FieldOfStudy:
                type: string
                example: Computer Science
              StartDate:
                type: string
                format: date-time
                example: '2015-09-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2019-05-30T00:00:00Z'
        PhoneNumbers:
          type: array
          items:
            type: object
            properties:
              PhoneType:
                type: string
                example: Mobile
              PhoneNumber:
                type: string
                example: +1-555-555-0123
              op:
                type: string
                example: add
        IMAccounts:
          type: array
          items:
            type: object
            properties:
              AccountType:
                type: string
                example: Skype
              AccountName:
                type: string
                example: john.doe.123
        Interests:
          type: array
          items:
            type: object
            properties:
              InterestType:
                type: string
                example: Professional
              InterestName:
                type: string
                example: Artificial Intelligence
        Sports:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: sport_123
              Name:
                type: string
                example: Basketball
        InspirationalPeople:
          type: array
          items:
            type: object
            properties:
              Name:
                type: string
                example: Ada Lovelace
              Id:
                type: string
                example: insp_789
        Awards:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: award_456
              Name:
                type: string
                example: Innovation Excellence Award
              Issuer:
                type: string
                example: Tech Industry Association
        Skills:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: skill_123
              Name:
                type: string
                example: React.js
        CurrentStatus:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: status_789
              Text:
                type: string
                example: Working on an exciting new project!
              Source:
                type: string
                example: LinkedIn
              CreatedDate:
                type: string
                format: date-time
                example: '2023-12-01T09:00:00Z'
        Certifications:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: cert_456
              Name:
                type: string
                example: AWS Certified Solutions Architect
              Authority:
                type: string
                example: Amazon Web Services
              Number:
                type: string
                example: CERT123456
              StartDate:
                type: string
                format: date-time
                example: '2023-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2026-01-14T23:59:59Z'
        Courses:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: course_789
              Name:
                type: string
                example: Advanced Machine Learning
              Number:
                type: string
                example: CS501
        Volunteer:
          type: array
          items:
            type: object
            properties:
              Organization:
                type: string
                example: Code for Good
              Role:
                type: string
                example: Technical Mentor
              Cause:
                type: string
                example: Education
              Id:
                type: string
                example: vol_123
        RecommendationsReceived:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: rec_456
              Recommender:
                type: string
                example: Jane Smith
              RecommendationText:
                type: string
                example: John is an exceptional developer with great leadership skills
              RecommendationType:
                type: string
                example: Professional
        Languages:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: lang_789
              Name:
                type: string
                example: Spanish
              Proficiency:
                type: string
                example: Advanced
              op:
                type: string
                example: add
        Projects:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: proj_123
              Name:
                type: string
                example: AI-Powered Analytics Platform
              Summary:
                type: string
                example: Developed a machine learning platform for business analytics
              StartDate:
                type: string
                format: date-time
                example: '2023-03-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                example: '2023-11-30T00:00:00Z'
              IsCurrent:
                type: string
                example: 'false'
              With:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      example: user_456
                    Name:
                      type: string
                      example: Sarah Johnson
        Games:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: game_789
              Category:
                type: string
                example: Strategy
              Name:
                type: string
                example: Chess
              CreatedDate:
                type: string
                format: date-time
                example: '2023-01-01T00:00:00Z'
        Family:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: fam_123
              Name:
                type: string
                example: Jane Doe
              Relationship:
                type: string
                example: Spouse
        TeleVisionShow:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: show_456
              Category:
                type: string
                example: Science Fiction
              Name:
                type: string
                example: Black Mirror
              CreatedDate:
                type: string
                format: date-time
                example: '2023-06-15T00:00:00Z'
        MutualFriends:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: friend_789
              Name:
                type: string
                example: Mike Wilson
              FirstName:
                type: string
                example: Mike
              LastName:
                type: string
                example: Wilson
              Birthday:
                type: string
                format: date-time
                example: '1992-04-15T00:00:00Z'
              Hometown:
                type: string
                example: Chicago
              Link:
                type: string
                example: https://example.com/profile/mikewilson
              Gender:
                type: string
                example: M
        Movies:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: movie_123
              Category:
                type: string
                example: Drama
              Name:
                type: string
                example: The Social Network
              CreatedDate:
                type: string
                format: date-time
                example: '2023-07-20T00:00:00Z'
        Books:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: book_456
              Category:
                type: string
                example: Technology
              Name:
                type: string
                example: Clean Code
              CreatedDate:
                type: string
                example: '2023-08-01'
        Patents:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: pat_789
              Title:
                type: string
                example: Method for Efficient Data Processing
              Date:
                type: string
                example: '2023-09-15'
        FavoriteThings:
          type: array
          items:
            type: object
            properties:
              Id:
                type: string
                example: fav_123
              Name:
                type: string
                example: Coffee
              Type:
                type: string
                example: Beverage
        RelatedProfileViews:
          type: array
          items:
            type: object
            properties:
              FirstName:
                type: string
                example: Alice
              LastName:
                type: string
                example: Brown
              Id:
                type: string
                example: view_456
        PlacesLived:
          type: array
          items:
            type: object
            properties:
              Name:
                type: string
                example: San Francisco, CA
              Operation:
                type: string
                example: add
              IsPrimary:
                type: boolean
                example: true
        Publications:
          type: array
          items:
            type: object
            properties:
              Title:
                type: string
                example: Modern Web Development Practices
              Publisher:
                type: string
                example: Tech Publishing House
              Date:
                type: string
                format: date-time
                example: '2023-10-01T00:00:00Z'
              Id:
                type: string
                example: pub_789
              Url:
                type: string
                example: https://example.com/publications/modern-web-dev
              Summary:
                type: string
                example: A comprehensive guide to modern web development techniques
              Authors:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      example: author_123
                    Name:
                      type: string
                      example: John Doe
        JobBookmarks:
          type: array
          items:
            type: object
            properties:
              IsApplied:
                type: boolean
                example: true
              IsSaved:
                type: boolean
                example: true
              ApplyTimestamp:
                type: string
                format: date-time
                example: '2023-11-15T14:30:00Z'
              SavedTimestamp:
                type: string
                format: date-time
                example: '2023-11-14T10:00:00Z'
              Job:
                type: object
                properties:
                  Active:
                    type: boolean
                    example: true
                  Id:
                    type: string
                    example: job_456
                  DescriptionSnippet:
                    type: string
                    example: Senior developer position for an innovative startup
                  PostingTimestamp:
                    type: string
                    format: date-time
                    example: '2023-11-10T09:00:00Z'
                  Compony:
                    type: object
                    properties:
                      Id:
                        type: string
                        example: comp_789
                      Name:
                        type: string
                        example: Innovation Tech
                  Position:
                    type: object
                    properties:
                      Title:
                        type: string
                        example: Senior Full Stack Developer
        Badges:
          type: array
          items:
            type: object
            properties:
              BadgeId:
                type: string
                example: badge_123
              BageId:
                type: string
                example: badge_123
              Name:
                type: string
                example: Top Contributor
              BadgeMessage:
                type: string
                example: Awarded for exceptional contributions
              BageMessage:
                type: string
                example: Awarded for exceptional contributions
              Description:
                type: string
                example: This badge is awarded to top 1% contributors
              ImageUrl:
                type: string
                example: https://example.com/badges/top-contributor.png
        MemberUrlResources:
          type: array
          items:
            type: object
            properties:
              UrlName:
                type: string
                example: Portfolio
              Url:
                type: string
                example: https://johndoe.dev
        ExternalIds:
          type: array
          items:
            type: object
            properties:
              Operation:
                type: string
                example: add
              Source:
                type: string
                example: GitHub
              SourceId:
                type: string
                example: gh_123456
        IsEmailSubscribed:
          type: boolean
          example: true
        IsProtected:
          type: boolean
          example: false
        Hireable:
          type: boolean
          example: true
        DisableLogin:
          type: boolean
          example: false
        AcceptPrivacyPolicy:
          type: boolean
          example: true
        RegistrationSource:
          type: string
          example: Website
        FullName:
          type: string
          example: John Robert Doe Jr.
        Consents:
          type: object
          properties:
            Events:
              type: array
              items:
                type: object
                properties:
                  IsCustom:
                    type: boolean
                    example: false
                  Event:
                    type: string
                    example: marketing_emails
            Data:
              type: array
              items:
                type: object
                properties:
                  IsAccepted:
                    type: boolean
                    example: true
                  ConsentOptionId:
                    type: string
                    example: 123e4567e89b12d3a456426614174000
        Email:
          type: array
          items:
            type: object
            properties:
              Type:
                type: string
                example: Primary
              Value:
                type: string
                example: john.doe@example.com
    PasskeyRegisterFinish:
      allOf:
        - type: object
          properties:
            PasskeyCredential:
              $ref: '#/components/schemas/PasskeyCredentialCreationResponse'
        - $ref: '#/components/schemas/ProfileRequestEmailOnly'
    LoginByEmailRequest:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            SecurityAnswer:
              type: object
              additionalProperties:
                type: string
              description: The security answers which is set for the User, this will be used when the User is blocked for the security question.
              nullable: true
            Email:
              type: string
              description: The Email address of the User
            Password:
              type: string
              description: The Password of the User
    LoginByUsernameRequest:
      type: object
      required:
        - username
        - password
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            username:
              type: string
              description: The Username of the User
            password:
              type: string
              format: password
              description: The Password of the User
            securityAnswer:
              type: string
              description: The security answer which is set for the User, this will be used when the User is blocked for the security question.
    LoginByPhone:
      type: object
      required:
        - phone
        - password
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            phone:
              type: string
              description: The Phone number of the User
            password:
              type: string
              format: password
              description: The Password of the User
            securityAnswer:
              type: string
              description: The security answer which is set for the User, this will be used when the User is blocked for the security question.
    AuthResponseOptionalMfa:
      type: object
      allOf:
        - $ref: '#/components/schemas/AuthResponse'
      properties:
        SecondFactorAuthentication:
          type: object
          description: The two-factor authentication method response, if the User has 2FA enabled.
          nullable: true
    EmailOTPStatus:
      type: object
      properties:
        Email:
          type: string
          example: u**r@e*****e.c*m
    SecurityQuestions:
      type: object
      properties:
        QuestionId:
          type: string
          example: db7****8a73e4******bd9****8c20
        Question:
          type: string
          example: What is your pet's name?
    TwoFactorAuthenticationSettings:
      type: object
      description: This holds the second factor authentication settings excluding SecondFactorAuthentication token
      properties:
        SecondFactorAuthenticationToken:
          type: string
          description: Token for second factor authentication
          example: 684920ba-917b-4168-b59b-eae70b430209
        ExpireIn:
          type: string
          format: date-time
          description: Expiration time of the token
          example: '2021-04-06T08:36:53.3005592Z'
        QRCode:
          type: string
          nullable: true
          example: data:image/png;base64,...
        PushQRCode:
          type: string
          nullable: true
          example: https://devapi.lrinternal.com/identity/v2/auth/qr-code?apikey=xxx&token=xxxxx&size=150
        ManualEntryCode:
          type: string
          nullable: true
          example: HBRWENLDHEZGIMBYHFTDINJSMVRDANDBHE4WINJTMYZTCYZSGFRA
        DuoAuthEndpoint:
          type: string
          nullable: true
          example: https://api.duosecurity.com/auth
        IsGoogleAuthenticatorVerified:
          type: boolean
        IsPushDeviceRegistered:
          type: boolean
        IsAuthenticatorVerified:
          type: boolean
        IsEmailOtpAuthenticatorVerified:
          type: boolean
        IsOTPAuthenticatorVerified:
          type: boolean
        IsDuoAuthenticatorVerified:
          type: boolean
        IsPasskeyAuthenticatorVerified:
          type: boolean
        OTPPhoneNo:
          type: string
          nullable: true
          example: '+1234567890'
        OTPStatus:
          $ref: '#/components/schemas/SMSResponseData'
        Email:
          type: array
          items:
            type: string
            format: email
          example:
            - user@example.com
        EmailOTPStatus:
          $ref: '#/components/schemas/EmailOTPStatus'
        IsSecurityQuestionAuthenticatorVerified:
          type: boolean
        SecurityQuestions:
          type: array
          items:
            $ref: '#/components/schemas/SecurityQuestions'
    TwoFactorAuthenticationTokenObject:
      type: object
      description: This holds the second factor authentication settings including SecondFactorAuthentication token
      allOf:
        - type: object
          properties:
            SecondFactorAuthenticationToken:
              type: string
              description: Token for second factor authentication
              example: 684920ba-917b-4168-b59b-eae70b430209
            ExpireIn:
              type: string
              format: date-time
              description: Expiration time of the token
              example: '2021-04-06T08:36:53.3005592Z'
        - $ref: '#/components/schemas/TwoFactorAuthenticationSettings'
    AuthResponseRequiredMfa:
      type: object
      allOf:
        - $ref: '#/components/schemas/TwoFactorAuthenticationTokenObject'
        - type: object
          properties:
            access_token:
              type: string
              example: 00000000-0000-0000-0000-000000000000
              description: Empty access_token
            expires_in:
              type: string
              format: date-time
              example: '0001-01-01T00:00:00Z'
              description: Empty expires_in
    IsExist:
      properties:
        IsExist:
          type: boolean
      description: Indicates whether the Email exists in the system.
    AuthResponseEmailVerification:
      properties:
        IsPosted:
          type: boolean
        Data:
          type: object
          properties:
            Email:
              type: string
              example: test@gmail.com
    VerifyEmailModel:
      type: object
      required:
        - otp
      properties:
        otp:
          type: string
          description: One-time passcode sent to the User's Email. [required if 'email' or 'uuid' is passed]
        email:
          type: string
          description: User's Email address (required if `uuid` is not passed).
        UUID:
          type: string
          description: UUID received in the response of the Auth send verification Email API (required if `email` is not passed).
        verificationtoken:
          type: string
          description: Verification token received in Email (required if `email` is not passed).
        securityanswer:
          type: object
          description: JSON object with unique security question IDs and answers.
    AuthResponseForgotReset:
      type: object
      properties:
        IsPosted:
          type: boolean
        Data:
          $ref: '#/components/schemas/AuthResponse'
    AddEmailModel:
      type: object
      required:
        - email
      properties:
        email:
          type: string
          description: email
        type:
          type: string
          description: type
    AccessTokenInBody:
      type: object
      properties:
        access_token:
          type: string
          description: Access Token for authentication
    DeleteEmailRequest:
      type: object
      required:
        - email
      properties:
        email:
          type: string
    IsDeleted:
      type: object
      properties:
        IsDeleted:
          type: boolean
          description: Indicates if the item is deleted
    PublicKeyCredentialRequestOptions:
      type: object
      description: |
        Represents the options for a WebAuthn credential assertion (authentication). This object is typically generated by the server and sent to the client to initiate the authentication ceremony using `navigator.credentials.get()`.
      required:
        - challenge
        - rpId
        - allowCredentials
        - timeout
      properties:
        challenge:
          type: string
          description: |
            A cryptographic challenge that the authenticator signs over. This is a base64url-encoded string generated by the server to prevent replay attacks.
          example: F8e3QHkHo-vlv-3R09qOfmBDY8A9GrqYK9hVujdjGHE
        rpId:
          type: string
          description: |
            The relying party identifier (usually the domain of the website) that the credential should be scoped to.
          example: login2website.com
        allowCredentials:
          type: array
          description: |
            A list of descriptors for credentials acceptable to the server. This allows the server to guide the client to use a particular credential.
          items:
            type: object
            required:
              - type
              - id
            properties:
              type:
                type: string
                description: The type of public key credential.
                example: public-key
              id:
                type: string
                description: |
                  The base64url-encoded identifier of the credential. This corresponds to the ID of a previously registered credential.
                example: bzsKo52E6_sh5mCC3FjB_w
              transports:
                type: array
                description: |
                  An array of transport methods supported by the authenticator for this credential. Values can include "usb", "nfc", "ble", or "internal".
                items:
                  type: string
                example:
                  - internal
        timeout:
          type: integer
          description: |
            Time, in milliseconds, that the caller is willing to wait for the authentication operation to complete.
          example: 60000
        userVerification:
          type: string
          description: |
            Specifies the preferred level of User verification for the authentication. Options are "required", "preferred", or "discouraged".
          enum:
            - required
            - preferred
            - discouraged
          example: preferred
        extensions:
          type: object
          description: |
            Additional parameters requesting specific processing by the client or authenticator. These are optional and can be used to enable advanced features.
          properties:
            appid:
              type: string
              description: |
                Used for backwards compatibility with FIDO U2F authenticators. Indicates the AppID for which the credential should be scoped.
              example: https://example.com
            exampleExtension:
              type: string
              description: |
                Placeholder for other extension values (can be vendor-specific).
              example: some-value
    PasskeyCredentialAssertionResponse:
      type: object
      description: |
        CredentialAssertionResponse represents the response from a client when asserting credentials.
        It is the result of the navigator.credentials.get() call on the client side and is
        sent to the server for verification during the authentication process.
      required:
        - id
        - rawId
        - response
        - type
      properties:
        id:
          type: string
          description: |
            Base64URL-encoded string representing the ID of the credential used for the authentication assertion.
            This is typically the same as rawId, but encoded as a string.
          example: LFdoCFJTyB82ZzSJUHc-c72yraRc_1mPvGX8ToE8su39xX26Jcqd31LUP5iRLBop
        type:
          type: string
          description: |
            String describing the credential type. For WebAuthn, this is always "public-key".
          enum:
            - public-key
          example: public-key
        rawId:
          type: string
          format: byte
          description: |
            Base64URL-encoded ArrayBuffer containing the credential ID. This ID is used by the
            Relying Party to identify the credential used for the authentication assertion.
          example: c29tZS1leGFtcGxlLXJhd0lk
        authenticatorAttachment:
          type: string
          description: |
            Indicates the authenticator attachment modality used during assertion. This helps identify 
            the type of authenticator used, either a platform authenticator integrated into the device 
            or a roaming authenticator that can be connected to different devices.
          enum:
            - platform
            - cross-platform
          example: platform
        response:
          type: object
          description: |
            The authenticator's response to the client's request to generate an assertion.
            Contains information about the authentication like the signature and client data.
          required:
            - clientDataJSON
            - authenticatorData
            - signature
          properties:
            clientDataJSON:
              type: string
              format: byte
              description: |
                Base64URL-encoded JSON serialized client data. Contains information about the
                authentication like the challenge, origin, and type of credential.
              example: c29tZS1leGFtcGxlLXJhd0lk
            authenticatorData:
              type: string
              format: byte
              description: |
                Base64URL-encoded authenticator data. Contains information about the authentication
                such as the RP ID hash, User presence/verification flags, counter, and extensions.
              example: c29tZS1leGFtcGxlLXJhd0lk
            signature:
              type: string
              format: byte
              description: |
                Base64URL-encoded signature. This is the actual assertion signature produced by
                the authenticator using its private key.
              example: c29tZS1leGFtcGxlLXJhd0lk
            userHandle:
              type: string
              format: byte
              description: |
                Optional. Base64URL-encoded User handle (user.id). Allows the Relying Party to
                link the assertion to a specific User account. It might be empty if the authenticator
                doesn't store it.
              example: c29tZS1leGFtcGxlLXJhd0lk
    PasskeyLoginFinish:
      allOf:
        - type: object
          description: Response payload after a User attempts to authenticate using a Passkey
          properties:
            SecurityAnswer:
              type: object
              additionalProperties:
                type: string
              description: The security answers
              nullable: true
            email:
              type: string
              description: Email address of the User attempting authentication
              example: mymy@yopmail.com
            PasskeyCredential:
              $ref: '#/components/schemas/PasskeyCredentialAssertionResponse'
        - $ref: '#/components/schemas/CaptchaModel'
    PasskeyLoginAutofillRequest:
      type: object
      description: Response payload after a User attempts to authenticate using a Passkey
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            SecurityAnswer:
              type: object
              additionalProperties:
                type: string
              description: The security answers
              nullable: true
            PasskeyCredential:
              $ref: '#/components/schemas/PasskeyCredentialAssertionResponse'
    DuoVerifyRequest:
      type: object
      properties:
        State:
          type: string
          description: The state which is received from Duo authenticator.
          example: k93jf0291fj29f3j29fj2309f
        Code:
          type: string
          description: The code which is received from Duo authenticator.
          example: DI.1S2dYGJUL5YF4WxLE_M...OXYAHTkw
      required:
        - State
        - Code
    TwoFAAuthByBackupCode:
      type: object
      properties:
        backupcode:
          type: string
          description: The backup code to verify MFA
      required:
        - backupcode
      example:
        backupcode: AD45XH56
    ReAuthModelByEmailOtp:
      type: object
      required:
        - emailid
        - otp
      properties:
        emailid:
          type: string
          description: User's Email address.
        otp:
          type: string
          description: One-Time Password sent to the User's Email.
    SendEmailVerificationResponse:
      type: object
      properties:
        IsPosted:
          type: boolean
          description: Indicates if the Email was successfully posted.
          example: true
        UUID:
          type: string
          description: Unique identifier for the request.
          example: 6******7-4**5-a**b-c******1
    VerifyDeleteAccountOtp:
      type: object
      properties:
        SecurityAnswer:
          type: object
          additionalProperties:
            type: string
          description: Security answers for Account verification
          nullable: true
        otp:
          type: string
          description: One-Time Password for Account deletion
          minLength: 1
        g-recaptcha-response:
          type: string
          description: Google reCAPTCHA response
          nullable: true
        qq_captcha_ticket:
          type: string
          description: QQ captcha ticket
          nullable: true
        qq_captcha_randstr:
          type: string
          description: QQ captcha random string
          nullable: true
        h-captcha-response:
          type: string
          description: hCaptcha response
          nullable: true
      required:
        - otp
    PrivacyPolicyHistoryResponse:
      type: object
      properties:
        Uid:
          type: string
          nullable: true
          description: The unique identifier (UID) of the User.
          example: 123e4567-e89b-12d3-a456-426614174000
        Current:
          type: object
          nullable: true
          description: The current accepted Privacy Policy.
          properties:
            Version:
              type: string
              nullable: true
              description: The version of the Privacy Policy.
              example: '1.0'
            AcceptSource:
              type: string
              nullable: true
              description: The source from which the Privacy Policy was accepted.
              example: Web
            AcceptDateTime:
              type: string
              format: date-time
              nullable: true
              description: The date and time when the Privacy Policy was accepted.
              example: '2024-03-20T15:30:00Z'
        History:
          type: array
          nullable: true
          description: The history of accepted privacy policies.
          items:
            type: object
            properties:
              Version:
                type: string
                nullable: true
                description: The version of the Privacy Policy.
                example: '1.0'
              AcceptSource:
                type: string
                nullable: true
                description: The source from which the Privacy Policy was accepted.
                example: Mobile App
              AcceptDateTime:
                type: string
                format: date-time
                nullable: true
                description: The date and time when the Privacy Policy was accepted.
                example: '2023-05-15T10:00:00Z'
    SetUserNameRequest:
      type: object
      required:
        - username
      properties:
        username:
          type: string
          description: The Username to change of the User
      title: Set Or Change UserName Request
      description: Structure of the request body for set or change username
    Identity:
      type: object
      properties:
        IsPasswordBreached:
          type: boolean
          description: Indicates if the Password has been breached.
          example: false
        IsActive:
          type: boolean
          description: Indicates if the User Account is active.
          example: true
        IsDeleted:
          type: boolean
          description: Indicates if the User Account is deleted.
          example: false
        EmailVerified:
          type: boolean
          description: Indicates if the User's Email is verified.
          example: true
        IsLoginLocked:
          type: boolean
          description: Indicates if the User's login is locked.
          example: false
        IsRequiredFieldsFilledOnce:
          type: boolean
          description: Indicates if required fields have been filled at least once.
          example: true
        FirstLogin:
          type: boolean
          description: Indicates if this is the User's first login.
          example: true
          nullable: true
        IsProtected:
          type: boolean
          description: Indicates if the User Account is protected.
          example: false
        Hireable:
          type: boolean
          description: Indicates if the User is hireable.
          example: true
        IsSecurePassword:
          type: boolean
          description: Indicates if the Password is secure.
          nullable: true
          example: true
        IsCustomUid:
          type: boolean
          description: Indicates if the UID is custom.
          example: false
        PhoneIdVerified:
          type: boolean
          description: Indicates if the Phone ID is verified.
          example: true
        IsEmailSubscribed:
          type: boolean
          description: Indicates if the User is subscribed to emails.
          example: true
        NoOfLogins:
          type: integer
          description: Number of logins by the User.
          example: 10
        FollowersCount:
          type: integer
          description: Number of followers the User has.
          example: 1250
        FriendsCount:
          type: integer
          description: Number of friends the User has.
          example: 458
        TotalStatusesCount:
          type: integer
          description: Total number of statuses posted by the User.
          example: 2341
        NumRecommenders:
          type: integer
          description: Number of recommenders for the User.
          example: 15
        TotalPrivateRepository:
          type: integer
          description: Total number of private repositories.
          example: 8
        PublicGists:
          type: integer
          description: Total number of public gists.
          example: 23
        PrivateGists:
          type: integer
          description: Total number of private gists.
          example: 5
        PinsCount:
          type: integer
          description: Total number of PINs.
          example: 67
        BoardsCount:
          type: integer
          description: Total number of boards.
          example: 12
        LikesCount:
          type: integer
          description: Total number of likes.
          example: 892
        ID:
          type: string
          description: Unique identifier for the User Profile.
          example: usr_12345abc
        Provider:
          type: string
          description: Provider of the User Profile.
          example: facebook
        FullName:
          type: string
          description: Full name of the User.
          nullable: true
          example: John Robert Smith
        FirstName:
          type: string
          nullable: true
          description: First name of the User.
          example: John
        LastName:
          type: string
          nullable: true
          description: Last name of the User.
          example: Smith
        PhoneId:
          type: string
          description: Phone ID of the User.
          example: +1-555-123-4567
          nullable: true
        UserName:
          type: string
          nullable: true
          description: The Username of the User.
          example: john_doe
        Prefix:
          type: string
          nullable: true
          description: The prefix for the User's name.
          example: Mr.
        MiddleName:
          type: string
          description: The middle name of the User.
          example: Robert
          nullable: true
        Suffix:
          type: string
          nullable: true
          description: The suffix for the User's name.
          example: Jr.
        NickName:
          type: string
          nullable: true
          description: The nickname of the User.
          example: Johnny
        ProfileName:
          type: string
          nullable: true
          description: The profile name of the User.
          example: johnsmith
        BirthDate:
          type: string
          nullable: true
          description: The birth date of the User.
          example: '1990-05-15'
        Gender:
          type: string
          nullable: true
          description: The gender of the User.
          example: male
        Website:
          type: string
          nullable: true
          description: The website of the User.
          example: https://www.johnsmith.com
        ThumbnailImageUrl:
          type: string
          nullable: true
          description: The URL of the User's thumbnail image.
          example: https://example.com/thumbnails/john.jpg
        ImageUrl:
          type: string
          nullable: true
          description: The URL of the User's profile image.
          example: https://example.com/images/john.jpg
        Favicon:
          type: string
          nullable: true
          description: The URL of the User's favicon.
          example: https://example.com/favicon.ico
        ProfileUrl:
          type: string
          nullable: true
          description: The URL of the User's profile.
          example: https://example.com/profile/johnsmith
        HomeTown:
          type: string
          nullable: true
          description: The hometown of the User.
          example: Boston
        State:
          type: string
          nullable: true
          description: The state of the User.
          example: Massachusetts
        City:
          type: string
          nullable: true
          description: The city of the User.
          example: Cambridge
        Industry:
          type: string
          nullable: true
          description: The industry of the User.
          example: Technology
        About:
          type: string
          nullable: true
          description: A brief description about the User.
          example: Passionate software developer with 10+ years of experience
        TimeZone:
          type: string
          nullable: true
          description: The time zone of the User.
          example: America/New_York
        LocalLanguage:
          type: string
          nullable: true
          description: The local language of the User.
          example: en-US
        CoverPhoto:
          type: string
          nullable: true
          description: The URL of the User's cover photo.
          example: https://example.com/cover/john.jpg
        TagLine:
          type: string
          nullable: true
          description: The tagline of the User.
          example: Building the future through code
        Language:
          type: string
          nullable: true
          description: The language of the User.
          example: English
        Verified:
          type: string
          description: Indicates if the User is verified.
          example: 'true'
          nullable: true
        UpdatedTime:
          type: string
          nullable: true
          description: The last updated time of the User's profile.
          example: '2024-03-20T15:30:00Z'
        IsGeoEnabled:
          type: string
          nullable: true
          description: Indicates if geolocation is enabled for the User.
          example: 'true'
        Associations:
          type: string
          nullable: true
          description: The associations of the User.
          example: IEEE, ACM
        Honors:
          type: string
          nullable: true
          description: The honors received by the User.
          example: Best Developer Award 2023
        HttpsImageUrl:
          type: string
          nullable: true
          description: The HTTPS URL of the User's profile image.
          example: https://example.com/secure/images/john.jpg
        MainAddress:
          nullable: true
          type: string
          description: The main address of the User.
          example: 123 Tech Street, Cambridge, MA 02142
        Created:
          nullable: true
          type: string
          description: The creation date of the User's account.
          example: '2020-01-15T10:00:00Z'
        LocalCity:
          nullable: true
          type: string
          description: The local city of the User.
          example: Cambridge
        ProfileCity:
          nullable: true
          type: string
          description: The profile city of the User.
          example: Cambridge
        LocalCountry:
          type: string
          nullable: true
          description: The local country of the User.
          example: United States
        ProfileCountry:
          type: string
          nullable: true
          description: The profile country of the User.
          example: United States
        RelationshipStatus:
          type: string
          nullable: true
          description: The relationship status of the User.
          example: Married
        Quota:
          type: string
          nullable: true
          description: The quota assigned to the User.
          example: '1000'
        Quote:
          type: string
          nullable: true
          description: A quote associated with the User.
          example: Stay hungry, stay foolish
        Religion:
          type: string
          nullable: true
          description: The religion of the User.
          example: Private
        Political:
          type: string
          nullable: true
          description: The political views of the User.
          example: Private
        PublicRepository:
          type: string
          nullable: true
          description: The number of public repositories owned by the User.
          example: '25'
        RepositoryUrl:
          type: string
          nullable: true
          description: The URL of the User's repository.
          example: https://github.com/johnsmith
        Age:
          type: string
          description: The age of the User.
          example: '33'
          nullable: true
        ProfessionalHeadline:
          type: string
          nullable: true
          description: The professional headline of the User.
          example: Senior Software Engineer at Tech Corp
        LRUserID:
          type: string
          nullable: true
          description: The LoginRadius User ID.
          example: LR123456
        Currency:
          type: string
          nullable: true
          description: The preferred currency of the User.
          example: USD
        StarredUrl:
          type: string
          nullable: true
          description: The URL of the User's starred items.
          example: https://github.com/johnsmith?tab=stars
        GistsUrl:
          type: string
          nullable: true
          description: The URL of the User's gists.
          example: https://gist.github.com/johnsmith
        Company:
          type: string
          nullable: true
          description: The company the User is associated with.
          example: Tech Corp
        GravatarImageUrl:
          type: string
          nullable: true
          description: The URL of the User's Gravatar image.
          example: https://gravatar.com/avatar/123456
        LastPasswordChangeDate:
          nullable: true
          type: string
          format: date-time
          description: The date of the last Password change.
          example: '2024-03-15T10:00:00Z'
        PasswordExpirationDate:
          type: string
          format: date-time
          nullable: true
          description: The expiration date of the Password.
          example: '2024-06-15T10:00:00Z'
        CreatedDate:
          type: string
          format: date-time
          description: The date the Account was created.
          example: '2020-01-15T10:00:00Z'
        ModifiedDate:
          type: string
          format: date-time
          description: The date the Account was last modified.
          example: '2024-03-20T15:30:00Z'
        ProfileModifiedDate:
          type: string
          format: date-time
          nullable: true
          description: The date the Profile was last modified.
          example: '2024-03-19T12:00:00Z'
        LastLoginDate:
          nullable: true
          type: string
          format: date-time
          description: The date of the last login.
          example: '2024-03-20T16:45:00Z'
        SignupDate:
          type: string
          format: date-time
          description: The date the User signed up.
          example: '2020-01-15T10:00:00Z'
        PrivacyPolicy:
          type: object
          nullable: true
          properties:
            Version:
              type: string
              description: The version of the Privacy Policy.
              example: '1.0'
            AcceptSource:
              type: string
              description: The source of the Privacy Policy acceptance.
              example: Web
            AcceptDateTime:
              type: string
              format: date-time
              description: The date and time of Privacy Policy acceptance.
              example: '2024-03-20T15:30:00Z'
        Country:
          type: object
          nullable: true
          properties:
            Code:
              type: string
              description: The country code.
              example: US
            Name:
              type: string
              description: The country name.
              example: United States
        AgeRange:
          type: object
          nullable: true
          properties:
            Min:
              type: integer
              description: The minimum age in the range.
              example: 18
            Max:
              type: integer
              description: The maximum age in the range.
              example: 35
        KloutScore:
          type: object
          nullable: true
          properties:
            KloutId:
              type: string
              description: The Klout ID.
              example: klout_12345
            Score:
              type: number
              format: float
              description: The Klout score.
              example: 75.5
        Suggestions:
          type: object
          nullable: true
          properties:
            CompaniesToFollow:
              type: array
              description: List of companies suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The unique identifier.
                    example: company_12345
                  Name:
                    type: string
                    nullable: true
                    description: The name of the company.
                    example: Tech Corp
            IndustriesToFollow:
              type: array
              description: List of industries suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The unique identifier.
                    example: industry_12345
                  Name:
                    type: string
                    nullable: true
                    description: The name of the industry.
                    example: Software Development
            NewssourceToFollow:
              type: array
              description: List of news sources suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The unique identifier.
                    example: news_12345
                  Name:
                    type: string
                    nullable: true
                    description: The name of the news source.
                    example: Tech News Daily
            PeopleToFollow:
              type: array
              description: List of people suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The unique identifier.
                    example: person_12345
                  Name:
                    type: string
                    nullable: true
                    description: The name of the person.
                    example: John Doe
        Subscription:
          type: object
          nullable: true
          properties:
            Name:
              type: string
              description: The name of the subscription.
              example: Pro Plan
            Space:
              type: string
              description: The allocated space for the subscription.
              example: 100GB
            PrivateRepos:
              type: string
              description: The number of private repositories allowed.
              example: '50'
            Collaborators:
              type: string
              description: The number of collaborators allowed.
              example: '10'
        PIN:
          type: object
          nullable: true
          properties:
            Skipped:
              type: boolean
              description: Indicates if the PIN setup was skipped.
              example: false
            PIN:
              type: string
              description: The PIN value.
              example: '1234'
            LastPINChangeToken:
              type: string
              description: The token for the last PIN change.
              example: token_12345
              nullable: true
            LastPINChangeDate:
              nullable: true
              type: string
              format: date-time
              description: The date of the last PIN change.
              example: '2024-03-15T10:00:00Z'
            SkippedDate:
              nullable: true
              type: string
              format: date-time
              description: The date the PIN setup was skipped.
              example: '2024-03-10T10:00:00Z'
        ConsentProfile:
          type: object
          nullable: true
          description: Consent profile details.
          properties:
            AcceptedConsentVersions:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  IsCustom:
                    type: boolean
                    description: Indicates if the Consent version is custom.
                    example: false
                  Version:
                    type: integer
                    description: The version of the Consent.
                    example: 1
                  Event:
                    type: string
                    description: The event associated with the Consent.
                    example: Signup
            Consents:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  ConsentOptionId:
                    type: string
                    description: The ID of the Consent option.
                    example: 123e4567e89b12d3a456426614174000
                  AcceptOnDate:
                    nullable: true
                    type: string
                    format: date-time
                    description: The date the Consent was accepted.
                    example: '2024-03-20T15:30:00Z'
        RegistrationData:
          type: object
          nullable: true
          description: Registration data details.
          properties:
            Data:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  DataSource:
                    type: string
                    description: The source of the registration data.
                    example: Web
                  Value:
                    type: object
                    properties:
                      Id:
                        type: string
                        description: The ID of the registration data value.
                        example: data_12345
        ProviderAccessCredential:
          type: object
          nullable: true
          description: Provider access credential details.
          properties:
            AccessToken:
              type: string
              description: Access Token for the provider.
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            TokenSecret:
              type: string
              description: Token secret for the provider.
              example: abc123def456...
        CustomFields:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: Custom fields associated with the User.
          example:
            hobby: Photography
            favorite_color: Blue
        ProfileImageUrls:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: URLs of the User's profile images.
          example:
            small: https://example.com/small.jpg
            large: https://example.com/large.jpg
        WebProfiles:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: The User's web profiles.
          example:
            linkedin: https://linkedin.com/in/johndoe
            github: https://github.com/johndoe
        Roles:
          type: array
          nullable: true
          items:
            type: string
          description: Roles assigned to the User.
          example:
            - Admin
            - User
        Uid:
          type: string
          example: 577fabca-a33e-4a08-96e6-0ade8d846613
          description: the unique id which belongs to the Account
        PreviousUids:
          type: array
          nullable: true
          items:
            type: string
          description: Previous UIDs associated with the Account.
          example:
            - old_UID_123
            - old_UID_456
        InterestedIn:
          type: array
          nullable: true
          items:
            type: string
          description: Interests of the User.
          example:
            - Technology
            - Music
        ExternalIds:
          type: array
          nullable: true
          items:
            type: object
            properties:
              Operation:
                type: string
                description: The operation performed on the external ID.
                example: add
              Source:
                type: string
                description: The source of the external ID.
                example: LinkedIn
              SourceId:
                type: string
                description: The source ID of the external ID.
                example: source_12345
        UnverifiedEmail:
          type: array
          nullable: true
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of the Email.
                example: Primary
              Value:
                type: string
                description: The Email address.
                example: john.doe@example.com
        Positions:
          type: array
          nullable: true
          description: List of positions held by the User.
          items:
            type: object
            properties:
              Position:
                type: string
                description: The position held by the User.
                example: Senior Software Engineer
              Summary:
                type: string
                description: A summary of the position.
                example: Leading backend development team.
              StartDate:
                type: string
                format: date-time
                description: The start date of the position.
                example: '2022-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the position.
                example: '2024-03-20T00:00:00Z'
              IsCurrent:
                type: string
                description: Indicates if the position is current.
                example: 'true'
              Location:
                type: string
                description: The location of the position.
                example: New York
              Company:
                type: object
                properties:
                  Name:
                    type: string
                    description: The name of the company.
                    example: Tech Corp
                  Type:
                    type: string
                    description: The type of the company.
                    example: Public Company
                  Industry:
                    type: string
                    description: The industry of the company.
                    example: Software Development
        Educations:
          type: array
          nullable: true
          description: List of educational qualifications of the User.
          items:
            type: object
            properties:
              School:
                type: string
                description: The name of the school.
                example: MIT
              Year:
                type: string
                description: The year of graduation.
                example: '2012'
              Type:
                type: string
                description: The type of degree.
                example: Bachelor's
              Notes:
                type: string
                description: Additional notes about the education.
                example: Computer Science Major
              Activities:
                type: string
                description: Activities participated in during education.
                example: Robotics Club, Coding Competition
              Degree:
                type: string
                description: The degree obtained.
                example: BS Computer Science
              FieldOfStudy:
                type: string
                description: The field of study.
                example: Computer Science
              StartDate:
                type: string
                format: date-time
                description: The start date of the education.
                example: '2008-09-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the education.
                example: '2012-05-30T00:00:00Z'
        PhoneNumbers:
          type: array
          nullable: true
          description: List of Phone numbers associated with the User.
          items:
            type: object
            properties:
              PhoneType:
                type: string
                description: The type of Phone (e.g., Mobile, Home).
                example: Mobile
              PhoneNumber:
                type: string
                description: The Phone number.
                example: +1-555-123-4567
              Operation:
                type: string
                description: The operation performed on the Phone number.
                example: add
        IMAccounts:
          type: array
          nullable: true
          description: List of instant messaging accounts associated with the User.
          items:
            type: object
            properties:
              AccountType:
                type: string
                description: The type of instant messaging account.
                example: Skype
              AccountName:
                type: string
                description: The name of the instant messaging account.
                example: johnsmith_skype
        Addresses:
          type: array
          nullable: true
          description: List of addresses associated with the User.
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of address (e.g., Home, Work).
                example: Home
              Address1:
                type: string
                description: The first line of the address.
                example: 123 Tech Street
              Address2:
                type: string
                description: The second line of the address.
                example: Apt 4B
              City:
                type: string
                description: The city of the address.
                example: Cambridge
              State:
                type: string
                description: The state of the address.
                example: MA
              PostalCode:
                type: string
                description: The postal code of the address.
                example: '02142'
              Region:
                type: string
                description: The region of the address.
                example: New England
              Country:
                type: string
                description: The country of the address.
                example: USA
              Operation:
                type: string
                description: The operation performed on the address.
                example: add
        Interests:
          type: array
          nullable: true
          description: List of interests of the User.
          items:
            type: object
            properties:
              InterestedType:
                type: string
                description: The type of interest (e.g., Professional, Personal).
                example: Professional
              InterestedName:
                type: string
                description: The name of the interest.
                example: Software Architecture
        Sports:
          type: array
          nullable: true
          description: List of sports the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the sport.
                example: sport_123
              Name:
                type: string
                description: The name of the sport.
                example: Basketball
        InspirationalPeople:
          type: array
          nullable: true
          description: List of inspirational people for the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the person.
                example: person_123
              Name:
                type: string
                description: The name of the person.
                example: Linus Torvalds
        Awards:
          type: array
          nullable: true
          description: List of awards received by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the award.
                example: award_123
              Name:
                type: string
                description: The name of the award.
                example: Best Developer Award
              Issuer:
                type: string
                description: The issuer of the award.
                example: Tech Conference 2023
        Skills:
          type: array
          nullable: true
          description: List of skills possessed by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the skill.
                example: skill_123
              Name:
                type: string
                description: The name of the skill.
                example: Python Programming
        CurrentStatus:
          type: array
          nullable: true
          description: List of current statuses of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the status.
                example: status_123
              Text:
                type: string
                description: The text of the status.
                example: Working on exciting new project
              Source:
                type: string
                description: The source of the status.
                example: LinkedIn
              CreatedDate:
                type: string
                format: date-time
                description: The date the status was created.
                example: '2024-03-20T15:30:00Z'
        Certifications:
          type: array
          nullable: true
          description: List of certifications obtained by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the certification.
                example: cert_123
              Name:
                type: string
                description: The name of the certification.
                example: AWS Certified Solutions Architect
              Authority:
                type: string
                description: The authority issuing the certification.
                example: Amazon Web Services
              Number:
                type: string
                description: The certification number.
                example: CERT123456
              StartDate:
                type: string
                format: date-time
                description: The start date of the certification.
                example: '2023-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the certification.
                example: '2026-01-15T00:00:00Z'
        Courses:
          type: array
          nullable: true
          description: List of courses completed by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the course.
                example: course_123
              Name:
                type: string
                description: The name of the course.
                example: Advanced Machine Learning
              Number:
                type: string
                description: The course number.
                example: CS701
        Volunteer:
          type: array
          nullable: true
          description: List of volunteer activities by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the volunteer activity.
                example: vol_123
              Role:
                type: string
                description: The Role in the volunteer activity.
                example: Technical Mentor
              Organization:
                type: string
                description: The organization for the volunteer activity.
                example: Code for America
              Cause:
                type: string
                description: The cause of the volunteer activity.
                example: Education
        RecommendationsReceived:
          type: array
          nullable: true
          description: List of recommendations received by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the recommendation.
                example: rec_123
              RecommendationType:
                type: string
                description: The type of recommendation.
                example: Professional
              RecommendationText:
                type: string
                description: The text of the recommendation.
                example: Excellent team player and technical leader
              Recommender:
                type: string
                description: The name of the recommender.
                example: Jane Doe
        Languages:
          type: array
          nullable: true
          description: List of languages known by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the language.
                example: lang_123
              Name:
                type: string
                description: The name of the language.
                example: English
              Proficiency:
                type: string
                description: The proficiency level in the language.
                example: Native
        Projects:
          type: array
          nullable: true
          description: List of projects undertaken by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the project.
                example: proj_123
              Name:
                type: string
                description: The name of the project.
                example: AI-Powered Analytics Platform
              Summary:
                type: string
                description: A summary of the project.
                example: Led development of machine learning analytics solution
              StartDate:
                type: string
                format: date-time
                description: The start date of the project.
                example: '2023-01-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the project.
                example: '2024-01-01T00:00:00Z'
              IsCurrent:
                type: string
                description: Indicates if the project is current.
                example: 'true'
        Games:
          type: array
          nullable: true
          description: List of games the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the game.
                example: game_123
              Category:
                type: string
                description: The category of the game.
                example: Strategy
              Name:
                type: string
                description: The name of the game.
                example: Chess
              CreatedDate:
                type: string
                format: date-time
                description: The date the game was added.
                example: '2024-01-15T10:30:00Z'
        Family:
          type: array
          nullable: true
          description: List of family members of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the family member.
                example: fam_123
              Relationship:
                type: string
                description: The relationship with the family member.
                example: Spouse
              Name:
                type: string
                description: The name of the family member.
                example: Jane Smith
        TelevisionShow:
          type: array
          nullable: true
          description: List of television shows the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the television show.
                example: show_123
              Category:
                type: string
                description: The category of the television show.
                example: Science Fiction
              Name:
                type: string
                description: The name of the television show.
                example: Black Mirror
              CreatedDate:
                type: string
                format: date-time
                description: The date the television show was added.
                example: '2024-01-15T10:30:00Z'
        MutualFriends:
          type: array
          nullable: true
          description: List of mutual friends of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the mutual friend.
                example: friend_123
              Name:
                type: string
                description: The name of the mutual friend.
                example: Alice Johnson
              FirstName:
                type: string
                description: The first name of the mutual friend.
                example: Alice
              LastName:
                type: string
                description: The last name of the mutual friend.
                example: Johnson
              Birthday:
                type: string
                format: date-time
                description: The birthday of the mutual friend.
                example: '1992-05-15T00:00:00Z'
              Hometown:
                type: string
                description: The hometown of the mutual friend.
                example: Chicago
              Link:
                type: string
                description: The profile link of the mutual friend.
                example: https://example.com/profile/alice
              Gender:
                type: string
                description: The gender of the mutual friend.
                example: female
        Movies:
          type: array
          nullable: true
          description: List of movies the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the movie.
                example: movie_123
              Category:
                type: string
                description: The category of the movie.
                example: Science Fiction
              Name:
                type: string
                description: The name of the movie.
                example: The Matrix
        Books:
          type: array
          nullable: true
          description: List of books the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the book.
                example: book_123
              Category:
                type: string
                description: The category of the book.
                example: Technology
              Name:
                type: string
                description: The name of the book.
                example: Clean Code
              CreatedDate:
                type: string
                format: date-time
                description: The date the book was added.
                example: '2023-10-01T00:00:00Z'
        Patents:
          type: array
          nullable: true
          description: List of patents owned by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the patent.
                example: pat_123
              Title:
                type: string
                description: The title of the patent.
                example: Novel Machine Learning Algorithm
              Date:
                type: string
                format: date-time
                description: The date the patent was filed.
                example: '2023-10-01T00:00:00Z'
        FavoriteThings:
          type: array
          nullable: true
          description: List of favorite things of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the favorite thing.
                example: fav_123
              Name:
                type: string
                description: The name of the favorite thing.
                example: Programming
              Type:
                type: string
                description: The type of the favorite thing.
                example: Hobby
        RelatedProfileViews:
          type: array
          nullable: true
          description: List of related profile views of the User.
          items:
            type: object
            properties:
              FirstName:
                type: string
                description: The first name of the related profile.
                example: Sarah
              LastName:
                type: string
                description: The last name of the related profile.
                example: Connor
              Id:
                type: string
                description: The ID of the related profile.
                example: view_123
        PlacesLived:
          type: array
          nullable: true
          description: List of places the User has lived.
          items:
            type: object
            properties:
              Name:
                type: string
                description: The name of the place.
                example: San Francisco
              Operation:
                type: string
                description: The operation performed on the place.
                example: add
              IsPrimary:
                type: boolean
                description: Indicates if the place is the primary residence.
                example: true
        Publications:
          type: array
          nullable: true
          description: List of publications by the User.
          items:
            type: object
            properties:
              Title:
                type: string
                description: The title of the publication.
                example: Modern Software Architecture
              Publisher:
                type: string
                description: The publisher of the publication.
                example: Tech Publishing House
              Date:
                type: string
                format: date-time
                description: The date the publication was released.
                example: '2023-08-15T00:00:00Z'
              Id:
                type: string
                description: The ID of the publication.
                example: pub_123
              Url:
                type: string
                description: The URL of the publication.
                example: https://example.com/publications/123
              Summary:
                type: string
                description: A summary of the publication.
                example: A comprehensive guide to modern software architecture
              Authors:
                type: array
                nullable: true
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      description: The ID of the author.
                      example: author_123
                    Name:
                      type: string
                      description: The name of the author.
                      example: John Smith
        JobBookmarks:
          type: array
          nullable: true
          description: List of job bookmarks by the User.
          items:
            type: object
            properties:
              IsApplied:
                type: boolean
                description: Indicates if the job has been applied for.
                example: true
              IsSaved:
                type: boolean
                description: Indicates if the job has been saved.
                example: true
              ApplyTimestamp:
                type: string
                format: date-time
                description: The timestamp of the job application.
                example: '2024-02-15T14:30:00Z'
              SavedTimestamp:
                type: string
                format: date-time
                description: The timestamp of the job being saved.
                example: '2024-02-14T10:00:00Z'
              Job:
                type: object
                properties:
                  Active:
                    type: boolean
                    description: Indicates if the job is active.
                    example: true
                  Id:
                    type: string
                    description: The ID of the job.
                    example: job_123
                  DescriptionSnippet:
                    type: string
                    description: A snippet of the job description.
                    example: Senior Role in cloud architecture
                  PostingTimestamp:
                    type: string
                    format: date-time
                    description: The timestamp of the job posting.
                    example: '2024-02-01T09:00:00Z'
        Badges:
          type: array
          nullable: true
          description: List of badges earned by the User.
          items:
            type: object
            properties:
              BadgeId:
                type: string
                description: The ID of the badge.
                example: badge_123
              Name:
                type: string
                description: The name of the badge.
                example: Top Contributor
              BadgeMessage:
                type: string
                description: The message associated with the badge.
                example: Awarded for exceptional contributions
              Description:
                type: string
                description: A description of the badge.
                example: Recognition for community support
              ImageUrl:
                type: string
                description: The URL of the badge image.
                example: https://example.com/badges/top-contributor.png
        MemberUrlResources:
          type: array
          nullable: true
          description: List of member URL resources.
          items:
            type: object
            properties:
              Url:
                type: string
                description: The URL of the resource.
                example: https://johnsmith.dev
              UrlName:
                type: string
                description: The name of the URL resource.
                example: Portfolio
        Organizations:
          type: array
          nullable: true
          description: List of organizations associated with the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the organization.
                example: org_123
              Name:
                type: string
                description: The name of the organization.
                example: Acme Corp
              LogoURL:
                type: string
                description: The logo URL of the organization.
                example: https://cdn.example.com/orgs/acme/logo.png
        ObjectId:
          type: string
          description: The object ID of the User.
          example: 507f1f77bcf86cd799439011
        Email:
          type: array
          nullable: true
          description: List of Email addresses associated with the User.
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of the Email (e.g., Primary, Secondary).
                example: Primary
              Value:
                type: string
                description: The Email address.
                example: john.doe@example.com
        PasskeyLogin:
          type: object
          nullable: true
          description: Passkey login details for the User.
          properties:
            ProgressiveEnrollmentDate:
              nullable: true
              type: string
              format: date-time
              description: The date of progressive enrollment.
              example: '2024-03-15T10:00:00Z'
    IdentityResponseWithSocialWithoutLogins:
      type: object
      allOf:
        - $ref: '#/components/schemas/Identity'
        - type: object
          properties:
            Identities:
              type: array
              nullable: true
              description: List of identities with social information but without login details.
              items:
                $ref: '#/components/schemas/SocialIdentity'
    UpdateByTokenResponse:
      properties:
        IsPosted:
          type: boolean
        Data:
          $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
    IsDeleteRequestAccepted:
      description: Indicates if the item delete request is accepted
      type: object
      properties:
        IsDeleteRequestAccepted:
          type: boolean
    AuthenticatorCodeRequest:
      type: object
      properties:
        authenticatorcode:
          type: string
          description: The Authenticator code for multi-factor authentication
    PasskeyCredentialObject:
      type: object
      description: A single credential object
      properties:
        Id:
          type: string
          description: Unique identifier for the Passkey credential, typically a hashed or encoded key ID.
          example: 43e4417bd2de4a1fa82445274f864203
        Authenticator:
          type: string
          description: (Optional) Name of the authenticator used to register the Passkey, such as iCloud Keychain or Windows Hello. May be null or omitted if not available.
          example: iCloud Keychain
        Identifier:
          type: string
          description: User-provided identifier associated with the Passkey, usually an unique id.
          example: efdc233182cd4f578432d2134ea75081
        CreatedAt:
          type: string
          format: date-time
          description: Timestamp indicating when the Passkey credential was created.
          example: '2024-06-03T08:40:58.088Z'
    PasskeyListResponse:
      type: object
      description: Response containing a list of registered Passkey credentials
      properties:
        Credentials:
          type: array
          description: List of Passkey credentials associated with the User
          items:
            $ref: '#/components/schemas/PasskeyCredentialObject'
    MFABackUpCodeResponse:
      type: object
      properties:
        BackUpCodes:
          type: array
          items:
            type: string
          description: List of Backup Codes generated for MFA
      required:
        - BackUpCodes
      example:
        BackUpCodes:
          - ABC123DEF
          - XYZ789GHI
          - JKL456MNO
          - PQR987STU
          - VWX654YZA
    ReAuthResponse:
      type: object
      properties:
        SecondFactorValidationToken:
          type: string
          description: The token used for second factor validation.
          example: 68***-91**-****-b**b-e**********9
        ExpireIn:
          type: string
          format: date-time
          description: Expiry timestamp for the token.
          example: '2023-10-01T12:00:00Z'
      required:
        - SecondFactorValidationToken
        - ExpireIn
    PasskeyForgot:
      type: object
      description: Request to reset the Passkey associated with a User account due to loss or inability to access the current Passkey
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            email:
              type: string
              description: Email address of the User requesting a Passkey reset
              example: xyz@example.com
    AccessTokenResponse:
      type: object
      properties:
        access_token:
          type: string
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
          description: Bearer token for authenticating API requests.
        refresh_token:
          type: string
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
          description: Long-lived token for obtaining new Access Tokens.
        expires_in:
          type: string
          example: '3600'
          description: Expiration time of the Access Token in seconds.
    AccessTokenInfo:
      type: object
      properties:
        provider:
          type: string
          description: The provider for which the Access Token is issued.
          example: facebook
        access_token:
          type: string
          description: The Access Token associated with the provider.
          example: '********-****-****-****-************'
        isrememberme:
          type: boolean
          description: Indicates whether the "Remember Me" option was selected during login.
          example: true
    CandidateTokenModel:
      type: object
      properties:
        candidatetoken:
          type: string
          description: The candidate token
      required:
        - candidatetoken
    UnlinkSocialIdentityRequest:
      type: object
      required:
        - provider
        - providerid
      properties:
        provider:
          type: string
        providerid:
          type: string
        access_token:
          type: string
      title: Unlink social identities request
      description: Structure of the request body for unlinking the social identities from profile
    ClientGuidBodyModel:
      properties:
        clientgUID:
          type: string
          description: The client's gUID to link social identity
        access_token:
          type: string
          description: The Access Token of the User
      title: Link social identity with gUID
      description: Structure of the request body to link social identity
    OneTouchLoginByEmail:
      type: object
      properties:
        Email:
          type: string
          format: email
          description: The Email address for the one-touch login.
          example: user@example.com
        Name:
          type: string
          description: The name of the User.
          example: John Doe
        ClientGuid:
          type: string
          description: The client GUID for the one-touch login process.
          example: 123e4567-e89b-12d3-a456-426614174000
        GoogleRecaptchaResponse:
          type: string
          description: Google reCAPTCHA response.
          example: 03AGdBq26...
        QQCaptchaTicket:
          type: string
          description: QQ Captcha ticket.
          example: ticket123
        QQCaptchaRandomString:
          type: string
          description: QQ Captcha random string.
          example: random123
        HCaptchaResponse:
          type: string
          description: hCaptcha response.
          example: hCaptcha123
      required:
        - Email
        - ClientGuid
    OneTouchLoginByPhone:
      type: object
      properties:
        Phone:
          type: string
          description: The Phone number for the one-touch login.
          example: '+1234567890'
        Name:
          type: string
          description: The name of the User.
          example: John Doe
        GoogleRecaptchaResponse:
          type: string
          description: Google reCAPTCHA response.
          example: 03AGdBq26...
        QQCaptchaTicket:
          type: string
          description: QQ Captcha ticket.
          example: ticket123
        QQCaptchaRandomString:
          type: string
          description: QQ Captcha random string.
          example: random123
        HCaptchaResponse:
          type: string
          description: hCaptcha response.
          example: hCaptcha123
      required:
        - Phone
    VerifyOtpPhoneModel:
      type: object
      properties:
        SecurityAnswer:
          type: object
          additionalProperties:
            type: string
          description: Optional security answers for additional verification.
          example:
            question1: answer1
            question2: answer2
        Phone:
          type: string
          description: The Phone number for OTP verification.
          example: '+1234567890'
        GoogleRecaptchaResponse:
          type: string
          description: Google reCAPTCHA response.
          example: 03AGdBq26...
        QQCaptchaTicket:
          type: string
          description: QQ Captcha ticket.
          example: ticket123
        QQCaptchaRandomString:
          type: string
          description: QQ Captcha random string.
          example: random123
        HCaptchaResponse:
          type: string
          description: hCaptcha response.
          example: hCaptcha123
      required:
        - Phone
    IsPostedVerified:
      type: object
      properties:
        IsPosted:
          type: boolean
          description: Indicates if the item is posted.
          example: true
        IsVerified:
          type: boolean
          description: Indicates if the item is verified.
          example: true
    PinReauthRequest:
      type: object
      required:
        - pin
      properties:
        pin:
          type: string
          description: The PIN code to reauthenticate the User.
          example: '123456'
    PasswordReauthRequest:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            SecurityAnswer:
              type: object
              additionalProperties:
                type: string
              description: The security answers which is set for the User, this will be used when the User is blocked for the security question.
              nullable: true
            Password:
              type: string
              description: The Password of the User
      example:
        password: MySecurePassword123!
        SecurityAnswer:
          9d1f4208bda845d885eab43266d6543f: Smith
        g-recaptcha-response: 03AGdBq24...
        qq_captcha_ticket: ticket-example
        qq_captcha_randstr: randstr-example
        h-captcha-response: 10000000-aaaa-bbbb-cccc-000000000001
    ReAuthTwoFAModel:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            googleauthenticatorcode:
              type: string
            otp:
              type: string
            backupcode:
              type: string
            authenticatorcode:
              type: string
            securityAnswer:
              type: object
              additionalProperties:
                type: string
          oneOf:
            - required:
                - googleauthenticatorcode
            - required:
                - otp
            - required:
                - backupcode
            - required:
                - authenticatorcode
      example:
        otp: '1234'
        g-recaptcha-response: 03AGdBq24...
    TwoFAAuthBySecQuesAuthModel:
      type: object
      required:
        - securityquestionanswer
      properties:
        securityquestionanswer:
          type: array
          description: List of security question answers (required, not blank)
          items:
            type: object
            required:
              - QuestionId
              - Answer
            properties:
              QuestionId:
                type: string
                description: ID of the security question (required, not blank)
                example: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              Answer:
                type: string
                description: Answer to the security question (required, not blank)
                example: cat
    GenerateTokenResponse:
      type: object
      properties:
        Token:
          type: string
          example: e3c12e4f2c134f2ba2c6f623e1d3be7f
          description: The generated token for the specific request.
        ExpiresIn:
          type: string
          format: date-time
          example: '2025-12-31T23:59:59Z'
          description: The expiration date and time of the token.
        IdentityProviders:
          type: array
          items:
            type: string
          nullable: true
          description: The identity providers associated with the specified token, it will display a list of identity providers from where the User is already authenticated.
          example:
            - google
            - facebook
    PhoneOTPModel:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            OTP:
              type: string
              description: The one-time Password (OTP).
              example: '123456'
            Phone:
              type: string
              description: The Phone number associated with the OTP.
              example: '+1234567890'
            SecurityAnswer:
              type: object
              additionalProperties:
                type: string
              description: Optional security answers for additional verification.
          required:
            - OTP
            - Phone
    PasswordLessUserNameOTPModel:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            SecurityAnswer:
              type: object
              additionalProperties:
                type: string
              description: The security answers which is set for the User, this will be used when the User is blocked for the security question.
              nullable: true
            WelcomeEmailTemplate:
              type: string
              description: The template for the welcome Email.
              example: WelcomeTemplate
            Otp:
              type: string
              description: The one-time Password (OTP) for verification.
              example: '123456'
            UserName:
              type: string
              description: The Username associated with the Account.
              example: john_doe
          required:
            - Otp
            - UserName
    PasswordLessEmailOTPModel:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            SecurityAnswer:
              type: object
              additionalProperties:
                type: string
              description: The security answers which is set for the User, this will be used when the User is blocked for the security question.
              nullable: true
            WelcomeEmailTemplate:
              type: string
              description: The template for the welcome Email.
              example: WelcomeTemplate
            Otp:
              type: string
              description: The one-time Password (OTP) for verification.
              example: '123456'
            Email:
              type: string
              description: The Email associated with the Account.
              example: hello@example.com
          required:
            - Otp
            - Email
    PINLoginModel:
      type: object
      required:
        - pin
      properties:
        pin:
          type: string
          description: PIN used to log in the User.
        g-recaptcha-response:
          type: string
          description: Google reCAPTCHA response.
          nullable: true
        qq_captcha_ticket:
          type: string
          description: QQ captcha ticket.
          nullable: true
        qq_captcha_randstr:
          type: string
          description: QQ captcha random string.
          nullable: true
        h-captcha-response:
          type: string
          description: hCaptcha response.
          nullable: true
      example:
        pin: '7890'
    CustomObjectResponseModel:
      type: object
      properties:
        IsActive:
          type: boolean
          example: true
        IsDeleted:
          type: boolean
          example: false
        CustomObject:
          type: object
          additionalProperties: true
          example:
            key1: value1
            key2: 123
        Id:
          type: string
          example: abc123
        Uid:
          type: string
          example: user456
        DateCreated:
          type: string
          format: date-time
          example: '2024-05-28T12:34:56Z'
        DateModified:
          type: string
          format: date-time
          example: '2024-05-29T09:10:11Z'
    CustomObjectsResponseModel:
      type: object
      properties:
        Count:
          type: integer
          example: 2
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomObjectResponseModel'
    CustomObjectRequest:
      type: object
      additionalProperties: true
      example:
        firstName: John
        lastName: Doe
        age: 30
        address:
          street: 123 Main St
          city: Metropolis
        isActive: true
    PhoneIdModel:
      type: object
      properties:
        phone:
          type: string
          description: The Phone number of the User.
      required:
        - phone
      example:
        phone: '+1234567890'
      description: This model is used in changing the Phone number.
    PhoneIdModelOptional:
      type: object
      properties:
        phone:
          type: string
          description: The Phone number of the User.
      example:
        phone: '+1234567890'
      description: This model is used while resending the OTP to Phone number.
    ChangePin:
      type: object
      properties:
        oldpin:
          type: string
          example: '7547'
        newpin:
          type: string
          example: '4321'
      required:
        - oldpin
        - newpin
    PINModel:
      type: object
      required:
        - pin
      properties:
        pin:
          type: string
          description: New PIN to be set by the User.
      example:
        pin: '7890'
    ForgotPinByEmail:
      type: object
      properties:
        email:
          type: string
          description: The Email of the User.
      required:
        - email
      example:
        email: test@example.com
      description: This model is used in forgot PIN by Email API
    ForgotPinByUsername:
      type: object
      properties:
        username:
          type: string
          description: The Username of the User.
      required:
        - username
      example:
        username: jamesbond
      description: This model is used in forgot PIN by Username API
    ForgotPinByPhone:
      type: object
      properties:
        phone:
          type: string
          description: The Phone number of the User.
      required:
        - phone
      example:
        phone: '+1234567890'
      description: This model is used in forgot PIN by Phone API
    ResetPINByOTP:
      type: object
      required:
        - otp
        - pin
      properties:
        otp:
          type: string
          description: One-Time Password received by the User for verification.
        pin:
          type: string
          description: New PIN to be set by the User.
        phone:
          type: string
          description: Phone number associated with the User's account.
        username:
          type: string
          description: Username of the User.
        email:
          type: string
          format: email
          description: Email address associated with the User's account.
        g-recaptcha-response:
          type: string
          description: Google reCAPTCHA response.
          nullable: true
        qq_captcha_ticket:
          type: string
          description: QQ captcha ticket.
          nullable: true
        qq_captcha_randstr:
          type: string
          description: QQ captcha random string.
          nullable: true
        h-captcha-response:
          type: string
          description: hCaptcha response.
          nullable: true
      oneOf:
        - required:
            - phone
        - required:
            - email
        - required:
            - username
      example:
        otp: '123456'
        pin: '7890'
        username: johndoe
    ResetPINByToken:
      type: object
      required:
        - resettoken
        - pin
      properties:
        resettoken:
          type: string
          description: The reset token received via Email.
        pin:
          type: string
          description: New PIN to be set by the User.
      example:
        pin: '7890'
        resettoken: xxxxxxxxxxxxxxxxxxxx
    MFAPhoneUpdateModel:
      type: object
      properties:
        phoneno2fa:
          type: string
          description: The Phone number of the User.
      required:
        - phoneno2fa
      example:
        phoneno2fa: '+1234567890'
        description: This model is used in changing the Phone number.
    MFAVerifyPhoneOtpModel:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaModel'
        - type: object
          properties:
            SecurityAnswer:
              type: object
              additionalProperties:
                type: string
                description: Optional security answers for additional verification.
              example:
                9d1f4208bda845d885eab43266d6543f: Fluffy
                9d1f4208bda845d885eab43266d65500: Smith
            otp:
              type: string
              description: The one-time Password (OTP).
              example: '123456'
      required:
        - otp
    ConsentData:
      type: object
      properties:
        consentoptionid:
          type: string
          example: marketing_emails
        isaccepted:
          type: boolean
          example: true
      required:
        - consentoptionid
        - isaccepted
    ConsentUpdate:
      type: object
      properties:
        consents:
          type: array
          items:
            $ref: '#/components/schemas/ConsentData'
          example:
            - consentoptionid: marketing_emails
              isaccepted: true
      required:
        - consents
    ConsentVersion:
      type: object
      properties:
        IsCustom:
          type: boolean
          example: true
        Version:
          type: integer
          example: 1
        Event:
          type: string
          example: newsletter_signup
    ConsentOption:
      type: object
      properties:
        ConsentOptionId:
          type: string
          example: 123e4567e89b12d3a456426614174000
        AcceptOnDate:
          type: string
          format: date-time
          example: '2023-10-01T12:00:00Z'
    ConsentProfile:
      type: object
      properties:
        AcceptedConsentVersions:
          type: array
          items:
            $ref: '#/components/schemas/ConsentVersion'
          example:
            - IsCustom: true
              Version: 1
              Event: newsletter_signup
        Consents:
          type: array
          items:
            $ref: '#/components/schemas/ConsentOption'
          example:
            - ConsentOptionId: 123e4567e89b12d3a456426614174000
              AcceptOnDate: '2023-10-01T12:00:00Z'
    ConsentEvent:
      type: object
      properties:
        event:
          type: string
          example: newsletter_signup
        iscustom:
          type: boolean
          example: false
      required:
        - event
        - iscustom
    ConsentSubmit:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/ConsentEvent'
          example:
            - event: newsletter_signup
              iscustom: false
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConsentData'
          example:
            - consentoptionid: marketing_emails
              isaccepted: true
      required:
        - events
        - data
    ConsentResponse:
      type: object
      properties:
        Profile:
          $ref: '#/components/schemas/Profile'
        access_token:
          type: string
          description: The Access Token string
        refresh_token:
          type: string
          description: The refresh token string
        expires_in:
          type: string
          description: Expiration time of the Access Token
    ConsentProfileLog:
      type: object
      properties:
        ConsentId:
          type: string
          description: Unique identifier for the consent option
          example: 123e4567e89b12d3a456426614174000
        Event:
          type: string
          description: Event associated with this consent log entry
          example: newsletter_signup
    ConsentLog:
      type: object
      properties:
        UpdateType:
          type: string
          description: Type of update performed
          example: consent-update
          nullable: true
        UserAgent:
          type: string
          description: User agent string
          example: Mozilla/5.0
          nullable: true
        IP:
          type: string
          description: IP address of the User
          example: 192.168.1.1
          nullable: true
        Host:
          type: string
          description: Host information
          example: loginradius.com
          nullable: true
        LoggedOnDate:
          type: string
          format: date-time
          description: Date and time when the log was created
          example: '2025-07-15T12:34:56Z'
          nullable: true
        CurrentConsentFormsVersions:
          type: array
          items:
            $ref: '#/components/schemas/ConsentVersion'
          description: List of current consent form versions
        ConsentLogs:
          type: array
          items:
            $ref: '#/components/schemas/ConsentProfileLog'
          nullable: true
          description: List of consent profile logs
        Id:
          type: string
          description: ObjectId (MongoDB) of the log entry
          example: 60c72b2f9b1e8d3f4c8b4567
    ConsentLogsResponse:
      type: object
      properties:
        Uid:
          type: string
          description: User identifier
          nullable: true
        ConsentLogs:
          type: array
          items:
            $ref: '#/components/schemas/ConsentLog'
          description: List of consent logs
          nullable: true
    VerifyConsent:
      type: object
      properties:
        ConsentProfile:
          $ref: '#/components/schemas/ConsentProfile'
        IsValid:
          type: boolean
          description: Indicates if the consent is valid
    InvitationToken:
      type: object
      properties:
        Email:
          type: string
          description: The Email address of the User to whom the invitation is sent.
          example: test@example.com
        Status:
          type: string
          enum:
            - Accepted
            - Revoked
            - Expired
            - Invited
          description: The status of the invitation. Possible values are *invited*, *accepted*, *expired*, and *revoked*.
          example: Invited
        IsEmailExist:
          type: boolean
          description: Indicates whether the Email address is already associated with an existing User account.
          example: true
    EmailVerificationOrForgotPINModel:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The Email address of the User
          example: john.doe@gmail.com
      required:
        - email
      description: This model is used to verify the Email address of a User or send the forgot PIN request. It requires the Email address of the User.
    AddEmailModelManage:
      type: object
      properties:
        email:
          type: string
          format: email
          description: Email to add to the User's Account.
        type:
          type: string
          description: Email type (e.g., primary or secondary).
        uid:
          type: string
          description: The UID of the User.
      required:
        - email
        - type
        - uid
      description: The model is used to add an Email address to a User account. It requires the Email address, the type of Email (e.g., primary or secondary), and the User's unique identifier (UID).
      example:
        email: user@example.com
        type: secondary
        uid: abc123
    ForgotPasswordOrPasswordLessLoginOrAutoLoginModel:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The Email address of the User.
          example: user@example.com
        username:
          type: string
          example: johndoe
          description: The Username of the User.
      anyOf:
        - required:
            - email
        - required:
            - username
    DeleteUserModel:
      type: object
      properties:
        uid:
          type: string
          example: abc123
          description: The UID of the User.
      required:
        - uid
    AddPhoneModel:
      type: object
      properties:
        phone:
          type: string
          description: Phone number to add to the User's Account.
        uid:
          type: string
          description: The UID of the User.
      required:
        - phone
        - uid
      description: This model is used to add a Phone number to a User account. It requires the Phone number and the User's unique identifier (UID).
      example:
        phone: '+1234567890'
        uid: abc123
    OneTouchLoginPhoneModel:
      type: object
      properties:
        phone:
          type: string
          description: The Phone number of the User.
        name:
          type: string
          description: The name of the User.
      required:
        - phone
      example:
        phone: '+1234567890'
        name: john doe
    TimeStamp:
      type: string
      format: date-time
      description: Timestamp in ISO 8601 format with milliseconds and timezone.
      example: '2024-05-14T12:34:56.789Z'
    RoleContext:
      type: object
      properties:
        Context:
          type: string
          nullable: true
          description: The Context name.
          example: school
        Roles:
          type: array
          items:
            type: string
          description: List of Roles in this Context.
          example:
            - Admin
            - Student
        AdditionalPermissions:
          type: array
          items:
            type: string
          description: Additional Permissions for this Context.
          example:
            - read
            - write
        Expiration:
          $ref: '#/components/schemas/TimeStamp'
    RoleContextResponseModal:
      type: object
      properties:
        Data:
          type: array
          items:
            $ref: '#/components/schemas/RoleContext'
          description: List of Role Contexts.
      required:
        - Data
    RoleContextBodyModel:
      type: object
      properties:
        Roles:
          type: array
          items:
            type: string
          description: List of Roles for the Context.
          example:
            - Admin
            - Student
        AdditionalPermissions:
          type: array
          items:
            type: string
          description: Additional Permissions for the Context.
          example:
            - read
            - write
        Expiration:
          type: string
          format: date-time
          nullable: true
          description: Expiration date/time in ISO 8601 format.
          example: '2025-05-14T12:34:56.789Z'
        Context:
          type: string
          description: The Context name or identifier.
          example: school
      required:
        - Roles
        - AdditionalPermissions
        - Context
    UpdateRoleContextBodyModel:
      type: object
      properties:
        rolecontext:
          type: array
          items:
            $ref: '#/components/schemas/RoleContextBodyModel'
          description: List of Role Context objects.
      required:
        - rolecontext
    RoleContextBody:
      type: object
      properties:
        Context:
          type: string
          nullable: true
          example: school
        Roles:
          type: array
          items:
            type: string
          example:
            - Admin
            - Student
        AdditionalPermissions:
          type: array
          items:
            type: string
          example:
            - read
            - write
        Expiration:
          $ref: '#/components/schemas/TimeStamp'
    SecondFactorAuthenticator:
      type: object
      properties:
        IsVerified:
          type: boolean
          example: true
        IsEnabled:
          type: boolean
          example: true
        SecondFactor:
          type: string
          nullable: true
          example: TOTP
    PushDevice:
      type: object
      properties:
        deviceName:
          type: string
          example: Pixel 7
        deviceType:
          type: string
          example: Android
        deviceToken:
          type: string
          example: abcdef123456
        publicKey:
          type: string
          example: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn...
        createdAt:
          type: string
          format: date-time
          example: '2025-05-14T12:34:56.789Z'
    SecondFactorAuthenticationPushDevice:
      type: object
      properties:
        IsVerified:
          type: boolean
          example: true
        IsEnabled:
          type: boolean
          example: true
        PushDevice:
          $ref: '#/components/schemas/PushDevice'
    CredentialObj:
      type: object
      properties:
        Id:
          type: string
          description: Unique credential identifier.
          example: a1b2c3d4e5f6
        Authenticator:
          type: string
          description: Authenticator type.
          example: FIDO2
        Identifier:
          type: string
          description: Credential identifier (e.g., Username or email).
          example: user@example.com
        CreatedAt:
          type: string
          format: date-time
          description: Credential creation time.
          example: '2025-05-14T12:34:56.789Z'
    SecondFactorAuthenticationPasskeyCredential:
      type: object
      properties:
        IsVerified:
          type: boolean
          example: true
        IsEnabled:
          type: boolean
          example: true
        PasskeyCredential:
          $ref: '#/components/schemas/CredentialObj'
    GenericSecondFactorAuthentication:
      type: object
      properties:
        GoogleAuthenticator:
          $ref: '#/components/schemas/SecondFactorAuthenticator'
        OTPAuthenticator:
          $ref: '#/components/schemas/SecondFactorAuthenticator'
        EmailOTPAuthenticator:
          $ref: '#/components/schemas/SecondFactorAuthenticator'
        BackUpCodes:
          type: array
          items:
            type: string
          example:
            - '123456'
            - '654321'
            - '789012'
        Authenticator:
          $ref: '#/components/schemas/SecondFactorAuthenticator'
        PushAuthenticator:
          $ref: '#/components/schemas/SecondFactorAuthenticationPushDevice'
        DuoSecurityAuthenticator:
          $ref: '#/components/schemas/SecondFactorAuthenticator'
        PasskeyAuthenticator:
          $ref: '#/components/schemas/SecondFactorAuthenticationPasskeyCredential'
    SecondFactorAuthentication:
      allOf:
        - $ref: '#/components/schemas/GenericSecondFactorAuthentication'
        - type: object
          properties:
            SecurityQuestionAuthenticator:
              $ref: '#/components/schemas/SecondFactorAuthenticator'
    Email:
      type: object
      properties:
        Type:
          type: string
          description: The type of the Email (e.g., primary, secondary).
          example: primary
        Value:
          type: string
          format: email
          description: The Email address.
          example: user@example.com
      required:
        - Type
        - Value
    RoleContextProfileModel:
      type: object
      properties:
        RoleContext:
          $ref: '#/components/schemas/RoleContextBody'
        Uid:
          type: string
          nullable: true
          description: Unique identifier for the User.
          example: '12345'
        LastLoginDate:
          type: string
          format: date-time
          nullable: true
          description: Last login date in ISO 8601 format.
          example: '2025-05-14T12:34:56.789Z'
        FullName:
          type: string
          nullable: true
          description: Full name of the User.
          example: John Doe
        ImageUrl:
          type: string
          nullable: true
          description: URL to the User's image.
          example: https://example.com/avatar.jpg
        SecondFactorAuthentication:
          $ref: '#/components/schemas/SecondFactorAuthentication'
        Email:
          type: array
          items:
            $ref: '#/components/schemas/Email'
      required:
        - RoleContext
        - Email
    RoleContextProfileResponseModel:
      type: object
      properties:
        Data:
          type: array
          items:
            $ref: '#/components/schemas/RoleContextProfileModel'
          description: List of Role Context profiles.
      required:
        - Data
    UserRolesModel:
      type: object
      properties:
        Roles:
          type: array
          items:
            type: string
          description: List of User Roles.
          example:
            - Admin
            - User
    DeleteResponse:
      type: object
      properties:
        IsDeleted:
          type: boolean
          description: Indicates if the resource was deleted
    RemoveRoleContextRoleModel:
      type: object
      properties:
        roles:
          type: array
          items:
            type: string
          description: List of Roles to remove.
          example:
            - Admin
            - Student
      required:
        - roles
    RemoveRoleContextAdditionalPermissionsModel:
      type: object
      properties:
        additionalpermissions:
          type: array
          items:
            type: string
          description: List of Additional Permissions to remove.
          example:
            - read
            - write
      required:
        - additionalpermissions
    ManageRegisterModel:
      type: object
      properties:
        Uid:
          type: string
          nullable: true
          description: The unique identifier (UID) of the User.
          example: 123e4567-e89b-12d3-a456-426614174000
        UserName:
          type: string
          nullable: true
          description: The Username of the User.
          example: john_doe
        PhoneId:
          type: string
          nullable: true
          description: The Phone ID of the User.
          example: +1-555-123-4567
        Gender:
          type: string
          nullable: true
          description: The gender of the User.
          example: male
        BirthDate:
          type: string
          nullable: true
          description: The birth date of the User.
          example: '1990-05-15'
        Prefix:
          type: string
          nullable: true
          description: The prefix for the User's name.
          example: Mr.
        FirstName:
          type: string
          nullable: true
          description: The first name of the User.
          example: John
        MiddleName:
          type: string
          nullable: true
          description: The middle name of the User.
          example: Robert
        LastName:
          type: string
          nullable: true
          description: The last name of the User.
          example: Smith
        Suffix:
          type: string
          nullable: true
          description: The suffix for the User's name.
          example: Jr.
        NickName:
          type: string
          nullable: true
          description: The nickname of the User.
          example: Johnny
        ProfileName:
          type: string
          nullable: true
          description: The profile name of the User.
          example: johnsmith
        About:
          type: string
          nullable: true
          description: A brief description about the User.
          example: Passionate software developer with 10+ years of experience
        Company:
          type: string
          nullable: true
          description: The company the User is associated with.
          example: Tech Corp
        ImageUrl:
          type: string
          nullable: true
          description: The URL of the User's profile image.
          example: https://example.com/images/john.jpg
        TimeZone:
          type: string
          nullable: true
          description: The time zone of the User.
          example: America/New_York
        Website:
          type: string
          nullable: true
          description: The website of the User.
          example: https://www.johnsmith.com
        ThumbnailImageUrl:
          type: string
          nullable: true
          description: The URL of the User's thumbnail image.
          example: https://example.com/thumbnails/john.jpg
        Favicon:
          type: string
          nullable: true
          description: The URL of the User's favicon.
          example: https://example.com/favicon.ico
        ProfileUrl:
          type: string
          nullable: true
          description: The URL of the User's profile.
          example: https://example.com/profile/johnsmith
        HomeTown:
          type: string
          nullable: true
          description: The hometown of the User.
          example: Boston
        State:
          type: string
          nullable: true
          description: The state of the User.
          example: Massachusetts
        City:
          type: string
          nullable: true
          description: The city of the User.
          example: Cambridge
        Industry:
          type: string
          nullable: true
          description: The industry of the User.
          example: Technology
        LocalLanguage:
          type: string
          nullable: true
          description: The local language of the User.
          example: en-US
        Language:
          type: string
          nullable: true
          description: The language of the User.
          example: English
        CoverPhoto:
          type: string
          nullable: true
          description: The URL of the User's cover photo.
          example: https://example.com/cover/john.jpg
        TagLine:
          type: string
          nullable: true
          description: The tagline of the User.
          example: Building the future through code
        MainAddress:
          type: string
          nullable: true
          description: The main address of the User.
          example: 123 Tech Street, Cambridge, MA 02142
        LocalCity:
          type: string
          nullable: true
          description: The local city of the User.
          example: Cambridge
        ProfileCity:
          type: string
          nullable: true
          description: The profile city of the User.
          example: Cambridge
        LocalCountry:
          type: string
          nullable: true
          description: The local country of the User.
          example: United States
        ProfileCountry:
          type: string
          nullable: true
          description: The profile country of the User.
          example: United States
        Quota:
          type: string
          nullable: true
          description: The quota assigned to the User.
          example: '1000'
        Religion:
          type: string
          nullable: true
          description: The religion of the User.
          example: Private
        Political:
          type: string
          nullable: true
          description: The political views of the User.
          example: Private
        RelationshipStatus:
          type: string
          nullable: true
          description: The relationship status of the User.
          example: Married
        HttpsImageUrl:
          type: string
          nullable: true
          description: The HTTPS URL of the User's profile image.
          example: https://example.com/secure/images/john.jpg
        IsGeoEnabled:
          type: string
          nullable: true
          description: Indicates if geolocation is enabled for the User.
          example: 'true'
        Associations:
          type: string
          nullable: true
          description: The associations of the User.
          example: IEEE, ACM
        Honors:
          type: string
          nullable: true
          description: The honors received by the User.
          example: Best Developer Award 2023
        PublicRepository:
          type: string
          nullable: true
          description: The number of public repositories owned by the User.
          example: '25'
        RepositoryUrl:
          type: string
          nullable: true
          description: The URL of the User's repository.
          example: https://github.com/johnsmith
        ProfessionalHeadline:
          type: string
          nullable: true
          description: The professional headline of the User.
          example: Senior Software Engineer at Tech Corp
        Currency:
          type: string
          nullable: true
          description: The preferred currency of the User.
          example: USD
        StarredUrl:
          type: string
          nullable: true
          description: The URL of the User's starred items.
          example: https://github.com/johnsmith?tab=stars
        GistsUrl:
          type: string
          nullable: true
          description: The URL of the User's gists.
          example: https://gist.github.com/johnsmith
        GravatarImageUrl:
          type: string
          nullable: true
          description: The URL of the User's Gravatar image.
          example: https://gravatar.com/avatar/123456
        ExternalUserLoginId:
          type: string
          nullable: true
          description: The external User login ID.
          example: external_12345
        InterestedIn:
          type: array
          items:
            type: string
          nullable: true
          description: Interests of the User.
          example:
            - Technology
            - Innovation
            - AI
        FollowersCount:
          type: integer
          nullable: true
          description: The number of followers the User has.
          example: 1250
        FriendsCount:
          type: integer
          nullable: true
          description: The number of friends the User has.
          example: 458
        TotalStatusesCount:
          type: integer
          nullable: true
          description: The total number of statuses posted by the User.
          example: 2341
        NumRecommenders:
          type: integer
          nullable: true
          description: The number of recommenders for the User.
          example: 15
        TotalPrivateRepository:
          type: integer
          nullable: true
          description: The total number of private repositories owned by the User.
          example: 8
        PublicGists:
          type: integer
          nullable: true
          description: The total number of public gists owned by the User.
          example: 23
        PrivateGists:
          type: integer
          nullable: true
          description: The total number of private gists owned by the User.
          example: 5
        SessionLimit:
          type: integer
          nullable: true
          description: The session limit for the User.
          example: 10
        CustomFields:
          type: object
          additionalProperties:
            type: string
          nullable: true
          description: Custom fields associated with the User.
          example:
            hobby: Photography
            favorite_color: Blue
        ProfileImageUrls:
          type: object
          additionalProperties:
            type: string
          nullable: true
          description: URLs of the User's profile images.
          example:
            small: https://example.com/small.jpg
            large: https://example.com/large.jpg
        WebProfiles:
          type: object
          additionalProperties:
            type: string
          nullable: true
          description: The User's web profiles.
          example:
            linkedin: https://linkedin.com/in/johndoe
            github: https://github.com/johndoe
        SecurityQuestionAnswer:
          type: object
          additionalProperties:
            type: string
          nullable: true
          description: Security question answers for the User.
          example:
            What is your pet's name?: Fluffy
        Country:
          type: object
          description: The country details of the User.
          properties:
            Code:
              type: string
              description: The country code.
              example: US
            Name:
              type: string
              description: The country name.
              example: United States
        ProviderAccessCredential:
          type: object
          description: The provider access credentials of the User.
          properties:
            AccessToken:
              type: string
              nullable: true
              description: The Access Token for the provider.
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            TokenSecret:
              type: string
              nullable: true
              description: The token secret for the provider.
              example: abc123def456...
        Suggestions:
          type: object
          description: Suggestions for the User to follow.
          properties:
            CompaniesToFollow:
              type: array
              description: List of companies suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The ID of the company.
                    example: company_123
                  Name:
                    type: string
                    nullable: true
                    description: The name of the company.
                    example: Tech Corp
            IndustriesToFollow:
              type: array
              description: List of industries suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The ID of the industry.
                    example: industry_123
                  Name:
                    type: string
                    nullable: true
                    description: The name of the industry.
                    example: Software Development
            NewssourceToFollow:
              type: array
              description: List of news sources suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The ID of the news source.
                    example: news_123
                  Name:
                    type: string
                    nullable: true
                    description: The name of the news source.
                    example: Tech News Daily
            PeopleToFollow:
              type: array
              description: List of people suggested to follow.
              items:
                type: object
                properties:
                  Id:
                    type: string
                    nullable: true
                    description: The ID of the person.
                    example: person_123
                  Name:
                    type: string
                    nullable: true
                    description: The name of the person.
                    example: John Doe
        Subscription:
          type: object
          description: Subscription details of the User.
          properties:
            Name:
              type: string
              nullable: true
              description: The name of the subscription.
              example: Pro Plan
            Space:
              type: string
              nullable: true
              description: The allocated space for the subscription.
              example: 100GB
            PrivateRepos:
              type: string
              nullable: true
              description: The number of private repositories allowed.
              example: '50'
            Collaborators:
              type: string
              nullable: true
              description: The number of collaborators allowed.
              example: '10'
        AgeRange:
          type: object
          description: The age range of the User.
          properties:
            Min:
              type: integer
              nullable: true
              description: The minimum age in the range.
              example: 18
            Max:
              type: integer
              nullable: true
              description: The maximum age in the range.
              example: 35
        PrivacyPolicy:
          type: object
          description: The Privacy Policy details of the User.
          properties:
            Version:
              type: string
              nullable: true
              description: The version of the Privacy Policy.
              example: '1.0'
        PINInfo:
          type: object
          description: PIN information of the User.
          properties:
            PIN:
              type: string
              nullable: true
              description: The PIN of the User.
              example: '1234'
            Skipped:
              type: boolean
              nullable: true
              description: Indicates if the PIN setup was skipped.
              example: false
            IsValid:
              type: boolean
              nullable: true
              description: Indicates if the PIN is valid.
              example: true
            IOValidationRequired:
              type: boolean
              description: Indicates if IO validation is required.
              example: false
        Addresses:
          type: array
          description: List of addresses associated with the User.
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of address (e.g., Home, Work).
                example: Home
              Address1:
                type: string
                description: The first line of the address.
                example: 123 Tech Street
              City:
                type: string
                description: The city of the address.
                example: Cambridge
              State:
                type: string
                description: The state of the address.
                example: MA
              Country:
                type: string
                description: The country of the address.
                example: USA
        Positions:
          type: array
          description: List of positions held by the User.
          items:
            type: object
            properties:
              Position:
                type: string
                description: The position held by the User.
                example: Senior Software Engineer
              Company:
                type: string
                description: The company where the position was held.
                example: Tech Corp
              StartDate:
                type: string
                format: date-time
                description: The start date of the position.
                example: '2022-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the position.
                example: '2024-03-20T00:00:00Z'
              IsCurrent:
                type: boolean
                description: Indicates if the position is current.
                example: true
        Educations:
          type: array
          description: List of educational qualifications of the User.
          items:
            type: object
            properties:
              School:
                type: string
                description: The name of the school.
                example: MIT
              Degree:
                type: string
                description: The degree obtained.
                example: BS Computer Science
              FieldOfStudy:
                type: string
                description: The field of study.
                example: Computer Science
              StartDate:
                type: string
                format: date-time
                description: The start date of the education.
                example: '2008-09-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the education.
                example: '2012-05-30T00:00:00Z'
        PhoneNumbers:
          type: array
          description: List of Phone numbers associated with the User.
          items:
            type: object
            properties:
              PhoneType:
                type: string
                description: The type of Phone (e.g., Mobile, Home).
                example: Mobile
              PhoneNumber:
                type: string
                description: The Phone number.
                example: +1-555-123-4567
              Operation:
                type: string
                description: The operation performed on the Phone number.
                example: add
        IMAccounts:
          type: array
          description: List of instant messaging accounts associated with the User.
          items:
            type: object
            properties:
              AccountType:
                type: string
                description: The type of instant messaging account.
                example: Skype
              AccountName:
                type: string
                description: The name of the instant messaging account.
                example: johnsmith_skype
        Interests:
          type: array
          description: List of interests of the User.
          items:
            type: object
            properties:
              InterestedType:
                type: string
                description: The type of interest (e.g., Professional, Personal).
                example: Professional
              InterestedName:
                type: string
                description: The name of the interest.
                example: Software Architecture
        Sports:
          type: array
          description: List of sports the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the sport.
                example: sport_123
              Name:
                type: string
                description: The name of the sport.
                example: Basketball
        InspirationalPeople:
          type: array
          description: List of inspirational people for the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the person.
                example: person_123
              Name:
                type: string
                description: The name of the person.
                example: Linus Torvalds
        Awards:
          type: array
          description: List of awards received by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the award.
                example: award_123
              Name:
                type: string
                description: The name of the award.
                example: Best Developer Award
              Issuer:
                type: string
                description: The issuer of the award.
                example: Tech Conference 2023
        Skills:
          type: array
          description: List of skills possessed by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the skill.
                example: skill_123
              Name:
                type: string
                description: The name of the skill.
                example: Python Programming
        CurrentStatus:
          type: array
          description: List of current statuses of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the status.
                example: status_123
              Text:
                type: string
                description: The text of the status.
                example: Working on exciting new project
              Source:
                type: string
                description: The source of the status.
                example: LinkedIn
              CreatedDate:
                type: string
                format: date-time
                description: The date the status was created.
                example: '2024-03-20T15:30:00Z'
        Certifications:
          type: array
          description: List of certifications obtained by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the certification.
                example: cert_123
              Name:
                type: string
                description: The name of the certification.
                example: AWS Certified Solutions Architect
              Authority:
                type: string
                description: The authority that issued the certification.
                example: Amazon Web Services
              StartDate:
                type: string
                format: date-time
                description: The start date of the certification.
                example: '2023-01-15T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the certification.
                example: '2026-01-15T00:00:00Z'
        Courses:
          type: array
          description: List of courses completed by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the course.
                example: course_123
              Name:
                type: string
                description: The name of the course.
                example: Introduction to Machine Learning
              Number:
                type: string
                description: The course number.
                example: ML101
        Volunteer:
          type: array
          description: List of volunteer experiences of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the volunteer experience.
                example: volunteer_123
              Role:
                type: string
                description: The Role of the User in the volunteer experience.
                example: Volunteer Developer
              Organization:
                type: string
                description: The organization where the User volunteered.
                example: Open Source Initiative
              Cause:
                type: string
                description: The cause supported by the volunteer experience.
                example: Education
        RecommendationsReceived:
          type: array
          description: List of recommendations received by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the recommendation.
                example: recommendation_123
              RecommendationType:
                type: string
                description: The type of recommendation.
                example: Professional
              RecommendationText:
                type: string
                description: The text of the recommendation.
                example: John is an exceptional software engineer.
              Recommender:
                type: string
                description: The name of the person who gave the recommendation.
                example: Jane Doe
        Languages:
          type: array
          description: List of languages known by the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the language.
                example: lang_123
              Name:
                type: string
                description: The name of the language.
                example: English
              Proficiency:
                type: string
                description: The proficiency level in the language.
                example: Fluent
        Projects:
          type: array
          description: List of projects associated with the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the project.
                example: project_123
              Name:
                type: string
                description: The name of the project.
                example: AI Research
              Summary:
                type: string
                description: A brief summary of the project.
                example: Developed an AI model for image recognition.
              StartDate:
                type: string
                format: date-time
                description: The start date of the project.
                example: '2022-01-01T00:00:00Z'
              EndDate:
                type: string
                format: date-time
                description: The end date of the project.
                example: '2023-01-01T00:00:00Z'
              IsCurrent:
                type: boolean
                description: Indicates if the project is ongoing.
                example: true
        Games:
          type: array
          description: List of games the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the game.
                example: game_123
              Category:
                type: string
                description: The category of the game.
                example: Strategy
              Name:
                type: string
                description: The name of the game.
                example: Chess
              CreatedDate:
                type: string
                format: date-time
                description: The date the game was added.
                example: '2023-05-15T10:00:00Z'
        Family:
          type: array
          description: List of family members associated with the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the family member.
                example: family_123
              Relationship:
                type: string
                description: The relationship with the family member.
                example: Brother
              Name:
                type: string
                description: The name of the family member.
                example: John Doe
        TelevisionShow:
          type: array
          description: List of television shows the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the television show.
                example: tv_123
              Category:
                type: string
                description: The category of the television show.
                example: Drama
              Name:
                type: string
                description: The name of the television show.
                example: Breaking Bad
              CreatedDate:
                type: string
                format: date-time
                description: The date the television show was added.
                example: '2023-05-15T10:00:00Z'
        MutualFriends:
          type: array
          description: List of mutual friends associated with the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the mutual friend.
                example: friend_123
              Name:
                type: string
                description: The name of the mutual friend.
                example: Jane Doe
              FirstName:
                type: string
                description: The first name of the mutual friend.
                example: Jane
              LastName:
                type: string
                description: The last name of the mutual friend.
                example: Doe
              Birthday:
                type: string
                format: date
                description: The birthday of the mutual friend.
                example: '1990-05-15'
              Hometown:
                type: string
                description: The hometown of the mutual friend.
                example: Boston
              Link:
                type: string
                description: The profile link of the mutual friend.
                example: https://example.com/janedoe
              Gender:
                type: string
                description: The gender of the mutual friend.
                example: female
        Movies:
          type: array
          description: List of movies the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the movie.
                example: movie_123
              Category:
                type: string
                description: The category of the movie.
                example: Action
              Name:
                type: string
                description: The name of the movie.
                example: Inception
              CreatedDate:
                type: string
                format: date-time
                description: The date the movie was added.
                example: '2023-05-15T10:00:00Z'
        Books:
          type: array
          description: List of books the User is interested in.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the book.
                example: book_123
              Category:
                type: string
                description: The category of the book.
                example: Fiction
              Name:
                type: string
                description: The name of the book.
                example: The Great Gatsby
              CreatedDate:
                type: string
                format: date-time
                description: The date the book was added.
                example: '2023-05-15T10:00:00Z'
        Patents:
          type: array
          description: List of patents associated with the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the patent.
                example: patent_123
              Title:
                type: string
                description: The title of the patent.
                example: AI-Based Image Recognition
              Date:
                type: string
                format: date
                description: The date the patent was filed.
                example: '2023-05-15'
        FavoriteThings:
          type: array
          description: List of favorite things of the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the favorite thing.
                example: fav_123
              Name:
                type: string
                description: The name of the favorite thing.
                example: Photography
              Type:
                type: string
                description: The type of the favorite thing.
                example: Hobby
        RelatedProfileViews:
          type: array
          description: List of related profile views for the User.
          items:
            type: object
            properties:
              FirstName:
                type: string
                description: The first name of the related profile.
                example: John
              LastName:
                type: string
                description: The last name of the related profile.
                example: Doe
              Id:
                type: string
                description: The ID of the related profile.
                example: profile_123
        PlacesLived:
          type: array
          description: List of places the User has lived.
          items:
            type: object
            properties:
              IsPrimary:
                type: boolean
                description: Indicates if the place is the primary residence.
                example: true
              Name:
                type: string
                description: The name of the place.
                example: New York
              Operation:
                type: string
                description: The operation performed on the place.
                example: add
        Publications:
          type: array
          description: List of publications associated with the User.
          items:
            type: object
            properties:
              Id:
                type: string
                description: The ID of the publication.
                example: pub_123
              Title:
                type: string
                description: The title of the publication.
                example: AI Research Paper
              Publisher:
                type: string
                description: The publisher of the publication.
                example: Tech Journal
              Date:
                type: string
                format: date
                description: The date the publication was published.
                example: '2023-05-15'
              Url:
                type: string
                format: uri
                description: The URL of the publication.
                example: https://example.com/publication
              Summary:
                type: string
                description: A brief summary of the publication.
                example: This paper discusses AI advancements in image recognition.
              Authors:
                type: array
                description: List of authors of the publication.
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                      description: The ID of the author.
                      example: author_123
                    Name:
                      type: string
                      description: The name of the author.
                      example: John Doe
        JobBookmarks:
          type: array
          description: List of job bookmarks associated with the User.
          items:
            type: object
            properties:
              IsApplied:
                type: boolean
                description: Indicates if the job has been applied for.
                example: true
              IsSaved:
                type: boolean
                description: Indicates if the job has been saved.
                example: true
              ApplyTimestamp:
                type: string
                format: date-time
                description: The timestamp when the job was applied for.
                example: '2023-05-15T10:00:00Z'
              SavedTimestamp:
                type: string
                format: date-time
                description: The timestamp when the job was saved.
                example: '2023-05-10T10:00:00Z'
              Job:
                type: object
                description: Details of the job.
                properties:
                  Id:
                    type: string
                    description: The ID of the job.
                    example: job_123
                  Title:
                    type: string
                    description: The title of the job.
                    example: Software Engineer
                  Company:
                    type: string
                    description: The company offering the job.
                    example: Tech Corp
        Badges:
          type: array
          description: List of badges associated with the User.
          items:
            type: object
            properties:
              BadgeId:
                type: string
                description: The ID of the badge.
                example: badge_123
              Name:
                type: string
                description: The name of the badge.
                example: Top Contributor
              BadgeMessage:
                type: string
                description: A message associated with the badge.
                example: Awarded for outstanding contributions.
              Description:
                type: string
                description: A description of the badge.
                example: This badge is awarded to users who contribute significantly to the community.
              ImageUrl:
                type: string
                description: The URL of the badge image.
                example: https://example.com/badges/top-contributor.png
        MemberUrlResources:
          type: array
          description: List of member URL resources associated with the User.
          items:
            type: object
            properties:
              Url:
                type: string
                format: uri
                description: The URL of the resource.
                example: https://example.com/resource
              UrlName:
                type: string
                description: The name of the resource URL.
                example: Personal Website
        ExternalIds:
          type: array
          description: List of external IDs associated with the User.
          items:
            type: object
            properties:
              Operation:
                type: string
                description: The operation performed on the external ID.
                example: add
              Source:
                type: string
                description: The source of the external ID.
                example: LinkedIn
              SourceId:
                type: string
                description: The source ID of the external ID.
                example: source_12345
        IsEmailSubscribed:
          type: boolean
          nullable: true
          description: Indicates if the User is subscribed to emails.
          example: true
        IsProtected:
          type: boolean
          nullable: true
          description: Indicates if the User Account is protected.
          example: false
        Hireable:
          type: boolean
          nullable: true
          description: Indicates if the User is hireable.
          example: true
        IsTwoFactorAuthenticationEnabled:
          type: boolean
          nullable: true
          description: Indicates if two-factor authentication is enabled for the User.
          example: true
        IsActive:
          type: boolean
          nullable: true
          description: Indicates if the User Account is active.
          example: true
        IsDeleted:
          type: boolean
          nullable: true
          description: Indicates if the User Account is deleted.
          example: false
        EmailVerified:
          type: boolean
          nullable: true
          description: Indicates if the User's Email is verified.
          example: true
        PhoneIdVerified:
          type: boolean
          nullable: true
          description: Indicates if the User's Phone ID is verified.
          example: true
        DisableLogin:
          type: boolean
          nullable: true
          description: Indicates if login is disabled for the User.
          example: false
        IsLoginLocked:
          type: boolean
          nullable: true
          description: Indicates if the User's login is locked.
          example: false
        AcceptPrivacyPolicy:
          type: boolean
          nullable: true
          description: Indicates if the User has accepted the Privacy Policy.
          example: true
        ReCaptchaResponseField:
          type: string
          nullable: true
          description: The response field for reCAPTCHA verification.
          example: 03AGdBq24...
        ReCaptchaChallengeField:
          type: string
          nullable: true
          description: The challenge field for reCAPTCHA verification.
          example: 03AGdBq24...
        RegistrationSource:
          type: string
          nullable: true
          description: The source of the User's registration.
          example: Web
        FullName:
          type: string
          nullable: true
          description: The full name of the User.
          example: John Robert Smith
        Consents:
          type: object
          description: Consent registration details.
          properties:
            Events:
              type: array
              description: List of consent acceptance events.
              items:
                type: object
                properties:
                  IsCustom:
                    type: boolean
                    description: Indicates if the consent is custom.
                    example: true
                  Event:
                    type: string
                    description: The event associated with the Consent.
                    example: Signup
            Data:
              type: array
              description: List of consent options accepted by the User.
              items:
                type: object
                properties:
                  IsAccepted:
                    type: boolean
                    description: Indicates if the consent option is accepted.
                    example: true
                  ConsentOptionId:
                    type: string
                    description: The ID of the Consent option.
                    example: 123e4567e89b12d3a456426614174000
        Password:
          type: string
          description: The Password of the User.
          example: password123
        Email:
          type: array
          description: List of Email addresses associated with the User.
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of the Email (e.g., Primary, Secondary).
                example: Primary
              Value:
                type: string
                format: email
                description: The Email address.
                example: user@example.com
    IsDeletedResponseWithCount:
      type: object
      properties:
        IsDeleted:
          type: boolean
          description: Indicates whether the Account was successfully deleted.
          example: true
        RecordsDeleted:
          type: integer
          description: The number of records that were deleted.
          example: 5
    AccessToken:
      type: object
      properties:
        access_token:
          type: string
          description: The generated Access Token.
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
        refresh_token:
          type: string
          nullable: true
          description: The refresh token associated with the Access Token.
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
        expires_in:
          type: string
          format: date-time
          description: The expiration time of the Access Token.
          example: '2024-03-20T15:30:00Z'
        SessionToken:
          type: object
          description: Session token details.
          properties:
            session_token:
              type: string
              description: The session token for specific features.
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
            session_expires_in:
              type: string
              format: date-time
              description: The expiration time of the session token.
              example: '2024-03-20T16:30:00Z'
    UsernameModel:
      type: object
      properties:
        Username:
          type: string
          description: The Username to validate or process.
          example: john_doe
      required:
        - Username
    EmailToValidateServerSide:
      type: object
      properties:
        Email:
          type: string
          format: email
          description: The Email address to validate on the server side.
          example: user@example.com
      required:
        - Email
    ForgotPasswordTokenModel:
      type: object
      properties:
        ForgotToken:
          type: string
          description: The generated forgot Password token.
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
        IdentityProviders:
          type: array
          description: List of identity providers associated with the User.
          items:
            type: string
          example:
            - google
            - facebook
      required:
        - ForgotToken
        - IdentityProviders
    VerificationLinkResponse:
      type: object
      properties:
        VerificationToken:
          type: string
          description: The generated Verification Token.
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
        expires_in:
          type: string
          format: date-time
          description: The expiration time of the token.
          example: '2024-03-20T15:30:00Z'
    IdentitiesResponse:
      type: object
      properties:
        Data:
          type: array
          nullable: true
          description: List of User Identities with social information but without login details.
          items:
            $ref: '#/components/schemas/IdentityResponseWithSocialWithoutLogins'
    UpsertEmailModel:
      type: object
      properties:
        Email:
          type: array
          items:
            type: object
            properties:
              Type:
                type: string
                description: The type of Email (e.g., primary, secondary).
                example: primary
              Value:
                type: string
                format: email
                description: The Email address to be added or updated.
                example: user@example.com
          description: A list of Email addresses to be added or updated for the Account.
      required:
        - Email
    EmailModelManage:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The Email address to be processed.
          example: user@example.com
      required:
        - email
    PhoneModel:
      type: object
      properties:
        phone:
          type: string
          description: The Phone number to be updated.
          example: +1-555-123-4567
      required:
        - phone
    PasswordResponse:
      type: object
      properties:
        PasswordHash:
          type: string
          nullable: true
          description: The hashed Password of the User account.
          example: $2a$12$eImiTXuWVxfM37uY4JANjQ==
    PasswordModel:
      type: object
      properties:
        Password:
          type: string
          description: The new Password to be set for the Account.
          example: SecurePassword123!
      required:
        - Password
    EventBasedSecondFactorToken:
      type: object
      properties:
        secondfactorvalidationtoken:
          type: string
          description: |
            The event-based second factor token. This token is used to verify the identity of the User during the authentication process.
          format: string
          minLength: 36
          maxLength: 36
          example: 683987c4-9249-4165-b1f1-925f0b84021e
      required:
        - secondfactorvalidationtoken
    IsValid:
      type: object
      properties:
        IsValid:
          type: boolean
          description: |
            Indicates whether the provided event-based second factor token is valid or not. A value of `true` means the token is valid,
            while `false` indicates that the token is invalid or has expired.
          example: true
      required:
        - IsValid
    ErrorResponseNative:
      type: object
      properties:
        message:
          type: string
          description: Brief message describing the error.
        description:
          type: string
          description: Detailed description of the error.
        errorCode:
          type: integer
          description: Error code for identifying the error type.
    ActiveSessionResponse:
      type: object
      properties:
        nextCursor:
          type: integer
        data:
          type: array
          items:
            type: object
            properties:
              AccessToken:
                type: string
                example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
              Browser:
                type: string
                example: Chrome
              Device:
                type: string
                example: Laptop
              Os:
                type: string
                example: Windows 10
              DeviceType:
                type: string
                example: Desktop
              City:
                type: string
                example: San Francisco
              Country:
                type: string
                example: USA
              Ip:
                type: string
                example: 192.168.1.1
              LoginDate:
                type: string
                format: date-time
                example: '2023-06-01T12:34:56Z'
    Invitation:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier for the invitation. The ID is typically in the format *inv_<unique_id>*, where *<unique_id>* is a string of alphanumeric characters.
          example: inv_123456789
        EmailId:
          type: string
          description: The Email address of the User to whom the invitation is sent.
          example: user@example.com
        Status:
          type: string
          enum:
            - invited
            - accepted
            - expired
            - revoked
          description: The status of the invitation. Possible values are *invited*, *accepted*, *expired*, and *revoked*.
          example: invited
        RoleIds:
          type: array
          description: The list of Role IDs associated with the invitation. Each Role ID is typically in the format *role_<unique_id>*, where *<unique_id>* is a string of alphanumeric characters.
          items:
            type: string
          example:
            - role_12345
            - role_56789
        OrgId:
          type: string
          description: The unique identifier for the organization associated with the invitation. The ID is typically in the format *org_<unique_id>*, where *<unique_id>* is a string of alphanumeric characters.
          example: org_123456789
        CreatedDate:
          type: string
          description: The date and time when the invitation was created, UTC format.
          format: date-time
          example: '2023-01-01T00:00:00Z'
        ExpirationDate:
          type: string
          description: The date and time when the invitation expires, UTC format.
          format: date-time
          example: '2023-01-01T00:00:00Z'
        ModifiedDate:
          type: string
          description: The date and time when the invitation was last modified, UTC format.
          format: date-time
          example: '2023-01-01T00:00:00Z'
        InviterUid:
          type: string
          description: The unique identifier for the User who sent the invitation. The ID is typically in the format unique_id, where *<unique_id>* is a string of alphanumeric characters.
          example: '123456789'
    SendInvitation:
      type: object
      required:
        - email
        - roleIds
        - orgId
        - inviterUid
      properties:
        email:
          type: string
          format: email
        roleIds:
          type: array
          items:
            type: string
          example:
            - role_12345
            - role_56789
        orgId:
          type: string
        inviterUid:
          type: string
    ResendInvitation:
      type: object
      properties:
        Resent:
          type: boolean
          description: Indicates whether the invitation was resent
          example: true
    OrganizationDomainRequest:
      properties:
        DomainName:
          type: string
          example: example.com
          description: The domain name to be verified
        IsVerified:
          type: boolean
          example: false
          description: Indicates whether the domain has been verified
      type: object
    OrganizationBase:
      properties:
        Display:
          nullable: true
          properties:
            LogoURL:
              type: string
              example: https://example.com/logo.jpg
              description: URL to the organization's logo
            Name:
              type: string
              example: Org1
              description: Display name of the organization
          type: object
        Domains:
          items:
            $ref: '#/components/schemas/OrganizationDomainRequest'
          type: array
        Metadata:
          additionalProperties:
            type: string
          example:
            hello: world
          type: object
          description: Additional metadata for the organization
        Name:
          type: string
          example: Org1
          description: Name of the organization
      type: object
    ConnectionGroupRoleRequest:
      properties:
        GroupId:
          type: string
          example: eca8da89-09ed-476f-a689-11fa9a0b14ce
          description: Unique identifier of the group to which the Role belongs.
        Name:
          type: string
          example: Security
          description: Name of the group Role connection.
        RoleId:
          type: string
          example: role_Z6NE1ZkupP7lwD6E
          description: Unique identifier of the Role.
      type: object
    ConnectionGroupRoleResponse:
      allOf:
        - $ref: '#/components/schemas/ConnectionGroupRoleRequest'
        - properties:
            Id:
              type: string
              example: group_role_Z6NFN5kupP7lwD6G
              description: Unique identifier of the group-to-role mapping.
          type: object
    OrganizationsConnectionBase:
      properties:
        Name:
          type: string
          example: AzureAD
          description: Name of the connection
        Domain:
          type: string
          example: example.com
          description: Domain associated with the connection
        Attributes:
          properties:
            CustomMapping:
              additionalProperties:
                type: string
              type: object
              example:
                Gender: gender
              description: Custom attribute mapping for the connection
            Email:
              type: string
              example: email
              description: Email attribute for the connection
            FirstName:
              type: string
              example: firstName
              description: First name attribute for the connection
            Groups:
              type: string
              example: groups
              description: Groups attribute for the connection
            ID:
              type: string
              example: sub
              description: Unique identifier attribute for the connection
            LastName:
              type: string
              example: lastName
              description: Last name attribute for the connection
          type: object
      type: object
    OrganizationsConnectionSamlBase:
      properties:
        IDPEntityId:
          type: string
          example: https://exampleIdp.com
          description: Unique identifier for the Identity Provider (IdP).
        IDPMetadataUrl:
          type: string
          example: https://exampleIdp.com/metadata.xml
          description: URL to the IdP metadata XML file.
        IsIDPInitiated:
          type: boolean
          example: true
          description: Indicates whether the SAML connection is initiated by the IdP.
        IDPCertificate:
          nullable: true
          properties:
            Certificate:
              type: string
              description: The Identity Provider's certificate in PEM format.
              example: |
                -----BEGIN CERTIFICATE-----
                ...
                -----END CERTIFICATE-----
            NotAfter:
              format: date-time
              type: string
              example: '2023-10-01T00:00:00Z'
              description: The expiration date of the IdP certificate.
            NotBefore:
              format: date-time
              type: string
              example: '2023-10-01T00:00:00Z'
              description: The start date of the IdP certificate validity.
          type: object
      type: object
    SamlConnectionResponse:
      allOf:
        - $ref: '#/components/schemas/OrganizationsConnectionSamlBase'
        - type: object
          properties:
            ConnectionType:
              enum:
                - saml_custom
                - saml_okta
                - saml_entraid
                - saml_google_workspace
                - saml_salesforce
              type: string
              example: saml_custom
              description: The type of SAML connection.
            EntityId:
              type: string
              example: https://example.hub.loginradius.com/saml/sp/Z5ZtBULhXHAJKrLsOmeWbZh5dmjKYuVWTw
              description: The unique identifier for the SAML service provider.
            MetadataUrl:
              type: string
              example: https://example.hub.loginradius.com/saml/sp/Z5ZtBULhXHAJKrLsOmeWbZh5dmjKYuVWTw/metadata.xml
              description: The URL to the SAML metadata XML file.
            ACSEndpoint:
              type: string
              example: https://example.hub.loginradius.com/saml/sp/acs/Z5ZtBULhXHAJKrLsOmeWbZh5dmjKYuVWTw
              description: The Assertion Consumer Service (ACS) endpoint URL for SAML responses.
            SPCertificate:
              nullable: true
              properties:
                Certificate:
                  type: string
                  description: The SAML service provider's certificate in PEM format.
                  example: |
                    -----BEGIN CERTIFICATE-----
                    ...
                    -----END CERTIFICATE-----
              type: object
    OidcConnectionBase:
      properties:
        AuthorizationUrl:
          type: string
          example: https://exampleIdp.com/oidc/authorize
          description: The URL to the OpenID Connect provider's authorization endpoint. This is where users are redirected to authenticate and authorize access.
        ClientId:
          type: string
          example: '123456'
          description: The client identifier issued to the application by the OpenID Connect provider. This is used to identify the application during the authentication process.
        ClientSecret:
          type: string
          example: '654321'
          description: The client secret issued to the application by the OpenID Connect provider. This is used to authenticate the application when requesting tokens.
        Issuer:
          type: string
          example: https://exampleIdp.com
          description: The issuer identifier for the OpenID Connect provider. This is typically the base URL of the provider and is used to validate tokens.
        Scopes:
          items:
            type: string
          type: array
          description: The scopes requested by the application during the authentication process. Scopes define the access level and Permissions granted to the application.
          example:
            - openid
            - email
        TokenAuthMethod:
          type: string
          example: client_secret_post
          description: The method used to authenticate the application when requesting tokens. Common methods include `client_secret_post` and `client_secret_basic`.
        TokenUrl:
          type: string
          example: https://exampleIdp.com/oidc/token
          description: The URL to the OpenID Connect provider's token endpoint. This is where the application exchanges the authorization code for tokens.
        UserInfoUrl:
          type: string
          example: https://exampleIdp.com/oidc/userinfo
          description: The URL to the OpenID Connect provider's UserInfo endpoint.
        UserInfoExtractByIdToken:
          type: boolean
          nullable: true
          description: Indicates if user info should be extracted by ID token.
        JWKSEndpoint:
          type: string
          example: https://exampleIdp.com/oidc/jwks
          description: The JWKS endpoint for verifying the ID token.
      type: object
    OidcConnectionResponse:
      allOf:
        - $ref: '#/components/schemas/OidcConnectionBase'
        - type: object
          properties:
            ConnectionType:
              enum:
                - oidc_custom
              example: oidc_custom
              type: string
              description: Type of the connection, which is OIDC in this case.
            RedirectURI:
              type: string
              example: https://example.hub.loginradius.com/oauth/sp/Z5ZtBULhXHAJKrLsOmeWbZh5dmjKYuVWTw/callback
              description: The redirect URI for the OIDC connection, where the authorization server will send the User after authentication.
    ConnectionResponse:
      allOf:
        - properties:
            Id:
              type: string
              example: conn_Z5ZtmHl2aMpi5VZP
              description: Unique identifier for the connection
            IsActive:
              type: boolean
              example: true
              description: Indicates whether the connection is active
            CreatedDate:
              format: date-time
              type: string
              example: '2023-10-01T00:00:00Z'
              description: Date when the connection was created
            GroupRoles:
              nullable: true
              items:
                $ref: '#/components/schemas/ConnectionGroupRoleResponse'
              type: array
            ModifiedDate:
              format: date-time
              type: string
              example: '2023-10-01T00:00:00Z'
              description: Date when the connection was last modified
          type: object
        - $ref: '#/components/schemas/OrganizationsConnectionBase'
        - oneOf:
            - $ref: '#/components/schemas/SamlConnectionResponse'
            - $ref: '#/components/schemas/OidcConnectionResponse'
    OrganizationsDomainsResponse:
      allOf:
        - $ref: '#/components/schemas/OrganizationDomainRequest'
        - type: object
          properties:
            Id:
              type: string
              example: org_domain_Z5Zviy2xEEUTal7S
              description: Unique identifier for the organization domain.
            VerificationStrategy:
              type: string
              example: manual
              description: Strategy used for domain verification, e.g., 'manual'.
            VerificationToken:
              type: string
              example: '123456'
              description: Token used for domain verification.
    OrganizationsPolicyBase:
      properties:
        JITPolicy:
          nullable: true
          properties:
            Enabled:
              nullable: true
              type: boolean
              example: false
              description: Indicates if JIT provisioning is enabled
          type: object
          description: Just-In-Time (JIT) provisioning policy for the organization
        MFAPolicy:
          nullable: true
          properties:
            EnforcementMode:
              type: string
              example: optional
              description: Mode of enforcement for Multi-Factor Authentication (MFA)
          type: object
          description: Multi-Factor Authentication (MFA) policy for the organization
        MemberPolicy:
          nullable: true
          properties:
            DefaultMemberRole:
              type: string
              example: role_Z5OCrdbNBZ8OzruS
              description: Default Role assigned to new members in the organization
          type: object
          description: Member policy for the organization
        PasswordPolicy:
          nullable: true
          properties:
            ExpiryDays:
              type: integer
              example: 100
              description: Number of days after which the Password expires
            MaxLength:
              type: integer
              example: 25
              description: Maximum length of the Password
            MinLength:
              type: integer
              example: 8
              description: Minimum length of the Password
            RequireLowercase:
              type: boolean
              description: Indicates if at least one lowercase letter is required in the Password
            RequireNumber:
              type: boolean
              description: Indicates if at least one number is required in the Password
            RequireSpecialChar:
              type: boolean
              description: Indicates if at least one special character is required in the Password
            RequireUppercase:
              type: boolean
              description: Indicates if at least one uppercase letter is required in the Password
          type: object
          description: Password policy for the organization
        SessionPolicy:
          nullable: true
          properties:
            AccessTokenTTL:
              type: integer
              example: 14400
              description: Time-to-live (TTL) for Access Tokens in seconds
            RefreshTokenTTL:
              type: integer
              example: 324345
              description: Time-to-live (TTL) for refresh tokens in seconds
          type: object
          description: Session policy for the organization
      type: object
    OrganizationsResponse:
      allOf:
        - $ref: '#/components/schemas/OrganizationBase'
        - type: object
          properties:
            Connections:
              nullable: true
              items:
                $ref: '#/components/schemas/ConnectionResponse'
              type: array
              description: List of connections associated with the organization
            CreatedDate:
              format: date-time
              type: string
              example: '2023-10-01T00:00:00Z'
              description: Date when the organization was created
            Domains:
              nullable: true
              items:
                $ref: '#/components/schemas/OrganizationsDomainsResponse'
              type: array
              example:
                - domain: example.com
                  isDefault: true
              description: List of domains associated with the organization
            Id:
              type: string
              example: org_Z5ZtBULhXHAJKrLs
              description: Unique identifier for the organization
            IsActive:
              type: boolean
              example: true
              description: Indicates whether the organization is active
            ModifiedDate:
              format: date-time
              type: string
              example: '2023-10-01T00:00:00Z'
              description: Date when the organization was last modified
            Policies:
              $ref: '#/components/schemas/OrganizationsPolicyBase'
    OrganizationUpdateRequest:
      properties:
        Name:
          type: string
          example: Org1
          description: Name of the organization
        Display:
          nullable: true
          properties:
            LogoURL:
              type: string
              example: https://example.com/logo.jpg
              description: URL to the organization's logo
            Name:
              type: string
              example: Org1
              description: Display name of the organization
          type: object
        Metadata:
          additionalProperties:
            type: string
          example:
            hello: world
          type: object
          description: Additional metadata for the organization
        Domains:
          items:
            $ref: '#/components/schemas/OrganizationDomainRequest'
          type: array
        IsAuthRestrictedToDomain:
          nullable: true
          type: boolean
          description: Restricts authentication to registered domains only
        Policies:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/OrganizationsPolicyBase'
        IsActive:
          nullable: true
          type: boolean
          description: Indicates whether the organization is active or not
      type: object
    SamlConnectionRequest:
      allOf:
        - $ref: '#/components/schemas/OrganizationsConnectionBase'
        - type: object
          properties:
            ConnectionType:
              description: Type of the connection, which is SAML in this case.
              enum:
                - saml_custom
                - saml_okta
                - saml_entraid
                - saml_google_workspace
                - saml_salesforce
              type: string
        - $ref: '#/components/schemas/OrganizationsConnectionSamlBase'
        - type: object
          properties:
            ConnectionType:
              description: Type of connection, which is SAML in this case.
              enum:
                - saml_custom
                - saml_okta
                - saml_entraid
                - saml_google_workspace
                - saml_salesforce
              type: string
            IDPCertificate:
              type: string
              nullable: false
              example: |
                -----BEGIN CERTIFICATE-----
                ...
                -----END CERTIFICATE-----
    OidcConnectionRequest:
      allOf:
        - type: object
          properties:
            ConnectionType:
              enum:
                - oidc_custom
              type: string
        - $ref: '#/components/schemas/OidcConnectionBase'
    OrganizationConnectionRequest:
      allOf:
        - $ref: '#/components/schemas/OrganizationsConnectionBase'
        - oneOf:
            - $ref: '#/components/schemas/SamlConnectionRequest'
            - $ref: '#/components/schemas/OidcConnectionRequest'
    ConnectionStatusRequest:
      properties:
        Active:
          type: boolean
          description: Indicates whether the connection is active.
      type: object
    ConnectionStatusResponse:
      properties:
        IsActive:
          type: boolean
          description: Indicates whether the connection is active.
      type: object
    Permissions:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier for the Permission
          example: perm_2enk23n3
        Name:
          type: string
          description: The name of the Permission
          example: read:users
        Description:
          type: string
          description: The description of the Permission
          example: Read users data
        ResourceId:
          type: string
          description: The identifier of the Auth Server API resource this permission belongs to. Only present if the permission is associated with a resource.
          example: 507f1f77bcf86cd799439011
        CreatedDate:
          type: string
          format: date-time
          description: The date the Permission was created
          example: '2025-02-18T12:18:38.270Z'
        ModifiedDate:
          type: string
          format: date-time
          description: The date the Permission was last modified
          example: '2025-02-18T12:19:12.255Z'
    PermissionsPostRequest:
      type: object
      required:
        - Name
      properties:
        Name:
          type: string
          description: The name of the Permission
          example: read:users
        Description:
          type: string
          description: The description of the Permission
          example: Read users data
        ResourceId:
          type: string
          description: The hex ID of the Auth Server API resource to associate this permission with.
          example: 507f1f77bcf86cd799439011
    PermissionPutRequest:
      type: object
      required:
        - Name
        - Description
      properties:
        Name:
          type: string
          description: The name of the Permission. For non-B2B apps, the name cannot be modified and must match the existing permission name.
          example: read:users
        Description:
          type: string
          description: The description of the Permission
          example: Read users data
    Permission:
      type: object
      properties:
        ID:
          type: string
          description: Permission ID
          example: perm_2enk23n3
        Name:
          type: string
          description: Permission Name
          example: read:users
        Description:
          type: string
          description: Permission Description
          example: Read users data
        OriginalName:
          type: string
          description: Original (unnormalized) Permission Name
          example: read:users
        ResourceId:
          type: string
          description: The identifier of the Auth Server API resource this permission belongs to. Only present if the permission is associated with a resource.
          example: 507f1f77bcf86cd799439011
    TenantRole:
      type: object
      properties:
        Id:
          type: string
          description: Role ID
          example: role_dsag432d
        Name:
          type: string
          description: Role Name
          example: Admin
        Description:
          type: string
          description: Role Description
          example: Admin Role
        Level:
          type: string
          description: Role Level
          example: tenant
        OrgId:
          type: string
          description: Organization ID
          example: ''
        Permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
        CreatedDate:
          type: string
          format: date-time
          description: Role Created Date
          example: '2023-10-01T00:00:00Z'
        ModifiedDate:
          type: string
          format: date-time
          description: Role Modified Date
          example: '2023-10-01T00:00:00Z'
    RolePostRequest:
      type: object
      required:
        - Name
      properties:
        Name:
          type: string
          description: Role Name
          example: Admin
        Description:
          type: string
          description: Role Description
          example: Admin Role
        Permissions:
          type: array
          items:
            type: string
            description: A Permission granted to the Role, e.g., 'perm_23hi32n', 'perm_238snu2'.
            example: perm_23hi32n
    Role:
      type: object
      properties:
        Id:
          type: string
          description: Role ID
          example: role_dsag432d
        Name:
          type: string
          description: Role Name
          example: Admin
        Description:
          type: string
          description: Role Description
          example: Admin Role
        Level:
          type: string
          description: Role Level
          example: org
        OrgId:
          type: string
          description: Organization ID
          example: org_fasf432d
        OriginalName:
          type: string
          description: Original (unnormalized) Role Name
          example: Admin
        Permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
        CreatedDate:
          type: string
          format: date-time
          description: Role Created Date
          example: '2023-10-01T00:00:00Z'
        ModifiedDate:
          type: string
          format: date-time
          description: Role Modified Date
          example: '2023-10-01T00:00:00Z'
    RolesPutRequest:
      type: object
      required:
        - Name
        - Description
        - Permissions
      properties:
        Name:
          type: string
          description: Role Name
          example: Admin
        Description:
          type: string
          description: Role Description
          example: Admin Role
        Permissions:
          type: array
          items:
            type: string
            description: A Permission granted to the Role, e.g., 'perm_23hi32n', 'perm_238snu2'.
            example: perm_23hi32n
    DefaultResponse:
      type: object
      properties:
        IsDefault:
          type: boolean
          description: Indicates if the Role is set as default
    UserRole:
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the User Role.
          example: user_role_ru43jd3
        Uid:
          type: string
          description: Unique identifier of the User.
          example: '123456789'
        RoleId:
          type: string
          description: Unique identifier of the Role.
          example: Role_dsag432d
        OrgId:
          type: string
          description: Unique identifier of the organization.
          example: org_fasf432d
        Email:
          type: string
          format: email
          description: Email address of the User.
          example: defaultuser@email.com
        CreatedDate:
          type: string
          format: date-time
          description: Date and time when the User Role was created.
          example: '2023-10-01T00:00:00Z'
    UserRolePutRequest:
      type: object
      required:
        - RoleIds
      properties:
        RoleIds:
          type: array
          items:
            type: string
          description: Unique identifier of the Role.
          example:
            - role_dsag432d
            - role_abc123
    Technology:
      type: string
      description: The technologies provided by LR
      enum:
        - android
        - ios
        - phonegap
        - ionic
        - xamarin
        - reactnative
      example: android
    SottList:
      type: object
      properties:
        AuthenticityToken:
          type: string
          description: The authenticity token
          example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
        Technology:
          $ref: '#/components/schemas/Technology'
        CreatedDate:
          type: string
          format: date-time
          description: The date the SOTT was created
          example: '2023-10-01T12:00:00Z'
        DateRange:
          type: string
          description: The date range for the SOTT
          example: '10'
        IsEncoded:
          type: boolean
          description: Indicates if the SOTT is encoded
          example: true
        Comment:
          type: string
          description: Additional comments
          example: This is a test comment
    SottGenerate:
      type: object
      properties:
        ExpiresInMinutes:
          type: integer
          format: int32
          description: The number of minutes until the SOTT expires.
          example: 30
        Encoded:
          type: boolean
          description: Indicates whether the SOTT should be encoded.
          example: true
        Comment:
          type: string
          description: A comment associated with the SOTT.
          example: This is a test comment.
      required:
        - ExpiresInMinutes
    SottGenerateTechnology:
      type: object
      allOf:
        - $ref: '#/components/schemas/SottGenerate'
        - type: object
          properties:
            Technology:
              $ref: '#/components/schemas/Technology'
          required:
            - Technology
    SottResponse:
      type: object
      properties:
        AuthenticityToken:
          type: string
          description: The authenticity token
        Technology:
          $ref: '#/components/schemas/Technology'
        Sott:
          type: string
          description: The SOTT (Secure One Time Token)
        Comment:
          type: string
          description: Additional comments
        CreatedDate:
          type: string
          format: date-time
          description: The date the SOTT was created
        DateRange:
          type: string
          description: The date range for the SOTT
        IsEncoded:
          type: boolean
          description: Indicates if the SOTT is encoded
    WorkflowConfigWithoutData:
      type: object
      properties:
        Id:
          type: string
          example: '12345'
        Name:
          type: string
          example: Profile Theme Alpha
        ThemeName:
          type: string
          example: DarkMode
        Description:
          type: string
          example: A modern dark theme for User profiles
        State:
          type: string
          example: active
    AddWorkflowConfig:
      type: object
      required:
        - Name
        - Data
      properties:
        Name:
          type: string
        ThemeName:
          type: string
        Description:
          type: string
        Data:
          type: object
        State:
          type: string
          enum:
            - ACTIVE
            - DEBUG
            - ARCHIVE
    WorkflowConfig:
      type: object
      properties:
        Id:
          type: string
        WorkflowName:
          type: string
        ThemeName:
          type: string
        Description:
          type: string
        Data:
          type: object
        State:
          type: string
    UpdateWorkflowConfig:
      type: object
      properties:
        Name:
          type: string
        ThemeName:
          type: string
        Description:
          type: string
        Data:
          type: object
        State:
          type: string
          enum:
            - ACTIVE
            - DEBUG
            - ARCHIVE
    VersionListResponse:
      type: object
      properties:
        Data:
          type: array
          items:
            type: object
            properties:
              versionId:
                type: string
                description: The version ID of the workflow.
                example: v1.0.0
              createdDate:
                type: string
                format: date-time
                description: The creation date of the workflow version.
                example: '2024-06-17T12:34:56Z'
    WorkflowData:
      type: object
      properties:
        tree:
          type: object
          properties:
            entryNodeId:
              type: string
              description: The entry node ID of the tree.
              example: start
            nodes:
              type: object
              additionalProperties:
                type: object
                properties:
                  id:
                    type: string
                    example: node1
                  type:
                    type: string
                    example: decision
                  connections:
                    type: array
                    items:
                      type: object
                      additionalProperties:
                        type: string
        nodes:
          type: object
          additionalProperties:
            type: object
            properties:
              id:
                type: string
                example: node1
              type:
                type: string
                example: action
              nodes:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      example: child1
                    UID:
                      type: string
                      example: UID123
                    type:
                      type: string
                      example: child
                    childType:
                      type: string
                      example: form
                    data:
                      type: object
                    formnodeprops:
                      type: object
                      nullable: true
                      properties:
                        choiceFieldType:
                          type: string
                          example: single
                        choices:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                example: option1
                              text:
                                type: string
                                example: Option 1
                        attributeMapping:
                          type: string
                          example: attr1
                        defaultChoice:
                          type: string
                          example: option1
              output:
                type: array
                items:
                  type: object
              data:
                type: object
              selected:
                type: boolean
                example: false
        innerNodes:
          type: object
          additionalProperties:
            type: object
            properties:
              id:
                type: string
                example: inner1
              UID:
                type: string
                example: UID456
              type:
                type: string
                example: inner
              childType:
                type: string
                example: form
              data:
                type: object
              formnodeprops:
                type: object
                nullable: true
                properties:
                  choiceFieldType:
                    type: string
                    example: multiple
                  choices:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          example: option2
                        text:
                          type: string
                          example: Option 2
                  attributeMapping:
                    type: string
                    example: attr2
                  defaultChoice:
                    type: string
                    example: option2
        policies:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
        versionId:
          type: string
          description: The version ID of the workflow.
          example: v1.0.0
        createdDate:
          type: string
          format: date-time
          description: The creation date of the workflow version.
          example: '2024-06-17T12:34:56Z'
        description:
          type: string
          description: Description of the workflow version.
          example: Initial version of the workflow
    BasicAuthWebhook:
      type: object
      properties:
        Username:
          type: string
          description: The Username for basic authentication
          example: admin
        Password:
          type: string
          nullable: true
          description: The Password for basic authentication
          example: password123
    Bearertoken:
      type: object
      properties:
        Token:
          type: string
          nullable: true
          description: The bearer token for authentication
          example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    WebhookAuthentication:
      type: object
      properties:
        AuthType:
          type: string
          description: The type of authentication used for the webhook
          enum:
            - Basic
            - Bearer
          example: Basic
        BasicAuth:
          $ref: '#/components/schemas/BasicAuthWebhook'
        BearerToken:
          $ref: '#/components/schemas/Bearertoken'
    WebhookSubscription:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier for the webhook subscription
          example: wh_001
        TargetUrl:
          type: string
          description: The target URL for the webhook
          example: https://example.com/webhook
        Event:
          type: string
          description: The event that triggers the webhook
          example: Login
        CreatedDate:
          type: string
          format: date-time
          description: The date when the webhook subscription was created
          example: '2025-04-08T12:00:00Z'
        LastModifiedDate:
          type: string
          format: date-time
          description: The date when the webhook subscription was last modified
          example: '2025-04-08T12:30:00Z'
        SecretName:
          type: string
          description: The name of the secret used for the webhook
          example: webhook-secret
        Name:
          type: string
          description: The name of the webhook subscription
          example: TestSecret
        IsIntegrationWebhook:
          type: boolean
          description: Indicates if the webhook is an integration webhook
          example: true
        Headers:
          type: object
          additionalProperties:
            type: string
          description: The headers to be included in the webhook request
          example:
            X-Custom-Header: CustomValue
            Authorization: Bearer abc123
        QueryParams:
          type: object
          additionalProperties:
            type: string
          description: The query parameters to be included in the webhook request
          example:
            token: xyz987
            mode: sync
        Authentication:
          $ref: '#/components/schemas/WebhookAuthentication'
    WebhookSubscriptionResponse:
      type: object
      properties:
        Data:
          type: array
          items:
            $ref: '#/components/schemas/WebhookSubscription'
    WebhookSubscriptionCreateModel:
      type: object
      properties:
        Event:
          type: string
          description: The event that triggers the webhook
          enum:
            - Login
            - Register
            - UpdateProfile
            - ResetPassword
            - ChangePassword
            - EmailVerification
            - AddEmail
            - RemoveEmail
            - BlockAccount
            - DeleteAccount
            - SetUsername
            - AssignRoles
            - UnassignRoles
            - SetPassword
            - LinkAccount
            - UnlinkAccount
            - UpdatePhoneId
            - VerifyPhoneNumber
            - InvalidateEmailVerification
            - RemoveRoleContext
            - CreateCustomObject
            - UpdateCustomObject
            - DeleteCustomObject
            - InvalidatePhoneVerification
            - RemovePhoneId
            - ConsentProfileUpdate
            - SetPIN
            - ResetPIN
            - ChangePIN
            - UpdateUid
        TargetUrl:
          type: string
          description: The target URL for the webhook
        Name:
          type: string
          description: The name of the webhook subscription
        SecretName:
          type: string
          description: The name of the secret used for the webhook
        CustomObjects:
          type: string
          description: Custom Objects associated with the webhook
        Headers:
          type: object
          additionalProperties:
            type: string
          description: The headers to be included in the webhook request
        QueryParams:
          type: object
          additionalProperties:
            type: string
          description: The query parameters to be included in the webhook request
        Authentication:
          $ref: '#/components/schemas/WebhookAuthentication'
      required:
        - Event
        - TargetUrl
    WebhookSubscriptionUpdateModel:
      type: object
      properties:
        TargetUrl:
          type: string
          description: The target URL for the webhook
        Name:
          type: string
          nullable: true
          description: The name of the webhook subscription
        SecretName:
          type: string
          description: The name of the secret used for the webhook
        CustomObjects:
          type: string
          description: Custom Objects associated with the webhook
        Headers:
          type: object
          additionalProperties:
            type: string
          description: The headers to be included in the webhook request
        QueryParams:
          type: object
          additionalProperties:
            type: string
          description: The query parameters to be included in the webhook request
        Authentication:
          $ref: '#/components/schemas/WebhookAuthentication'
      required:
        - TargetUrl
    WebhookEvents:
      type: string
      enum:
        - Login
        - Register
        - UpdateProfile
        - ResetPassword
        - ChangePassword
        - EmailVerification
        - AddEmail
        - RemoveEmail
        - BlockAccount
        - DeleteAccount
        - SetUsername
        - AssignRoles
        - UnassignRoles
        - SetPassword
        - LinkAccount
        - UnlinkAccount
        - UpdatePhoneId
        - VerifyPhoneNumber
        - InvalidateEmailVerification
        - RemoveRoleContext
        - CreateCustomObject
        - UpdateCustomObject
        - DeleteCustomObject
        - InvalidatePhoneVerification
        - RemovePhoneId
        - ConsentProfileUpdate
        - SetPIN
        - ResetPIN
        - ChangePIN
        - UpdateUid
        - OrgCreated
        - OrgUpdated
        - OrgDeleted
        - OrgRoleCreated
        - OrgRoleUpdated
        - OrgRoleDeleted
        - OrgConnectionCreated
        - OrgConnectionUpdated
        - OrgConnectionDeleted
        - OrgMembershipCreated
        - OrgMembershipUpdated
        - OrgMembershipDeleted
        - OrgInvitationCreated
    SmsTemplate:
      type: object
      required:
        - SmsTemplateType
        - Name
        - Template
      properties:
        SmsTemplateType:
          type: string
          description: The type of the SMS template.
          enum:
            - verification
            - forgotpassword
            - welcome
            - changephoneno
            - onetimepasscode
            - secondfactorauthentication
            - noregistrationpasswordlesslogin
            - resetpassword
            - suspicious_ip_sms_to_user
            - suspicious_city_sms_to_user
            - suspicious_country_sms_to_user
            - suspicious_browser_sms_to_user
            - suspicious_device_sms_to_user
            - forgotpin
            - deleteuser
            - breached_password
          example: verification
        Name:
          type: string
          description: The name of the SMS template.
          example: Welcome Message
        Template:
          type: string
          description: The content of the SMS template.
          example: Welcome to our service, {{username}}!
    UpdateSmsTemplateModel:
      type: object
      properties:
        Name:
          type: string
          description: The name of the SMS template.
          example: Updated Message
        Template:
          type: string
          description: The updated template content.
          example: Hello, {{username}}! We're glad to have you.
        IsActive:
          type: boolean
          description: Indicates if the template is active.
          example: true
    DeleteSmsTemplateModel:
      type: object
      required:
        - Name
      properties:
        Name:
          type: string
          description: The name of the SMS template to delete.
          example: Welcome Message
    PassKeyConfig:
      type: object
      properties:
        IsEnabled:
          type: boolean
          description: Whether PassKey is enabled.
          example: true
        PasskeySelection:
          type: string
          enum:
            - AutoFill
            - Button
            - Both
          description: The type of PassKey selection.
          example: Both
        ProgressiveEnrollment:
          type: boolean
          description: Whether progressive enrollment is enabled.
          example: true
        ProgressiveEnrollmentDelay:
          type: integer
          description: Delay in minutes for progressive enrollment.
          example: 5
        LocalEnrollment:
          type: boolean
          description: Whether local enrollment is enabled.
          example: true
        RPDisplayName:
          type: string
          description: Display name for the relying party.
          example: Acme Corporation
        RPID:
          type: string
          description: ID for the relying party.
          example: acme.com
        RPOrigins:
          type: array
          items:
            type: string
          description: List of allowed origins for the relying party.
          example:
            - https://login.acme.com
            - https://auth.acme.com
        Attestation:
          type: string
          enum:
            - none
            - indirect
            - direct
          description: The type of PassKey Attestation flow.
          example: indirect
      required:
        - IsEnabled
        - PasskeySelection
        - LocalEnrollment
        - RPDisplayName
        - RPID
        - RPOrigins
    AWSPushConfig:
      type: object
      properties:
        AccessKeyId:
          type: string
          description: AWS access key ID.
          example: AKIAIOSFODNN7EXAMPLE
        SecretAccessKey:
          type: string
          description: AWS secret access key.
          example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
        Region:
          type: string
          description: AWS region.
          example: us-west-2
    AndroidPushConfig:
      type: object
      properties:
        Enabled:
          type: boolean
          description: Indicates if Android Push Notifications are enabled.
          example: true
        PlatformARN:
          type: string
          description: The platform ARN for Android Push Notifications.
          example: arn:aws:sns:us-east-1:123456789012:app/GCM/MyApp
        PlaystoreUrl:
          type: string
          description: The URL to the app in the Google Play Store.
          example: https://play.google.com/store/apps/details?id=com.example.app
        ServiceJson:
          type: string
          description: JSON string for Android Push Notification service.
          example: '{}'
    IOSPushConfig:
      type: object
      properties:
        Enabled:
          type: boolean
          description: Indicates if iOS Push Notifications are enabled.
          example: true
        AppstoreUrl:
          type: string
          description: The URL to the app in the Apple App Store.
          example: https://apps.apple.com/app/id123456789
        PlatformARN:
          type: string
          description: The platform ARN for iOS Push Notifications.
          example: arn:aws:sns:us-east-1:123456789012:app/APNS/myapp
        BundleId:
          type: string
          description: The bundle ID of the iOS app.
          example: com.example.myapp
        ApnsCertificate:
          type: string
          description: The APNs certificate.
          example: |
            -----BEGIN CERTIFICATE-----
            MIID...
            -----END CERTIFICATE-----
        Environment:
          type: string
          enum:
            - Sandbox
            - Production
          description: The environment for APNs (e.g., sandbox, production).
          example: Sandbox
    PushAuthenticator:
      type: object
      properties:
        IsEnabled:
          type: boolean
          description: Indicates if push authentication is enabled.
        NotificationService:
          type: string
          enum:
            - AWS
            - Native
          description: The type of notification service (e.g., AWS, Native).
        CustomAppName:
          type: string
          description: Custom application name if applicable.
        QRCodeWidth:
          type: integer
          description: The width of the QR code for push authentication.
        Message:
          type: string
          description: Custom message for Push Notifications.
        AWSsettings:
          $ref: '#/components/schemas/AWSPushConfig'
        AndroidSettings:
          $ref: '#/components/schemas/AndroidPushConfig'
        IOSsettings:
          $ref: '#/components/schemas/IOSPushConfig'
    SecurityQuestion:
      type: object
      properties:
        QuestionId:
          type: string
          description: Unique identifier of the security question.
          example: 1234567890abcdef1234567890abcdef
        Question:
          type: string
          description: The security question text.
          example: What is your mother's maiden name?
    SecurityQuestionInput:
      type: object
      properties:
        question:
          type: string
          description: The security question text.
          example: What is your favorite color?
      required:
        - question
    SecurityQuestionsRender:
      type: object
      properties:
        RenderQuestionCount:
          type: integer
          minimum: 1
          maximum: 10
          description: The number of security questions to render.
      required:
        - RenderQuestionCount
    DomainAccessRestrictions:
      type: object
      properties:
        Allowlist:
          type: array
          items:
            type: string
          description: List of allowed domains/emails
        Blocklist:
          type: array
          items:
            type: string
          description: List of blocked domains/emails
      example:
        Allowlist:
          - email@example.com
          - example.org
        Blocklist:
          - email@spam.com
          - malware.org
    EmailTemplateResponse:
      type: object
      properties:
        TemplateType:
          type: string
          description: The type of the Email template
          example: welcome
        TemplateName:
          type: string
          description: The name of the Email template
          example: Welcome Email
        Template:
          type: string
          example: Welcome to our service! We are glad to have you.
        Subject:
          type: string
          description: The subject of the Email template
          example: Welcome to our service!
        IsActive:
          type: boolean
          description: Indicates if the Email template is active
          example: true
        TextTemplate:
          type: string
          description: The text version of the Email template
          example: Welcome to our service! We are glad to have you.
        FromName:
          type: string
          description: The name of the sender
          example: Support Team
        FromEmail:
          type: string
          description: The Email address of the sender
          example: test@gmail.com
        EmailConfigId:
          type: string
          description: Email configuration ID for sending this template.
          example: 123e4567-e89b-12d3-a456-426614174000
        VerificationTokenType:
          type: string
          description: The Email Verification token type for the template.
          enum:
            - MagicLink
            - Otp
          example: Otp
    EmailTemplateModel:
      type: object
      properties:
        TemplateType:
          type: string
          description: The type of the Email template
          enum:
            - registration
            - forgotpassword
            - forgotprovider
            - deleteaccount
            - add_email
            - welcome
            - oneclicksignin
            - autologin
            - noregistrationpasswordlesslogin
            - resetpassword
            - suspicious_ip_email_to_user
            - suspicious_city_email_to_user
            - suspicious_country_email_to_user
            - suspicious_browser_email_to_user
            - risk_identified_to_admin
            - forgotpin
            - secondfactorauthentication
            - invite_user_to_organization
            - suspicious_device_email_to_user
            - breached_password
            - admin_notification_breached_password
            - add_passkey
            - delete_passkey
            - forget_passkey
        TemplateName:
          type: string
          description: The name of the Email template
        Template:
          type: string
          description: The content of the Email template
        Subject:
          type: string
          description: The subject of the Email template
        TextTemplate:
          type: string
          description: The text version of the Email template
        FromName:
          type: string
          description: The name of the sender
        FromEmail:
          type: string
          description: The Email address of the sender
        EmailConfigId:
          type: string
          description: Email configuration ID for sending this template.
        VerificationTokenType:
          type: string
          enum:
            - MagicLink
            - Otp
          description: |
            The Email Verification token type for the template.  This will be set only for 'registration','forgotpassword','deleteaccount','add_email','oneclicksignin', 'autologin','noregistrationpasswordlesslogin','forgotpin','breached_password' and 'forget_passkey' templates.
      required:
        - TemplateType
        - Template
        - Subject
    UpdateEmailTemplate:
      type: object
      properties:
        TemplateName:
          type: string
          description: The name of the Email template
        Template:
          type: string
          description: The content of the Email template
        Subject:
          type: string
          description: The subject of the Email template
        TextTemplate:
          type: string
          description: The text version of the Email template
        FromName:
          type: string
          description: The name of the sender
        FromEmail:
          type: string
          description: The Email address of the sender
        EmailConfigId:
          type: string
          description: Email configuration ID for sending this template.
        VerificationTokenType:
          type: string
          enum:
            - MagicLink
            - Otp
          description: |
            The Email Verification token type for the template.  This will be set only for 'registration','forgotpassword','deleteaccount','add_email','oneclicksignin', 'autologin','noregistrationpasswordlesslogin','forgotpin','breached_password' and 'forget_passkey' templates.
      required:
        - Template
        - Subject
    DeleteEmailTemplate:
      type: object
      properties:
        TemplateName:
          type: string
          description: The name of the template
      required:
        - TemplateName
    AppleSecretConfiguration:
      type: object
      properties:
        Certificate:
          type: string
          description: Certificate for Apple configuration
          example: |
            -----BEGIN CERTIFICATE-----
            MIIDXTCCAkWgAwIBAgIJAL5v1Z3k5Y2mMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV
            ...
            -----END CERTIFICATE-----
        KeyIdentifier:
          type: string
          description: Key identifier for Apple configuration
          example: ABCDEFGHIJ
        ServiceId:
          type: string
          description: Service ID for Apple configuration
          example: com.example.app
        BundleId:
          type: string
          description: Bundle ID for Apple configuration
          example: com.example.app
        TeamId:
          type: string
          description: Team ID for Apple configuration
          example: ABCDEFGHIJ
    ProviderConfigOptions:
      type: object
      properties:
        Provider:
          type: string
          description: The name of the provider.
          example: FACEBOOK
        Key:
          type: string
          description: The key for the provider.
          example: exampleKey
        Secret:
          type: string
          description: The secret for the provider.
          example: exampleSecret
        ExtraField1:
          type: string
          description: An extra field for additional information.
          example: exampleId
          nullable: true
        ExtraField2:
          type: string
          description: Another extra field for additional information.
          nullable: true
          example: example.html
        IsActive:
          type: boolean
          description: The status of the provider.
          example: true
        AppleSecretConfiguration:
          $ref: '#/components/schemas/AppleSecretConfiguration'
      example:
        Provider: ExampleProvider
        Key: exampleKey
        Secret: exampleSecret
        ExtraField1: exampleId
        ExtraField2: example.html
        IsActive: true
        AppleSecretConfiguration:
          Certificate: Certificate
          KeyIdentifier: KeyIdentifier
          ServiceId: ServiceId
          BundleId: BundleId
          TeamId: TeamId
    ProviderStatusModel:
      type: object
      properties:
        ProviderName:
          type: string
          description: Name of the provider
          example: FACEBOOK
        IsActive:
          type: boolean
          description: Status of the provider
          example: true
      required:
        - ProviderName
        - IsActive
      example:
        ProviderName: ExampleProvider
        IsActive: true
    ProviderStatusList:
      type: object
      properties:
        Data:
          type: array
          items:
            $ref: '#/components/schemas/ProviderStatusModel'
          description: List of provider statuses
      example:
        Data:
          - ProviderName: ExampleProvider1
            IsActive: true
          - ProviderName: ExampleProvider2
            IsActive: false
    Provider:
      type: object
      properties:
        ProviderName:
          type: string
          description: Name of the provider
          example: ExampleProvider
        IsActive:
          type: boolean
          description: Status of the provider
          example: true
      example:
        ProviderName: ExampleProvider
        IsActive: true
    AppProvider:
      type: object
      properties:
        IsActive:
          type: boolean
          description: Indicates whether the provider is active.
          example: true
        Key:
          type: string
          description: The key for the provider application.
          example: exampleKey
        Secret:
          type: string
          description: The secret for the provider application.
          example: exampleSecret
        ExtraField1:
          type: string
          description: An extra field for additional configuration.
          example: extraValue1
        ExtraField2:
          type: string
          description: Another extra field for additional configuration.
          example: extraValue2
        AppleSecretConfiguration:
          $ref: '#/components/schemas/AppleSecretConfiguration'
    MFASettings:
      type: object
      properties:
        IsSecondFactorAuthenticatorEnabled:
          type: boolean
          description: Indicates if the second factor authenticator is enabled
        IsRequired:
          type: boolean
          description: Indicates if MFA is required
        IsAuthenticatorEnabled:
          type: boolean
          description: Indicates if TOTP Authenticator is enabled
        IsEmailOtpAuthenticatorEnabled:
          type: boolean
          description: Indicates if Email OTP Authenticator is enabled
        IsSmsOtpAuthenticatorEnabled:
          type: boolean
          description: Indicates if SMS OTP Authenticator is enabled
        IsSecurityQuestionAsMFAEnabled:
          type: boolean
          description: Indicates if Security Question as MFA is enabled
        MinimumSecurityQuestionsToAsk:
          type: integer
          description: Minimum number of security questions to ask
        IsPushAuthenticatorEnabled:
          type: boolean
          description: Indicates if Push Authenticator is enabled
        IsDuoAuthenticatorEnabled:
          type: boolean
          description: Indicates if Duo Authenticator is enabled
        IsPasskeyMFAEnabled:
          type: boolean
          description: Indicates if Passkey MFA is enabled
    GoogleAuthenticator:
      type: object
      properties:
        IsEnabled:
          type: boolean
          description: Indicates if TOTP Authenticator is enabled
        QRCodeWidth:
          type: integer
          description: Width of the QR code
          minimum: 1
          maximum: 400
        IssuerId:
          type: string
          description: Issuer ID for TOTP Authenticator
        AccountSecretKey:
          type: string
          description: Account secret key for TOTP Authenticator
      required:
        - IssuerId
    DuoSecurityAuthenticator:
      type: object
      properties:
        IsEnabled:
          type: boolean
          description: Indicates if Duo Security is enabled
        ClientId:
          type: string
          description: The client ID for Duo Security
        ClientSecret:
          type: string
          description: The client secret for Duo Security
        APIHost:
          type: string
          description: The API host for Duo Security
    CaptchaKeys:
      type: object
      properties:
        PublicKey:
          type: string
          nullable: true
          example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
        PrivateKey:
          type: string
          nullable: true
          example: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
    GoogleRecaptchaV3:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaKeys'
        - type: object
          properties:
            Threshold:
              type: number
              format: float
              nullable: true
              example: 0.5
    HCaptcha:
      type: object
      allOf:
        - $ref: '#/components/schemas/CaptchaKeys'
        - type: object
          properties:
            Threshold:
              type: number
              format: float
              nullable: true
              example: 0.5
            IsInvisibleCaptcha:
              type: boolean
              example: true
            IsDarkTheme:
              type: boolean
              example: false
    CaptchaConfig:
      type: object
      properties:
        IsEnabled:
          type: boolean
          nullable: true
        QQTencentCaptcha:
          $ref: '#/components/schemas/CaptchaKeys'
        GoogleRecaptchaV2:
          $ref: '#/components/schemas/CaptchaKeys'
        GoogleRecaptchaV3:
          $ref: '#/components/schemas/GoogleRecaptchaV3'
        HCaptcha:
          $ref: '#/components/schemas/HCaptcha'
        EnabledCaptcha:
          type: string
          nullable: true
          description: |
            The enabled captcha type. Must pass the EnabledCaptchaValidation.
    IPAccessRestrictions:
      type: object
      properties:
        AllowedIPs:
          type: array
          items:
            type: string
          description: List of allowed IP addresses
        DeniedIPs:
          type: array
          items:
            type: string
          description: List of blocked IP addresses
    JwtClientIdpBaseModel:
      properties:
        Algo:
          enum:
            - HS256
            - HS384
            - HS512
            - RS256
            - RS384
            - RS512
            - ES256
            - ES384
            - ES512
          type: string
          example: HS256
        Secret:
          type: string
          example: f5d70720-1a95-4cff-a2c5-5fd25e115aab
        MappingTemplate:
          type: string
          example: '{"email": "{{Email.0.Value}}"}'
        Mapping:
          additionalProperties:
            type: string
          type: object
        Metadata:
          additionalProperties:
            type: string
          type: object
        Audience:
          items:
            type: string
          type: array
          example:
            - aud1
            - aud2
        NotAfterDifference:
          type: integer
          example: 900
        NotBeforeDifference:
          type: integer
          example: 0
        QueryStringParameter:
          type: string
          example: id_token
        ResponseMode:
          enum:
            - query
            - fragment
            - form_post
          type: string
          example: query
        LoginUrl:
          type: string
          example: https://example.com
      type: object
      example:
        Algo: HS256
        Audience:
          - aud1
          - aud2
        LoginUrl: https://example.com
        Mapping:
          email: Email[0].Value
          uid: Uid
        Metadata:
          orgId: '123456'
        NotAfterDifference: 900
        NotBeforeDifference: 0
        QueryStringParameter: id_token
        ResponseMode: query
        Secret: f5d70720-1a95-4cff-a2c5-5fd25e115aab
    JwtClientIdpResponse:
      allOf:
        - $ref: '#/components/schemas/JwtClientIdpBaseModel'
        - type: object
          properties:
            AppName:
              type: string
              example: jwtapp
          example:
            AppName: jwtapp
    JwtClientIdpRequest:
      allOf:
        - $ref: '#/components/schemas/JwtClientIdpBaseModel'
        - type: object
          properties:
            AppName:
              type: string
          example:
            AppName: jwtapp
    JwtIssuerValidation:
      type: object
      properties:
        ExpectedValue:
          type: string
          example: issuer
        MatchValue:
          type: boolean
          example: true
        IsMandatory:
          type: boolean
          example: true
    JwtValidation:
      type: object
      properties:
        IsMandatory:
          type: boolean
          example: true
    JwtAudienceValidation:
      type: object
      properties:
        ExpectedValues:
          type: array
          items:
            type: string
          example:
            - aud1
            - aud2
        MatchValue:
          type: boolean
          example: true
        IsMandatory:
          type: boolean
          example: true
    JwtSpConfig:
      type: object
      properties:
        Id:
          type: string
          format: objectId
          example: 507f1f77bcf86cd799439011
        IsActive:
          type: boolean
          example: true
        AppId:
          type: integer
          example: 123
        AppName:
          type: string
          example: MyApp
        Algo:
          type: string
          example: HS256
        Mapping:
          type: object
          additionalProperties:
            type: string
          example:
            key1: value1
            key2: value2
        Key:
          type: string
          nullable: true
          example: my-secret-key
        TokenQueryParameterName:
          type: string
          example: token
        ClockSkew:
          type: integer
          example: 300
        LoginUrl:
          type: string
          example: https://example.com/login
        Issuer:
          $ref: '#/components/schemas/JwtIssuerValidation'
        Subject:
          $ref: '#/components/schemas/JwtValidation'
        Audience:
          $ref: '#/components/schemas/JwtAudienceValidation'
        ExpirationTimeDifference:
          type: integer
          example: 3600
        UseAuthorizationHeader:
          type: boolean
          example: true
        NotBefore:
          $ref: '#/components/schemas/JwtValidation'
        Expiration:
          $ref: '#/components/schemas/JwtValidation'
        JWKSUrl:
          type: string
          nullable: true
          example: https://example.com/.well-known/jwks.json
        UpdateEmailProfile:
          type: boolean
          example: true
        RaasUpdateFields:
          type: array
          items:
            type: string
          example:
            - field1
            - field2
        Domain:
          type: string
          nullable: true
          example: example.com
        EnableAutoLookUp:
          type: boolean
          nullable: true
          example: true
        Version:
          type: string
          nullable: true
          example: v1
        ListInInterface:
          type: boolean
          example: true
        CreatedDate:
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        LastModifiedDate:
          type: string
          format: date-time
          example: '2023-01-02T00:00:00Z'
    JwtClaimSubjectProperty:
      type: object
      properties:
        ExpectedValue:
          type: string
          nullable: true
          example: expected-value
        MatchValue:
          type: boolean
          nullable: true
          example: true
        IsMandatory:
          type: boolean
          nullable: true
          example: true
    JwtClaimMandatory:
      type: object
      properties:
        IsMandatory:
          type: boolean
          nullable: true
          example: true
    JwtClaimAudienceProperty:
      type: object
      properties:
        ExpectedValues:
          type: array
          items:
            type: string
          example:
            - aud1
            - aud2
        MatchValue:
          type: boolean
          nullable: true
          example: true
        IsMandatory:
          type: boolean
          nullable: true
          example: true
    JwtSpConfigBaseModel:
      type: object
      properties:
        Algo:
          type: string
          nullable: true
          example: HS256
        Mapping:
          type: object
          additionalProperties:
            type: string
          example:
            key1: value1
            key2: value2
        Key:
          type: string
          nullable: true
          example: my-secret-key
        TokenQueryParameterName:
          type: string
          nullable: true
          example: token
        ClockSkew:
          type: integer
          nullable: true
          example: 300
        LoginUrl:
          type: string
          nullable: true
          example: https://example.com/login
        Issuer:
          $ref: '#/components/schemas/JwtClaimSubjectProperty'
        Subject:
          $ref: '#/components/schemas/JwtClaimMandatory'
        Audience:
          $ref: '#/components/schemas/JwtClaimAudienceProperty'
        ExpirationTimeDifference:
          type: integer
          nullable: true
          example: 3600
        UseAuthorizationHeader:
          type: boolean
          nullable: true
          example: true
        NotBefore:
          $ref: '#/components/schemas/JwtClaimMandatory'
        Expiration:
          $ref: '#/components/schemas/JwtClaimMandatory'
        JWKSUrl:
          type: string
          nullable: true
          example: https://example.com/.well-known/jwks.json
        UpdateEmailProfile:
          type: boolean
          nullable: true
          example: true
        RaasUpdateFields:
          type: array
          items:
            type: string
          example:
            - field1
            - field2
        Domain:
          type: string
          nullable: true
          example: example.com
        EnableAutoLookUp:
          type: boolean
          nullable: true
          example: true
        ListInInterface:
          type: boolean
          nullable: true
          example: true
    SamlClientIdpResponse:
      properties:
        AfterLogoutUrl:
          type: string
          example: https://example.com/logout
        AppName:
          type: string
          example: ExampleApp
        ArtifactReceiver:
          type: string
          example: https://example.com/artifact-receiver
        AssertionConsumerService:
          properties:
            Binding:
              enum:
                - urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
                - urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
              type: string
              example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
            Location:
              type: string
              example: https://example.com/acs
          type: object
        Attributes:
          additionalProperties:
            properties:
              AlternativeMappingKey:
                type: string
                example: exampleKey
              Format:
                type: string
                example: urn:oasis:names:tc:SAML:2.0:nameid-format:transient
              IsStatic:
                type: boolean
              Value:
                type: string
                example: exampleValue
            type: object
          type: object
        Audiences:
          items:
            type: string
          type: array
          example:
            - https://example.com/audience1
            - https://example.com/audience2
        DefaultRequestBinding:
          type: string
          example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
        IdpCertificate:
          properties:
            Certificate:
              type: string
              example: MIIC...example...certificate
            Key:
              type: string
              example: MIIC...example...key
          type: object
        IsIdpInitiated:
          type: boolean
          example: true
        IssuerUrl:
          type: string
          example: https://example.com/issuer
        LoginUrl:
          type: string
          example: https://example.com/login
        NameIdFormat:
          type: string
          example: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
        NotOnOrAfter:
          type: integer
          example: 1609459200
        RelayStateParameter:
          type: string
          example: exampleRelayState
        SamlVersion:
          type: string
          example: '2.0'
        SpCertificate:
          properties:
            Certificate:
              type: string
              example: MIIC...example...spcertificate
          type: object
        SpLogoutUrl:
          type: string
          example: https://example.com/sp-logout
        IsPrebuiltIntegration:
          type: boolean
          example: true
        ReplyUrl:
          type: string
          example: https://example.com/reply
        IntegrationType:
          type: string
          example: exampleType
        IntegrationConfigs:
          type: object
          properties:
            IdpSHA1Fingerprint:
              type: string
              example: exampleFingerprint
            AccountName:
              type: string
              example: exampleAccount
      type: object
      example:
        AfterLogoutUrl: https://example.com/logout
        AppName: ExampleApp
        ArtifactReceiver: https://example.com/artifact-receiver
        AssertionConsumerService:
          Binding: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
          Location: https://example.com/acs
        Attributes:
          additionalProperties:
            AlternativeMappingKey: exampleKey
            Format: urn:oasis:names:tc:SAML:2.0:nameid-format:transient
            IsStatic: true
            Value: exampleValue
        Audiences:
          - https://example.com/audience1
          - https://example.com/audience2
        DefaultRequestBinding: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
        IdpCertificate:
          Certificate: MIIC...example...certificate
          Key: MIIC...example...key
        IsIdpInitiated: true
        IssuerUrl: https://example.com/issuer
        LoginUrl: https://example.com/login
        NameIdFormat: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
        NotOnOrAfter: 1609459200
        RelayStateParameter: exampleRelayState
        SamlVersion: '2.0'
        SpCertificate:
          Certificate: MIIC...example...spcertificate
        SpLogoutUrl: https://example.com/sp-logout
        IsPrebuiltIntegration: true
        ReplyUrl: https://example.com/reply
        IntegrationType: exampleType
        IntegrationConfigs:
          IdpSHA1Fingerprint: exampleFingerprint
          AccountName: exampleAccount
    Certificates:
      type: object
      properties:
        Certificate:
          type: string
          nullable: true
          example: certificate
        Key:
          type: string
          nullable: true
          example: key
    SamlClientIdpRequest:
      properties:
        AfterLogoutUrl:
          type: string
        AssertionConsumerService:
          properties:
            Binding:
              enum:
                - urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
                - urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
              type: string
              example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
            Location:
              type: string
              example: https://example.com/acs
          type: object
        Attributes:
          additionalProperties:
            properties:
              AlternativeMappingKey:
                type: string
                example: exampleKey
              Format:
                type: string
                example: urn:oasis:names:tc:SAML:2.0:nameid-format:transient
              IsStatic:
                type: boolean
              Value:
                type: string
                example: exampleValue
            type: object
          type: object
        Audiences:
          items:
            type: string
          type: array
        DefaultRequestBinding:
          enum:
            - urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
            - urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
          type: string
        IsIdpInitiated:
          type: boolean
        IssuerUrl:
          type: string
        LoginUrl:
          type: string
        NameIdFormat:
          enum:
            - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
            - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
            - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
            - urn:oasis:names:tc:SAML:2.0:nameid-format:transient
          type: string
        NotOnOrAfter:
          type: integer
        RelayStateParameter:
          type: string
        SpCertificate:
          $ref: '#/components/schemas/Certificates'
        SpLogoutUrl:
          type: string
      type: object
    CertificateWithoutKey:
      type: object
      properties:
        Certificate:
          type: string
          nullable: true
          example: certificate
    IdentityProvider:
      type: object
      properties:
        Binding:
          type: string
          nullable: true
          example: binding
        Location:
          type: string
          nullable: true
          example: location
        LogOut:
          type: string
          nullable: true
          example: logout
    SamlSpConfig:
      type: object
      properties:
        Id:
          type: string
          format: objectId
          example: 507f1f77bcf86cd799439011
        IsActive:
          type: boolean
          example: true
        IsDeleted:
          type: boolean
          example: false
        IsIdpInitiated:
          type: boolean
          example: true
        DataMap:
          type: object
          additionalProperties:
            type: string
          example:
            key1: value1
            key2: value2
        AppId:
          type: string
          format: objectId
          example: 507f1f77bcf86cd799439011
        AppID:
          type: integer
          example: 123
        RelayStateParameter:
          type: string
          example: relayState
        Provider:
          type: string
          example: providerName
        FriendlyProviderName:
          type: string
          example: Friendly Provider
        DefaultLogoutUrl:
          type: string
          example: https://example.com/logout
        ServiceProviderACSUrl:
          type: string
          example: https://example.com/acs
        SamlServiceProvider:
          type: string
          nullable: true
          example: SAML Service Provider
        IdpCertificate:
          $ref: '#/components/schemas/Certificates'
        SpCertificate:
          $ref: '#/components/schemas/CertificateWithoutKey'
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        EnableAutoLookUp:
          type: boolean
          nullable: true
          example: true
        Domain:
          type: string
          nullable: true
          example: example.com
        ListInInterface:
          type: boolean
          example: true
        CreatedDate:
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        LastModifiedDate:
          type: string
          format: date-time
          example: '2023-01-02T00:00:00Z'
    SamlSpConfigModel:
      type: object
      properties:
        Provider:
          type: string
          example: providerName
        IsIdpInitiated:
          type: boolean
          nullable: true
          example: true
        DataMap:
          type: object
          additionalProperties:
            type: string
          example:
            key1: value1
            key2: value2
        RelayStateParameter:
          type: string
          nullable: true
          example: relayState
        FriendlyProviderName:
          type: string
          nullable: true
          example: Friendly Provider
        IdpCertificate:
          $ref: '#/components/schemas/Certificates'
        IdentityProvider:
          $ref: '#/components/schemas/IdentityProvider'
        EnableAutoLookUp:
          type: boolean
          nullable: true
          example: true
        Domain:
          type: string
          nullable: true
          example: example.com
        ListInInterface:
          type: boolean
          nullable: true
          example: true
        SamlServiceProvider:
          type: string
          nullable: true
          example: SAML Service Provider
      required:
        - Provider
        - DataMap
    SamlKeys:
      type: array
      items:
        type: string
      example:
        - ID
        - Provider
        - FirstName
        - MiddleName
        - LastName
        - FullName
        - NickName
        - ProfileName
        - Gender
        - Website
        - Email
        - Country
        - ThumbnailImageUrl
        - Favicon
        - ProfileUrl
        - HomeTown
        - State
        - Industry
        - About
        - LocalLanguage
        - TagLine
        - Language
        - Verified
        - UpdatedTime
        - MainAddress
        - Created
        - LocalCity
        - ProfileCity
        - LocalCountry
        - ProfileCountry
        - RelationshipStatus
        - Quote
        - Religion
        - Age
        - Uid
        - IsEmailSubscribed
        - NoOfLogins
        - BirthDate
        - ImageUrl
        - City
        - TimeZone
        - CoverPhoto
        - Company
        - PhoneId
    RaasCustomField:
      type: object
      properties:
        Key:
          type: string
          nullable: true
          description: The key of the custom field.
          example: custom_field_1
        Display:
          type: string
          nullable: true
          description: The display name of the custom field.
          example: Custom Field 1
    RaasOptions:
      type: object
      properties:
        Value:
          type: string
          nullable: true
          description: The value of the option.
          example: option1
        Text:
          type: string
          nullable: true
          description: The text of the option.
          example: Option 1
    RaasConfigData:
      type: object
      properties:
        Type:
          type: string
          description: The type of the configuration.
          example: text
          enum:
            - text
            - html
            - password
            - hidden
            - option
            - multi
            - email
            - string
        Name:
          type: string
          description: The name of the configuration.
          example: Configuration Name
        Display:
          type: string
          description: The display name of the configuration.
          example: Display Name
        Rules:
          type: string
          description: The rules associated with the configuration.
          example: Rules for the configuration
        Options:
          type: array
          items:
            $ref: '#/components/schemas/RaasOptions'
          description: A list of options for the configuration.
        Permission:
          type: string
          description: The permission required for the configuration.
          example: Permission Name
        Checked:
          type: boolean
          description: Indicates whether the configuration is checked.
          example: true
        Parent:
          type: string
          description: The parent field
          example: Address
      required:
        - Type
        - Name
        - Permission
    RaasConfig:
      type: object
      properties:
        Type:
          type: string
          nullable: true
          description: The type of the configuration.
          example: email
        Name:
          type: string
          nullable: true
          description: The name of the configuration.
          example: Email Id
        Display:
          type: string
          nullable: true
          description: The display name of the configuration.
          example: Email ID
        Rules:
          type: string
          nullable: true
          description: The rules associated with the configuration.
          example: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
        Permission:
          type: string
          nullable: true
          description: The permission level required for the configuration.
          example: r
        Options:
          type: array
          items:
            $ref: '#/components/schemas/RaasOptions'
          description: The options available for the configuration.
        Checked:
          type: boolean
          nullable: true
          description: Indicates if the configuration is checked.
          example: true
      required:
        - Type
        - Name
        - permission
    RaasCustomFieldModel:
      type: object
      properties:
        CustomField:
          type: string
          description: Name of the field you want to add as a custom field in the configuration.
          maxLength: 60
      required:
        - CustomField
    CustomFieldLimitResponse:
      type: object
      properties:
        CustomFieldLimit:
          type: integer
          description: The limit for custom fields.
    OAuthClientResponse:
      properties:
        AllowedCorsOrigin:
          items:
            type: string
          type: array
          example:
            - https://example.com
        AllowedScopes:
          items:
            type: string
          type: array
          example:
            - openid
            - profile
            - email
        AllowedWebOrigin:
          items:
            type: string
          type: array
          example:
            - https://example.com
        AppId:
          type: number
          example: 123456
        AppName:
          type: string
          example: MyApp
        ApplicationType:
          type: string
          example: Web
        AudienceScopes:
          additionalProperties:
            items:
              type: string
            type: array
            example:
              - openid
              - profile
              - email
          type: object
        BackChannelLogout:
          nullable: true
          properties:
            IsEnabled:
              type: boolean
              example: true
            LogoutInitiator:
              properties:
                Mode:
                  type: string
                  example: RPInitiated
                Intiators:
                  type: object
                  properties:
                    RPLogout:
                      type: boolean
                    IDPLogout:
                      type: boolean
                    PasswordChange:
                      type: boolean
                    AccountDelete:
                      type: boolean
              type: object
            LogoutTokenTTL:
              type: integer
              example: 3600
            LogoutURIs:
              items:
                type: string
              type: array
              example:
                - https://example.com/logout
          type: object
        ClientId:
          format: uuid
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
        ClientSecret:
          type: string
          example: exampleSecret
        Connections:
          type: object
          properties:
            Enabled:
              type: boolean
              example: true
            PasswordlessLogin:
              type: object
              properties:
                Enabled:
                  type: boolean
                Email:
                  type: boolean
                SMS:
                  type: boolean
            TraditionalLogin:
              type: boolean
            SocialLogins:
              type: array
              items:
                type: object
                properties:
                  IsEnabled:
                    type: boolean
                  ProviderName:
                    type: string
                    example: Google
            CustomIdp:
              type: array
              items:
                type: object
                properties:
                  IsEnabled:
                    type: boolean
                  ProviderName:
                    type: string
                    example: Google
            Enterprise:
              type: array
              items:
                type: object
                properties:
                  IsEnabled:
                    type: boolean
                  ProviderName:
                    type: string
                    example: Google
        CreatedDate:
          format: date-time
          type: string
          example: '2023-10-01T12:00:00Z'
        DeviceCodeConfig:
          nullable: true
          properties:
            AfterVerificationUrl:
              type: string
              example: https://example.com/after-verification
            DeviceCodeExpire:
              type: integer
              example: 300
            PollingInterval:
              type: integer
              example: 5
            UserCodeCharacterSet:
              enum:
                - Base20
                - Alpha
                - Digits
                - Alphanumeric
              type: string
              example: Base20
            UserCodeMask:
              type: string
              example: '6'
            VerificationUrl:
              type: string
              example: https://example.com/verification
          type: object
        EnableCorsOrigin:
          type: boolean
          example: true
        ForceReAuthentication:
          type: boolean
          example: true
        GlobalClient:
          type: boolean
          example: true
        GrantTypes:
          items:
            type: string
          type: array
          example:
            - authorization_code
            - client_credentials
        IdTokenAudiences:
          items:
            type: string
          example:
            - example-audience
          type: array
        JwtTokenConfig:
          nullable: true
          properties:
            Algorithm:
              type: string
              example: RS256
            IdTokenTTL:
              type: integer
              example: 3600
            TokenTTL:
              type: integer
              example: 3600
          type: object
        LastModifiedDate:
          format: date-time
          nullable: true
          type: string
          example: '2023-10-01T12:00:00Z'
        LoginUrl:
          nullable: true
          type: string
          example: https://example.com/login
        LoginRedirectUri:
          items:
            type: string
          type: array
          example:
            - https://example.com/login
        LogoutRedirectUri:
          items:
            type: string
          type: array
          example:
            - https://example.com/logout
        AccessTokenMappingTemplate:
          type: string
          example: '{"email": "{{Email.0.Value}}"}'
        IdTokenMappingTemplate:
          type: string
          example: '{"email": "{{Email.0.Value}}"}'
        Mapping:
          additionalProperties:
            type: string
          type: object
        Metadata:
          additionalProperties:
            type: string
            example: exampleValue
          type: object
          example:
            key1: value1
            key2: value2
        Protocol:
          type: string
          example: OAuth2
        RedirectURIExactMatch:
          type: boolean
          example: true
        RefreshTokenTTL:
          type: integer
          example: 3600
        Secret:
          type: string
          example: exampleSecret
        SignedUserInfo:
          type: boolean
        TokenAuthMethod:
          type: string
          example: client_secret_basic
        TokenWebOriginMatch:
          type: boolean
          example: true
      type: object
    OAuthClientRequest:
      properties:
        AllowedCorsOrigin:
          items:
            type: string
          type: array
        AllowedScopes:
          items:
            type: string
            enum:
              - email
              - phone
              - profile
              - address
          type: array
        ApplicationType:
          enum:
            - web
            - native
            - spa
            - service
          type: string
        AudienceScopes:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
        BackChannelLogout:
          nullable: true
          properties:
            IsEnabled:
              type: boolean
            LogoutTokenTTL:
              type: integer
              example: 3600
            LogoutURIs:
              items:
                type: string
              type: array
              example:
                - https://example.com/logout
          type: object
        Connections:
          type: object
          properties:
            Enabled:
              type: boolean
            PasswordlessLogin:
              type: object
              properties:
                Enabled:
                  type: boolean
                Email:
                  type: boolean
                SMS:
                  type: boolean
            TraditionalLogin:
              type: boolean
            SocialLogins:
              type: array
              items:
                type: object
                properties:
                  IsEnabled:
                    type: boolean
                  ProviderName:
                    type: string
                    example: Google
            CustomIdp:
              type: array
              items:
                type: object
                properties:
                  IsEnabled:
                    type: boolean
                  ProviderName:
                    type: string
                    example: SAML
            Enterprise:
              type: array
              items:
                type: object
                properties:
                  IsEnabled:
                    type: boolean
                  ProviderName:
                    type: string
                    example: SAML
        DeviceCodeConfig:
          nullable: true
          properties:
            AfterVerificationUrl:
              type: string
              example: https://example.com/after-verification
            DeviceCodeExpire:
              type: integer
              example: 300
            PollingInterval:
              type: integer
              example: 5
            UserCodeCharacterSet:
              enum:
                - Base20
                - Alpha
                - Digits
                - Alphanumeric
              type: string
              example: Base20
            UserCodeMask:
              type: string
              example: XXXX-XXXX
            VerificationUrl:
              type: string
              example: https://example.com/verification
          type: object
        EnableCorsOrigin:
          type: boolean
        ForceReAuthentication:
          type: boolean
        GrantTypes:
          items:
            type: string
            enum:
              - authorization_code
              - implicit
              - password
              - client_credentials
              - refresh_token
              - urn:ietf:params:oauth:grant-type:device_code
              - http://loginradius.com/oauth/grant-type/exchange_token
          type: array
        IdTokenAudiences:
          items:
            type: string
          type: array
        JwtTokenConfig:
          nullable: true
          properties:
            IdTokenTTL:
              type: integer
              example: 3600
            TokenTTL:
              type: integer
              example: 3600
          type: object
        LoginUrl:
          nullable: true
          type: string
        LoginRedirectUri:
          items:
            type: string
          type: array
        LogoutRedirectUri:
          items:
            type: string
          type: array
        AccessTokenMappingTemplate:
          type: string
          example: '{"email": "{{Email.0.Value}}"}'
        IdTokenMappingTemplate:
          type: string
          example: '{"email": "{{Email.0.Value}}"}'
        Mapping:
          additionalProperties:
            type: string
          type: object
        Metadata:
          additionalProperties:
            type: string
          type: object
        Protocol:
          type: string
          enum:
            - OAuth 2.0
            - OpenID Connect 1.0
        RedirectURIExactMatch:
          type: boolean
        RefreshTokenTTL:
          nullable: true
          type: integer
        SessionTokenTTL:
          type: integer
          nullable: true
        Secret:
          type: string
        SignedUserInfo:
          type: boolean
        TokenAuthMethod:
          enum:
            - client_secret_basic
            - client_secret_post
            - client_secret_auto
            - none
          type: string
      type: object
    OAuthClientSecretResetResponse:
      properties:
        ClientId:
          format: uuid
          type: string
        ClientSecret:
          type: string
      type: object
    OAuth2Provider:
      type: object
      properties:
        IsActive:
          type: boolean
          example: true
          description: Indicates if the OAuth2 provider is active.
        CreatedAt:
          type: string
          format: date-time
          example: '2023-10-01T12:00:00Z'
          description: The date and time when the OAuth2 provider was created.
        LastModified:
          type: string
          format: date-time
          example: '2023-10-01T12:00:00Z'
          description: The date and time when the OAuth2 provider was last modified.
        QueryParam:
          type: object
          additionalProperties:
            type: string
            example: exampleValue
          description: The query parameters for the OAuth2 provider.
        Headers:
          type: object
          additionalProperties:
            type: string
          description: The headers for the OAuth2 provider.
          example:
            Authorization: Bearer token
        DataMap:
          type: object
          additionalProperties:
            type: string
          description: The data map for the OAuth2 provider.
        ProviderName:
          type: string
          description: The name of the OAuth2 provider.
          example: ExampleProvider
        ApplicationID:
          type: string
          description: The application ID for the OAuth2 provider.
          example: '1234567890'
        ApplicationKey:
          type: string
          description: The application key for the OAuth2 provider.
          example: abcdefghijklmnop
        ApplicationSecret:
          type: string
          description: The application secret for the OAuth2 provider.
          example: secret123
        Scope:
          type: string
          description: The scope for the OAuth2 provider.
          example: read write
        ResponseType:
          type: string
          description: The response type for the OAuth2 provider.
          example: code
        UserLoginEndpoint:
          type: string
          description: The User login endpoint for the OAuth2 provider.
          example: https://example.com/oauth2/login
        ExtraParameterInRedirectToProvider:
          type: string
          description: Extra parameters in redirect to provider.
          example: extra_param=value
        AccessTokenEndpoint:
          type: string
          description: The Access Token endpoint for the OAuth2 provider.
          example: https://example.com/oauth2/token
        RequestTokenHttpMethod:
          type: string
          description: The HTTP method for requesting tokens.
          example: POST
        AccessTokenParameterNameForApiAccess:
          type: string
          description: The Access Token parameter name for API access.
          example: access_token
        UserprofileEndpoint:
          type: string
          description: The User profile endpoint for the OAuth2 provider.
          example: https://example.com/oauth2/userinfo
        Domain:
          type: string
          description: The domain for the OAuth2 provider.
          example: example.com
        EnableAutoLookUp:
          type: boolean
          nullable: true
          description: Indicates if auto lookup is enabled.
          example: true
        ListInInterface:
          type: boolean
          description: Indicates if the provider should be listed in the interface.
          example: true
    CustomOAuth2UpdateModel:
      type: object
      properties:
        ProviderName:
          type: string
          description: The name of the OAuth2 provider.
        ExtraParameterInRedirectToProvider:
          type: string
          description: Extra parameters in redirect to provider.
        EnableAutoLookUp:
          type: boolean
          nullable: true
          description: Indicates if auto lookup is enabled.
        Domain:
          type: string
          description: The domain for the OAuth2 provider.
        UserLoginEndpoint:
          type: string
          description: The User login endpoint for the OAuth2 provider.
        AccessTokenEndpoint:
          type: string
          description: The Access Token endpoint for the OAuth2 provider.
        ApplicationKey:
          type: string
          description: The application key for the OAuth2 provider.
        ApplicationSecret:
          type: string
          description: The application secret for the OAuth2 provider.
        ApplicationID:
          type: string
          description: The application ID for the OAuth2 provider.
        Scope:
          type: string
          description: The scope for the OAuth2 provider.
        ResponseType:
          type: string
          description: The response type for the OAuth2 provider.
        UserprofileEndpoint:
          type: string
          description: The User profile endpoint for the OAuth2 provider.
        DataMap:
          type: object
          additionalProperties:
            type: string
          description: The data map for the OAuth2 provider.
        AccessTokenParameterNameForApiAccess:
          type: string
          description: The Access Token parameter name for API access.
        RequestTokenHttpMethod:
          type: string
          description: The HTTP method for requesting tokens.
        Headers:
          type: object
          additionalProperties:
            type: string
          description: The headers for the OAuth2 provider.
        QueryParam:
          type: object
          additionalProperties:
            type: string
          description: The query parameters for the OAuth2 provider.
      required:
        - ProviderName
    CustomOAuth2Model:
      type: object
      properties:
        ProviderName:
          type: string
          description: The name of the OAuth2 provider.
        ExtraParameterInRedirectToProvider:
          type: string
          description: Extra parameters in redirect to provider.
        UserLoginEndpoint:
          type: string
          description: The User login endpoint for the OAuth2 provider.
        AccessTokenEndpoint:
          type: string
          description: The Access Token endpoint for the OAuth2 provider.
        ApplicationKey:
          type: string
          description: The application key for the OAuth2 provider.
        ApplicationSecret:
          type: string
          description: The application secret for the OAuth2 provider.
        EnableAutoLookUp:
          type: boolean
          nullable: true
          description: Indicates if auto lookup is enabled.
        Domain:
          type: string
          description: The domain for the OAuth2 provider.
        ApplicationID:
          type: string
          description: The application ID for the OAuth2 provider.
        Scope:
          type: string
          description: The scope for the OAuth2 provider.
        ResponseType:
          type: string
          description: The response type for the OAuth2 provider.
        UserprofileEndpoint:
          type: string
          description: The User profile endpoint for the OAuth2 provider.
        UserInfoExtractByIdToken:
          type: boolean
          nullable: true
          description: Indicates if user info should be extracted by ID token.
        JWKSEndpoint:
          type: string
          description: The JWKS endpoint for verifying the ID token.
        DataMap:
          type: object
          additionalProperties:
            type: string
          description: The data map for the OAuth2 provider.
        AccessTokenParameterNameForApiAccess:
          type: string
          description: The Access Token parameter name for API access.
        TrasnsportType:
          type: string
          description: The transport type.
        RequestTokenHttpMethod:
          type: string
          enum:
            - GET
            - POST
          description: The HTTP method for requesting tokens.
        Headers:
          type: object
          additionalProperties:
            type: string
          description: The headers for the OAuth2 provider.
        QueryParam:
          type: object
          additionalProperties:
            type: string
          description: The query parameters for the OAuth2 provider.
        ListInInterface:
          type: boolean
          description: Indicates if the provider should be listed in the interface.
      required:
        - ProviderName
        - UserLoginEndpoint
        - AccessTokenEndpoint
        - ApplicationKey
        - ApplicationSecret
        - Scope
        - ResponseType
        - DataMap
        - RequestTokenHttpMethod
    CustomOAuth2DeleteModel:
      type: object
      properties:
        ProviderName:
          type: string
          description: The name of the OAuth2 provider to be deleted.
      required:
        - ProviderName
    CustomProviderKeys:
      type: object
      properties:
        Key:
          type: string
          description: The key of the custom provider.
          example: custom_provider_key
        Display:
          type: string
          description: The display name of the custom provider.
          example: Custom Provider
    PasswordPolicy:
      type: object
      properties:
        DictionaryPasswordValidation:
          type: boolean
          nullable: true
          example: true
        ProfileDataPasswordValidation:
          type: boolean
          nullable: true
          example: true
        ProfileDataPasswordExactMatch:
          type: boolean
          nullable: true
          example: false
        CommonPasswordPreventionValidation:
          type: boolean
          nullable: true
          example: true
        MaxPasswordHistory:
          type: integer
          nullable: true
          example: 5
        ExpirationFrequency:
          type: integer
          nullable: true
          example: 90
        ExpirationFrequencyType:
          type: string
          nullable: true
          enum:
            - day
            - month
            - year
        PasswordValidationRules:
          type: string
          nullable: true
          example: At least one uppercase letter, one lowercase letter, one number, and one special character
    UserProfile:
      type: object
      properties:
        AppName:
          type: string
          description: Application name.
          example: myApp
        Uid:
          type: string
          description: Unique User identifier.
          example: '123456'
        ID:
          type: string
          nullable: true
          description: Internal User ID.
          example: abcde
        Provider:
          type: string
          nullable: true
          description: Authentication provider.
          example: google
        Prefix:
          type: string
          nullable: true
          description: Name prefix.
          example: Mr.
        FirstName:
          type: string
          nullable: true
          description: User's first name.
          example: John
        MiddleName:
          type: string
          nullable: true
          description: User's middle name.
          example: A.
        LastName:
          type: string
          nullable: true
          description: User's last name.
          example: Doe
        Suffix:
          type: string
          nullable: true
          description: Name suffix.
          example: Jr.
        FullName:
          type: string
          nullable: true
          description: Full name.
          example: John A. Doe
        NickName:
          type: string
          nullable: true
          description: Nickname.
          example: Johnny
        ProfileName:
          type: string
          nullable: true
          description: Profile name.
          example: johnnydoe
        BirthDate:
          type: string
          nullable: true
          format: date
          description: Birth date.
          example: '1990-01-01'
        Gender:
          type: string
          nullable: true
          description: Gender.
          example: male
        Website:
          type: string
          nullable: true
          description: Personal website URL.
          example: https://johndoe.com
        Email:
          description: Email address or object.
          oneOf:
            - type: string
            - type: object
          example: john@example.com
        Country:
          description: Country or object.
          oneOf:
            - type: string
            - type: object
          example: USA
        ThumbnailImageUrl:
          type: string
          nullable: true
          description: Thumbnail image URL.
          example: https://example.com/thumb.jpg
        ImageUrl:
          description: Image URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://example.com/image.jpg
        Favicon:
          description: Favicon URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://example.com/favicon.ico
        ProfileUrl:
          description: Profile URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://example.com/profile
        HomeTown:
          type: string
          nullable: true
          description: Hometown.
          example: New York
        State:
          type: string
          nullable: true
          description: State.
          example: NY
        City:
          type: string
          nullable: true
          description: City.
          example: New York
        Industry:
          type: string
          nullable: true
          description: Industry.
          example: Software
        About:
          type: string
          nullable: true
          description: About the User.
          example: Software engineer with 10 years of experience.
        TimeZone:
          type: string
          nullable: true
          description: Time zone.
          example: America/New_York
        LocalLanguage:
          type: string
          nullable: true
          description: Local language.
          example: en
        CoverPhoto:
          description: Cover photo URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://example.com/cover.jpg
        TagLine:
          type: string
          nullable: true
          description: Tag line.
          example: Keep it simple.
        Language:
          type: string
          nullable: true
          description: Preferred language.
          example: en
        Verified:
          type: string
          nullable: true
          description: Verification status.
          example: 'true'
        UpdatedTime:
          type: string
          nullable: true
          format: date-time
          description: Last updated time.
          example: '2023-01-01T12:00:00Z'
        Positions:
          description: Positions or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Educations:
          description: Educations or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        PhoneNumbers:
          description: Phone numbers or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        IMAccounts:
          description: IM accounts or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Addresses:
          description: Addresses or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        MainAddress:
          type: string
          nullable: true
          description: Main address.
          example: 123 Main St
        Created:
          type: string
          nullable: true
          format: date-time
          description: Created timestamp.
          example: '2020-01-01T00:00:00Z'
        CreatedDate:
          type: string
          nullable: true
          format: date-time
          description: Created date.
          example: '2020-01-01T00:00:00Z'
        ModifiedDate:
          type: string
          nullable: true
          format: date-time
          description: Modified date.
          example: '2021-01-01T00:00:00Z'
        ProfileModifiedDate:
          type: string
          nullable: true
          format: date-time
          description: Profile modified date.
          example: '2021-06-01T00:00:00Z'
        LocalCity:
          type: string
          nullable: true
          description: Local city.
          example: Brooklyn
        ProfileCity:
          type: string
          nullable: true
          description: Profile city.
          example: Manhattan
        LocalCountry:
          type: string
          nullable: true
          description: Local country.
          example: USA
        ProfileCountry:
          type: string
          nullable: true
          description: Profile country.
          example: USA
        FirstLogin:
          type: boolean
          description: Whether this is the User's first login.
          example: false
        IsProtected:
          type: boolean
          description: Whether the profile is protected.
          example: false
        RelationshipStatus:
          type: string
          nullable: true
          description: Relationship status.
          example: single
        Quota:
          type: string
          nullable: true
          description: Quota.
          example: unlimited
        InterestedIn:
          type: array
          nullable: true
          items:
            type: string
          description: List of interests.
          example:
            - sports
            - music
        Interests:
          description: Interests or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Religion:
          type: string
          nullable: true
          description: Religion.
          example: None
        Political:
          type: string
          nullable: true
          description: Political views.
          example: Independent
        Sports:
          description: Sports or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        InspirationalPeople:
          description: Inspirational people or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        HttpsImageUrl:
          description: HTTPS image URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://example.com/image.jpg
        FollowersCount:
          type: integer
          description: Number of followers.
          example: 100
        FriendsCount:
          type: integer
          description: Number of friends.
          example: 50
        IsGeoEnabled:
          type: string
          nullable: true
          description: Whether geo is enabled.
          example: 'true'
        TotalStatusesCount:
          type: integer
          description: Total number of statuses.
          example: 200
        Associations:
          type: string
          nullable: true
          description: Associations.
          example: IEEE
        NumRecommenders:
          type: integer
          description: Number of recommenders.
          example: 5
        Honors:
          type: string
          nullable: true
          description: Honors.
          example: Best Developer
        Awards:
          description: Awards or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Skills:
          description: Skills or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        CurrentStatus:
          description: Current status or object.
          oneOf:
            - type: string
            - type: object
          example: Active
        Certifications:
          description: Certifications or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Courses:
          description: Courses or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Volunteer:
          description: Volunteer or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        RecommendationsReceived:
          description: Recommendations received or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Languages:
          description: Languages or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Projects:
          description: Projects or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Games:
          description: Games or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Family:
          description: Family or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        TeleVisionShow:
          description: Television shows or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        MutualFriends:
          description: Mutual friends or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Movies:
          description: Movies or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Books:
          description: Books or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        AgeRange:
          description: Age range or object.
          oneOf:
            - type: string
            - type: object
          example: 18-25
        PublicRepository:
          description: Public repository or object.
          oneOf:
            - type: string
            - type: object
          example: https://github.com/johndoe
        Hireable:
          type: boolean
          description: Whether the User is hireable.
          example: true
        RepositoryUrl:
          description: Repository URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://github.com/johndoe
        Age:
          type: integer
          nullable: true
          description: Age of the User.
          example: 30
        Patents:
          description: Patents or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        FavoriteThings:
          description: Favorite things or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        ProfessionalHeadline:
          type: string
          nullable: true
          description: Professional headline.
          example: Senior Software Engineer
        RelatedProfileViews:
          description: Related profile views or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        KloutScore:
          description: Klout score or object.
          oneOf:
            - type: number
            - type: object
          example: 55.5
        LRUserID:
          type: string
          nullable: true
          description: LoginRadius User ID.
          example: lr_123456
        PlacesLived:
          description: Places lived or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Publications:
          description: Publications or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        JobBookmarks:
          description: Job bookmarks or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Suggestions:
          description: Suggestions or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        Badges:
          description: Badges or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        MemberUrlResources:
          description: Member URL resources or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        TotalPrivateRepository:
          type: integer
          description: Total number of private repositories.
          example: 2
        Currency:
          type: string
          nullable: true
          description: Currency.
          example: USD
        StarredUrl:
          description: Starred URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://github.com/johndoe/starred
        GistsUrl:
          description: Gists URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://gist.github.com/johndoe
        PublicGists:
          type: integer
          description: Number of public gists.
          example: 10
        PrivateGists:
          type: integer
          description: Number of private gists.
          example: 5
        Subscription:
          description: Subscription or object.
          oneOf:
            - type: string
            - type: object
          example: premium
        Company:
          type: string
          nullable: true
          description: Company name.
          example: Acme Corp
        GravatarImageUrl:
          description: Gravatar image URL or object.
          oneOf:
            - type: string
            - type: object
          example: https://www.gravatar.com/avatar/abc123
        ProfileImageUrls:
          description: Profile image URLs or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        WebProfiles:
          description: Web profiles or object.
          oneOf:
            - type: array
              items: {}
            - type: object
          example: []
        PinsCount:
          type: integer
          description: Number of PINs.
          example: 12
        BoardsCount:
          type: integer
          description: Number of boards.
          example: 3
        LikesCount:
          type: integer
          description: Number of likes.
          example: 100
        EmailVerifiedFromSocial:
          type: boolean
          description: Whether Email is verified from social login.
          example: true
        SignupDate:
          type: string
          nullable: true
          format: date-time
          description: Signup date.
          example: '2020-01-01T00:00:00Z'
        LastLoginDate:
          type: string
          nullable: true
          format: date-time
          description: Last login date.
          example: '2023-01-01T00:00:00Z'
        CustomFields:
          description: Custom fields or object.
          oneOf:
            - type: object
            - type: array
              items: {}
          example: {}
        LastPasswordChangeDate:
          type: string
          nullable: true
          format: date-time
          description: Last Password change date.
          example: '2023-01-01T00:00:00Z'
        PasswordExpirationDate:
          type: string
          nullable: true
          format: date-time
          description: Password expiration date.
          example: '2023-12-31T00:00:00Z'
        LastPasswordChangeToken:
          type: string
          nullable: true
          description: Last Password change token.
          example: token123
        EmailVerified:
          type: boolean
          description: Whether Email is verified.
          example: true
        IsActive:
          type: boolean
          description: Whether the User is active.
          example: true
        IsDeleted:
          type: boolean
          description: Whether the User is deleted.
          example: false
        IsEmailSubscribed:
          type: boolean
          description: Whether the User is subscribed to emails.
          example: true
        UserName:
          type: string
          nullable: true
          description: Username.
          example: johndoe
        NoOfLogins:
          type: integer
          description: Number of logins.
          example: 20
        PreviousUids:
          type: array
          nullable: true
          items:
            type: string
          description: Previous UIDs.
          example:
            - oldUID1
            - oldUID2
        PhoneId:
          type: string
          nullable: true
          description: Phone ID.
          example: phone123
        PhoneIdVerified:
          type: boolean
          description: Whether Phone ID is verified.
          example: true
        Roles:
          type: array
          nullable: true
          items:
            type: string
          description: List of Roles.
          example:
            - admin
            - user
        ExternalUserLoginId:
          type: string
          nullable: true
          description: External User login ID.
          example: extlogin123
        FailedLoginAttempt:
          type: integer
          description: Number of failed login attempts.
          example: 0
        SecurityQuestionFailedResetPasswordAttempts:
          type: integer
          description: Failed security question attempts for Password reset.
          example: 0
        SecurityQuestionFailedLoginAttempt:
          type: integer
          description: Failed security question attempts for login.
          example: 0
        DisableLogin:
          type: boolean
          description: Whether login is disabled.
          example: false
        RegistrationProvider:
          type: string
          nullable: true
          description: Registration provider.
          example: google
        IsLoginLocked:
          type: boolean
          description: Whether login is locked.
          example: false
        LoginLockedType:
          type: string
          nullable: true
          description: Type of login lock.
          example: temporary
        LastLoginLocation:
          type: string
          nullable: true
          description: Last login location.
          example: New York
        RegistrationSource:
          type: string
          nullable: true
          description: Registration source.
          example: web
        IsCustomUid:
          type: boolean
          description: Whether UID is custom.
          example: false
        UnverifiedEmail:
          description: Unverified Email or object.
          oneOf:
            - type: string
            - type: object
          example: unverified@example.com
        RoleContext:
          description: Role Context or object.
          oneOf:
            - type: object
            - type: array
              items: {}
          example: {}
        KnownLoginVariables:
          description: Known login variables or object.
          oneOf:
            - type: object
            - type: array
              items: {}
          example: {}
        IsSecurePassword:
          type: boolean
          description: Whether the Password is secure.
          nullable: true
          example: true
        PrivacyPolicy:
          description: Privacy Policy or object.
          oneOf:
            - type: object
            - type: array
              items: {}
          example: {}
        LoginLockedTimeout:
          type: string
          nullable: true
          description: Login locked timeout.
          example: '2023-01-01T01:00:00Z'
        ExternalIds:
          description: External IDs or object.
          oneOf:
            - type: object
            - type: array
              items: {}
          example: {}
        IsRequiredFieldsFilledOnce:
          type: boolean
          description: Whether required fields are filled at least once.
          example: true
        SignupLog:
          description: Signup log or object.
          oneOf:
            - type: object
            - type: array
              items: {}
          example: {}
        LastAcceptedConsentVersion:
          type: number
          format: float
          description: Last accepted consent version.
          example: 1
        user_agent:
          description: User agent or object.
          oneOf:
            - type: string
            - type: object
          example: Mozilla/5.0
    UserProfileResponse:
      type: object
      properties:
        data:
          type: array
          description: List of User profiles.
          items:
            $ref: '#/components/schemas/UserProfile'
        next:
          type: string
          description: Scroll or pagination token for fetching the next set of results.
          example: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAABXcWem...
    QueryGroup:
      type: object
      properties:
        operator:
          type: string
          enum:
            - AND
            - OR
          description: Logical operator to combine rules.
          example: AND
        rules:
          type: array
          items:
            $ref: '#/components/schemas/QueryRule'
          minItems: 1
      required:
        - operator
        - rules
    QueryRule:
      type: object
      properties:
        group:
          $ref: '#/components/schemas/QueryGroup'
        name:
          type: string
          description: Name of the field to query.
          example: status
        operator:
          type: string
          description: Operator for the query (e.g., =, !=, >, <).
          example: '='
        value:
          description: Value to compare against. Can be string, boolean, or number.
          example: active
    IdentityQuery:
      type: object
      properties:
        group:
          $ref: '#/components/schemas/QueryGroup'
    UserProfileRequestBody:
      type: object
      properties:
        from:
          type: string
          format: date
          description: Start date in YYYY-MM-DD format.
        to:
          type: string
          format: date
          description: End date in YYYY-MM-DD format.
        size:
          type: integer
          minimum: 1
          maximum: 1000
          description: Number of results to return.
        q:
          $ref: '#/components/schemas/IdentityQuery'
    SimpleUserProfileResponse:
      type: object
      properties:
        _id:
          type: string
          description: Unique identifier for the User profile
          example: user_123456789
        DateCreated:
          type: string
          format: date-time
          description: Date and time when the profile was created
          example: '2023-10-01T12:00:00Z'
        DateModified:
          type: string
          format: date-time
          description: Date and time when the profile was last modified
          example: '2023-10-02T12:00:00Z'
        IsActive:
          type: boolean
          description: Whether the profile is active
        IsDeleted:
          type: boolean
          description: Whether the profile is deleted
        CustomObject:
          type: object
          additionalProperties: true
          description: Custom data associated with the User
        Uid:
          type: string
          description: Unique identifier of the User
          example: UID_123456789
    UserProfileScrollResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of User profiles matching the query.
          example: 100
        data:
          type: array
          description: List of User profiles.
          items:
            $ref: '#/components/schemas/SimpleUserProfileResponse'
        next:
          type: string
          description: Scroll or pagination token for fetching the next set of results.
          example: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAABXcWem...
    ExtendUserProfileWithCustomObject:
      allOf:
        - $ref: '#/components/schemas/UserProfile'
        - type: object
          properties:
            CustomObject:
              type: object
              description: Custom Object associated with the User profile.
              additionalProperties:
                type: object
                description: Custom fields defined by the User.
                example:
                  field1: value1
                  field2: value2
              example:
                field1:
                  subfield: subvalue
    userProfileNextResponseWithCustomObject:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExtendUserProfileWithCustomObject'
        next:
          type: string
          description: The token to retrieve the next page of results.
          nullable: true
          example: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAABXcWem...
    userProfileScrollResponseWithCustomObject:
      type: object
      properties:
        total:
          type: integer
          description: Total number of User profiles matching the query.
          example: 100
        data:
          type: array
          description: List of User profiles.
          items:
            $ref: '#/components/schemas/ExtendUserProfileWithCustomObject'
        next:
          type: string
          description: Scroll or pagination token for fetching the next set of results.
          example: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAABXcWem...
    UserProfileNextResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SimpleUserProfileResponse'
        next:
          type: string
          description: The token to retrieve the next page of results.
          nullable: true
          example: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAABXcWem...
    RangeObj:
      type: object
      properties:
        key:
          type: string
          description: Optional. Key for the range bucket.
          example: range-1
        to:
          description: Upper bound of the range (inclusive or exclusive depending on context).
          oneOf:
            - type: string
            - type: integer
            - type: number
          example: 100
        from:
          description: Lower bound of the range (inclusive or exclusive depending on context).
          oneOf:
            - type: string
            - type: integer
            - type: number
          example: 0
      description: |
        Defines a single range for range-based aggregations, with optional key.
    AggregationObj:
      type: object
      properties:
        field:
          type: string
          description: The field to aggregate on.
          example: status
        type:
          type: string
          description: The type of aggregation (e.g., terms, range, histogram).
          example: terms
        ranges:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RangeObj'
          description: |
            Optional. A map of range names to range objects, used for range aggregations.
        interval:
          description: |
            Optional. The interval for histogram aggregations. Can be string, integer, or float.
          oneOf:
            - type: string
            - type: integer
            - type: number
          example: 10
        format:
          type: string
          description: Optional. Format string for date or numeric values.
          example: yyyy-MM-dd
      description: |
        Configuration for a single aggregation, including field, type, and optional range or interval.
    Aggregation:
      type: object
      required:
        - aggregations
      properties:
        aggregations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AggregationObj'
          description: |
            A map of aggregation names to their configuration objects.
      description: |
        Defines the aggregation structure for the insights query.
    requestPayload:
      type: object
      properties:
        from:
          type: string
          format: date-time
          description: Start of the time range for the query (ISO 8601 format).
        to:
          type: string
          format: date-time
          description: End of the time range for the query (ISO 8601 format).
        q:
          $ref: '#/components/schemas/Aggregation'
      description: |
        The request payload for insights queries, specifying the time range and aggregation details.
    InsightsResponse:
      type: object
      properties:
        total:
          type: integer
          format: int32
          description: Total number of results
        aggregations:
          type: object
          additionalProperties: true
          description: Aggregated data
    LoginByEmail:
      description: Login By Email
      type: object
      properties:
        email:
          type: string
          example: user123@example.com
        password:
          type: string
          example: Password123
      required:
        - email
        - password
    LoginByUserName:
      description: Login By UserName
      type: object
      properties:
        password:
          type: string
          example: Password123
        username:
          type: string
          example: user123
      required:
        - username
        - password
    JWTSignature:
      description: JWT Signature Response
      type: object
      properties:
        signature:
          type: string
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMTI1NjNmNi0xNDgwLTQwYjgtOGUyOC1lMDcyY2EyMTJjODIiLCJlbWFpbCI6Im1heWFua2xydGVzdDIrQGdtYWlsLmNvbSIsImV4cCI6MTc0NTQ4MzA4MSwiZmlyc3RuYW1lIjoiTWF5YW5rIiwiaWF0IjoxNzQ1NDgxMjgxLCJpc3MiOiJodHRwczovL2ludGVybmFsLW1heWFuay5odWIubG9naW5yYWRpdXMuY29tLyIsImp0aSI6IjlhNGZkOGY1LWU4NDMtNDgzZS1hODNiLTJlNTM4NzY5ZTYxNiIsImxhc3RuYW1lIjoiQWdhcndhbCIsIm5iZiI6MTc0NTQ4MTI4MSwic3ViIjoiMWFjM2Q5ZGMzYzdkNDJlMDhhMzJiZjU0NjIyYmNjYzMifQ.m88HgYiikjAJju5mKeqJLgdEbqoAGGLVGLhxmB81jWc
    OAuthDeviceCode:
      description: OAuth Device Code Request
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        scope:
          type: string
          example: openid Email profile
      required:
        - client_id
    OAuthDeviceCodeResponse:
      description: OAuth Device Code Response
      type: object
      properties:
        device_code:
          type: string
          example: device_code
        expires_in:
          type: integer
          example: 1800
        interval:
          type: integer
          example: 5
        user_code:
          type: string
          example: user_code
        verification_uri:
          type: string
          example: https://example.com/device/verification
        verification_uri_complete:
          type: string
          example: https://example.com/device/verification?user_code=user_code
    OAuthErrorResponse:
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
    OAuthRevokeRefreshToken:
      description: OAuth Revoke Refresh Token Request
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        client_secret:
          type: string
          example: AQvsBHrjOYFNJdvndATLBPoavRZUp1fj4656
        token:
          type: string
          example: 3976a9391e31d3c1cf854c83f9f65078:90f...
      required:
        - client_id
        - client_secret
        - token
    OIDCTokenIntrospectResponse:
      description: OIDC Token Introspection Response (RFC 7662). When active is false, only active is returned. When active is true, standard claims may be included.
      type: object
      properties:
        active:
          type: boolean
          description: True if the token is valid and active; false otherwise.
          example: true
        sub:
          type: string
          description: Subject (e.g. user or client identifier)
          example: 699f40ae-8040-42fe-a1cd-e1eb10cf73ef
        cid:
          type: string
          description: Client ID (audience/client)
          example: ddff8a63-cbc3-4723-8415-b910c4d8770d
        azp:
          type: string
          description: Authorized party
          example: ddff8a63-cbc3-4723-8415-b910c4d8770d
        iss:
          type: string
          description: Issuer
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}
        exp:
          type: integer
          description: Expiration time (Unix)
          example: 1745988311
        iat:
          type: integer
          description: Issued at (Unix)
          example: 1745981111
        nbf:
          type: integer
          description: Not before (Unix)
          example: 1745981111
        gty:
          type: string
          description: Grant type (e.g. authorization_code, refresh_token, password)
          example: authorization_code
        scp:
          type: array
          items:
            type: string
          description: Scopes
          example:
            - openid
            - profile
        aud:
          type: array
          items:
            type: string
          description: Audience
        jti:
          type: string
          description: JWT ID
      required:
        - active
    OAuthAuthorizationCodeFlow:
      description: Authorization Code Flow
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        client_secret:
          type: string
          example: AQvsBHrjOYFNJdvndATLBPoavRZUp1fj4656
        code:
          type: string
          example: ab261e646022e92c620e2be8c10469d...
        grant_type:
          type: string
          default: authorization_code
        redirect_uri:
          type: string
          example: https://example.com/callback
        response_type:
          type: string
          default: token
      required:
        - client_id
        - client_secret
        - grant_type
        - redirect_uri
        - code
    OAuthAuthorizationCodePKCEFlow:
      description: Authorization Code PKCE Flow
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        code:
          type: string
          example: ab261e646022e92c620e2be8c10469d...
        code_verifier:
          type: string
          example: 3Cc3HvI2dyIGee-ZBqCtS5tlXXBFEuCByG06QLiEcAU
        grant_type:
          type: string
          default: authorization_code
        redirect_uri:
          type: string
          example: https://example.com/callback
        response_type:
          type: string
          default: token
      required:
        - client_id
        - grant_type
        - redirect_uri
        - code
        - code_verifier
    OAuthRefreshTokenFlow:
      description: Refresh Token Flow
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        client_secret:
          type: string
          example: AQvsBHrjOYFNJdvndATLBPoavRZUp1fj4656
        grant_type:
          type: string
          default: refresh_token
        response_type:
          type: string
          default: token
        token:
          type: string
          example: 3976a9391e31d3c1cf854c83f9f65078:90f...
      required:
        - client_id
        - client_secret
        - grant_type
        - token
    OAuthPasswordCredentialFlow:
      description: Password Credential Flow
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        client_secret:
          type: string
          example: AQvsBHrjOYFNJdvndATLBPoavRZUp1fj4656
        grant_type:
          type: string
          default: password
        password:
          type: string
          example: pass@123
        response_type:
          type: string
          default: token
        scope:
          type: string
          example: openid Email profile
        username:
          type: string
          example: user@example.com
      required:
        - client_id
        - client_secret
        - grant_type
        - username
        - password
    OAuthDeviceCodeFlow:
      description: Device Code Flow
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        device_code:
          type: string
          example: device_code
        grant_type:
          type: string
          default: urn:ietf:params:oauth:grant-type:device_code
        response_type:
          type: string
          default: token
        scope:
          type: string
          example: openid Email profile
      required:
        - client_id
        - grant_type
        - device_code
    OAuthLoginRadiusTokenExchangeFlow:
      description: LoginRadius Token Exchange Flow converts Loginradius GUID or JWT Encrypted token to OAuth Tokens
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        client_secret:
          type: string
          example: AQvsBHrjOYFNJdvndATLBPoavRZUp1fj4656
        grant_type:
          type: string
          default: http://loginradius.com/oauth/grant-type/exchange_token
        response_type:
          type: string
          default: token
        scope:
          type: string
          example: openid Email profile
        token:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
      required:
        - client_id
        - client_secret
        - grant_type
        - token
    OAuthTokenResponse:
      description: OAuth Token Response
      type: object
      properties:
        access_token:
          type: string
          format: jwt
          example: eyJhbGciOiJIUz...
        expire_in:
          type: string
          example: '3600'
        refresh_token:
          type: string
          example: 3976a9391e31d3c1cf854c83f9f65078:90f...
        token_type:
          type: string
          default: Bearer
    OIDCDeviceCode:
      description: OIDC Device Code Request
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        scope:
          type: string
          example: openid Email profile
      required:
        - client_id
    OIDCDeviceCodeResponse:
      description: OIDC Device Code Response
      type: object
      properties:
        device_code:
          type: string
          example: device_code
        expires_in:
          type: integer
          example: 1800
        interval:
          type: integer
          example: 5
        user_code:
          type: string
          example: user_code
        verification_uri:
          type: string
          example: https://example.com/device/verification
        verification_uri_complete:
          type: string
          example: https://example.com/device/verification?user_code=user_code
    OIDCTokenResponse:
      description: OIDC Token Response
      type: object
      properties:
        access_token:
          type: string
          format: jwt
          example: eyJhbGciOiJIUz...
        expire_in:
          type: string
          example: '3600'
        id_token:
          type: string
          format: jwt
          example: id_token
        refresh_token:
          type: string
          example: 3976a9391e31d3c1cf854c83f9f65078:90f...
        token_type:
          type: string
          default: Bearer
    OAuthM2MTokenIntrospect:
      description: M2M Token Introspect Request
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        client_secret:
          type: string
          example: AQvsBHrjOYFNJdvndATLBPoavRZUp1fj4656
        token:
          type: string
          example: 3976a9391e31d3c1cf854c83f9f65078:90f...
        token_type_hint:
          type: string
          example: access_token
          default: access_token
      required:
        - client_id
        - client_secret
        - token
        - token_type_hint
    OAuthM2MIntrospectResponse:
      description: M2M Token Introspect Response
      type: object
      properties:
        active:
          type: boolean
          example: true
        aud:
          type: array
          items:
            type: string
          example:
            - https://{TenantEndpoint}/identity/v2/manage
        cid:
          type: string
          example: ddff8a63-cbc3-4723-8415-b910c4d8770d
        exp:
          type: integer
          example: 1745988311
        gty:
          type: string
          example: client_credentials
        iat:
          type: integer
          example: 1745981111
        iss:
          type: string
          example: https://{TenantEndpoint}/
        jti:
          type: string
          example: e20a1ae9-880a-4829-88ff-690141d958b5
        nbf:
          type: integer
          example: 1745981111
        scp:
          type: array
          items:
            type: string
          example:
            - all
        sub:
          type: string
          example: 699f40ae-8040-42fe-a1cd-e1eb10cf73ef@client
    JWKSResponse:
      description: JWKS Config Response
      type: object
      properties:
        keys:
          type: array
          items:
            properties:
              alg:
                type: string
                example: RS256
              e:
                type: string
                example: AQAB
              kid:
                type: string
                example: 31524f1ce57e45fd967d7431e18b97c6
              kty:
                type: string
                example: RSA
              'n':
                type: string
                example: 0u2t0m8XWLAOTYWR4vtT...
              use:
                type: string
                example: sig
            type: object
    OAuthM2MTokenRevoke:
      description: M2M Token Service Request
      type: object
      properties:
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        client_secret:
          type: string
          example: AQvsBHrjOYFNJdvndATLBPoavRZUp1fj4656
        token:
          type: string
          example: 3976a9391e31d3c1cf854c83f9f65078:90f...
        token_type_hint:
          type: string
          example: access_token
          default: access_token
      required:
        - client_id
        - client_secret
        - token
        - token_type_hint
    OAuthM2MTokenGenerate:
      description: M2M Token Generate Request
      type: object
      properties:
        audience:
          type: string
          example: https://api.loginradius.com/identity/v2/manage
        client_id:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        client_secret:
          type: string
          example: AQvsBHrjOYFNJdvndATLBPoavRZUp1fj4656
        grant_type:
          type: string
          example: client_credentials
          default: client_credentials
      required:
        - client_id
        - client_secret
        - grant_type
        - audience
    OAuthM2MTokenResponse:
      description: M2M Token Response
      type: object
      properties:
        access_token:
          type: string
          format: jwt
          example: eyJhbGciOiJIUz...
        expire_in:
          type: string
          example: '3600'
        token_type:
          type: string
          default: Bearer
    OIDCDiscoveryResponse:
      description: OIDC Discovery Config Response
      type: object
      properties:
        acr_values_supported:
          type: array
          items:
            type: string
          example:
            - loginradius:nist:level:1:re-auth
        authorization_endpoint:
          type: string
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}/authorize
        backchannel_logout_session_supported:
          type: boolean
          example: true
        backchannel_logout_supported:
          type: boolean
          example: true
        claims_supported:
          type: array
          items:
            type: string
          example:
            - picture
            - zoneinfo
            - locale
            - email
            - phone_number
            - middle_name
            - nickname
            - profile
            - auth_time
            - phone_number_verified
            - address
            - website
            - birthdate
            - updated_at
            - acr
            - email_verified
            - name
            - given_name
            - preferred_username
            - gender
            - family_name
        code_challenge_methods_supported:
          type: array
          items:
            type: string
          example:
            - S256
        end_session_endpoint:
          type: string
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}/logout
        grant_types_supported:
          type: array
          items:
            type: string
          example:
            - authorization_code
            - implicit
            - refresh_token
            - password
            - urn:ietf:params:oauth:grant-type:device_code
        id_token_signing_alg_values_supported:
          type: array
          items:
            type: string
          example:
            - RS256
        issuer:
          type: string
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}
        jwks_uri:
          type: string
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}/jwks
        request_parameter_supported:
          type: boolean
          example: false
        response_modes_supported:
          type: array
          items:
            type: string
          example:
            - query
            - form_post
            - fragment
        response_types_supported:
          type: array
          items:
            type: string
          example:
            - code
            - token
            - id_token
            - code token
            - code id_token
            - token id_token
            - code token id_token
        revocation_endpoint:
          type: string
          example: https://{TenantEndpoint}/api/oidc/{oidcAppName}/revoke
        introspection_endpoint:
          type: string
          description: OAuth 2.0 Token Introspection endpoint (RFC 7662)
          example: https://{TenantEndpoint}/api/oidc/{oidcAppName}/introspect
        revocation_endpoint_auth_methods_supported:
          type: array
          items:
            type: string
          example:
            - client_secret_post
            - client_secret_basic
        scopes_supported:
          type: array
          items:
            type: string
          example:
            - openid
            - email
            - phone
            - profile
            - address
        subject_types_supported:
          type: array
          items:
            type: string
          example:
            - public
        token_endpoint:
          type: string
          example: https://{TenantEndpoint}/api/oidc/{oidcAppName}/token
        token_endpoint_auth_methods_supported:
          type: array
          items:
            type: string
          example:
            - client_secret_post
            - client_secret_basic
        userinfo_endpoint:
          type: string
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}/userinfo
    OAuthAuthorizationServerMetadata:
      description: OAuth 2.0 Authorization Server Metadata (RFC 8414). Standard discovery document for OAuth 2.0 authorization servers; does not include OpenID Connect-specific fields (e.g. userinfo_endpoint, claims_supported).
      type: object
      required:
        - issuer
        - token_endpoint
        - jwks_uri
        - response_types_supported
        - grant_types_supported
      properties:
        issuer:
          type: string
          description: The authorization server's issuer identifier (MUST match the requested issuer).
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}
        authorization_endpoint:
          type: string
          description: URL of the authorization endpoint.
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}/authorize
        token_endpoint:
          type: string
          description: URL of the token endpoint.
          example: https://{TenantEndpoint}/api/oidc/{oidcAppName}/token
        jwks_uri:
          type: string
          description: URL of the JSON Web Key Set document.
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}/jwks
        response_types_supported:
          type: array
          items:
            type: string
          description: List of OAuth 2.0 response_type values supported.
          example:
            - code
        grant_types_supported:
          type: array
          items:
            type: string
          description: List of OAuth 2.0 grant type values supported.
          example:
            - authorization_code
            - refresh_token
            - urn:ietf:params:oauth:grant-type:device_code
        token_endpoint_auth_methods_supported:
          type: array
          items:
            type: string
          description: List of client authentication methods supported at the token endpoint.
          example:
            - none
            - client_secret_post
            - client_secret_basic
        registration_endpoint:
          type: string
          description: URL of the dynamic client registration endpoint (optional).
          example: https://{TenantEndpoint}/api/oidc/{oidcAppName}/register
        scopes_supported:
          type: array
          items:
            type: string
          description: List of OAuth 2.0 scope values supported.
          example:
            - openid
            - email
            - phone
            - profile
            - address
        response_modes_supported:
          type: array
          items:
            type: string
          example:
            - query
            - form_post
            - fragment
        code_challenge_methods_supported:
          type: array
          items:
            type: string
          description: PKCE code challenge methods supported.
          example:
            - S256
        revocation_endpoint:
          type: string
          description: URL of the token revocation endpoint.
          example: https://{TenantEndpoint}/api/oidc/{oidcAppName}/revoke
        revocation_endpoint_auth_methods_supported:
          type: array
          items:
            type: string
          example:
            - none
            - client_secret_post
            - client_secret_basic
        device_authorization_endpoint:
          type: string
          description: URL of the device authorization endpoint.
          example: https://{TenantEndpoint}/service/oidc/{oidcAppName}/device/authorize
        token_endpoint_auth_signing_alg_values_supported:
          type: array
          items:
            type: string
          example:
            - RS256
        subject_types_supported:
          type: array
          items:
            type: string
          description: List of subject identifier types supported.
          example:
            - public
        ClientIdMetadataDocumentSupported:
          type: boolean
          description: Indicates if the client metadata document is supported.
          example: true
    OIDCUserinfoResponse:
      description: OIDC UserInfo Response
      type: object
      additionalProperties: true
      example:
        birthdate: 10-12-1985
        email: user@example.com
        email_verified: true
        family_name: Garcia
        gender: F
        given_name: Ava
        middle_name: Marie
        nickname: Ava
        preferred_username: avagarcia
        sub: fddf331f038a409c96bfb1733e6d0c63
        updated_at: 1747206183
        website: https://www.avagarcia.com
    OIDCUserinfoJWTResponse:
      description: OIDC UserInfo JWT Response when SignedUserInfo is true
      type: string
      format: jwt
      example: eyJhbGciOiJSUzI1NiIsImtpZCI6IjMxNTI0ZjFjZTU3ZTQ1ZmQ5NjdkNzQzMWUxOGI5N2M2IiwidHlwIjoiSldUIn0.eyJhdWQiOiIzMTVhMjA3MC05NjM5LTRlMTktOTk1Ni1kMTFmYjZlNmIwOTAiLCJleHAiOjE3NDcyMTk3ODUsImlhdCI6MTc0NzIxODg4NSwiaXNzIjoiaHR0cHM6Ly9hdXRoLmV4YW1wbGUuY29tL3NlcnZpY2Uvb2lkYy9vaWRjLWFwcCIsImp0aSI6IjljMmE2YzcxLTg0NmQtNDliNS05NzNlLWMwYjlkNDY1ZmFmMiIsIm5iZiI6MTc0NzIxODg4NSwic3ViIjoiNjEyMDFmYzI4ODYyNDcwYTljN2I3MTJkMDE2NjkwNjUifQ.dusZxEqtDzpRO3bsd4V51RPJj3GvXu0_BDsOrVUl2WJQuNxfE49xDiZ7YZOtDhQhBGDCWBffdqSm9JcF0CfC4kCpF4S9qE21JiPGGjJCMMu7zFdCR7hcYdWKUZ_n0eaAO5MltTWDOD7te_Gb-EUZm1mJ7w4hQbApt-JodIglU5C3ydq6WydX_hrYpOy-lPqYBpP2r69FqKwKJRwoOt7jmNmUdFNjgdBal_OE9JimFX1hd603rbAoTW_VhEKmapF5iKhQpiqAqerh9QI3UEzpuIqiW9ewgVKL1Y_tEdI11I2BDU1jgNGaU3bBT58lYrMw1f6GQcliPhHX_NleyGJwHA
    OIDCUserinfo:
      description: OIDC Userinfo request
      type: object
      properties:
        access_token:
          type: string
          format: jwt
          example: eyJhbGciOiJIUz...
      required:
        - access_token
    SamlIdpMetadataResponse:
      description: Saml IdP Metadata Response
      type: object
      properties:
        DSNS:
          type: string
          example: http://www.w3.org/2000/09/xmldsig#
          xml:
            attribute: true
            name: xmlns:ds
        EntityId:
          type: string
          example: https://auth.example.com/
          xml:
            attribute: true
            name: entityID
        IDPSSODescriptor:
          type: object
          properties:
            ProtocolSupportEnumeration:
              type: string
              example: urn:oasis:names:tc:SAML:2.0:protocol
              xml:
                attribute: true
                name: protocolSupportEnumeration
            SigningKeyDescriptor:
              type: object
              properties:
                KeyInfo:
                  type: object
                  properties:
                    X509Data:
                      type: object
                      properties:
                        X509Certificate:
                          type: object
                          properties:
                            Cert:
                              type: string
                              example: MIID...
                          xml:
                            prefix: ds
                      xml:
                        prefix: ds
                  xml:
                    name: KeyInfo
                    prefix: ds
                Use:
                  type: string
                  example: signing
                  xml:
                    attribute: true
                    name: use
              xml:
                name: KeyDescriptor
            SingleLogoutService:
              type: array
              items:
                properties:
                  Binding:
                    type: string
                    example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
                    xml:
                      attribute: true
                      name: Binding
                  Location:
                    type: string
                    example: https://auth.example.com.com//service/saml/idp/logout?appName=example_saml_app
                    xml:
                      attribute: true
                      name: Location
                type: object
                xml:
                  name: SingleLogoutService
              xml:
                name: SingleLogoutService
            SingleSignOnService:
              type: array
              items:
                properties:
                  Binding:
                    type: string
                    example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
                    xml:
                      attribute: true
                      name: Binding
                  Location:
                    type: string
                    example: https://auth.example.com.com/service/saml/idp/login?appName=example_saml_app
                    xml:
                      attribute: true
                      name: Location
                type: object
                xml:
                  name: SingleSignOnService
              xml:
                name: SingleSignOnService
            WantAuthnRequestsSigned:
              type: string
              example: 'false'
              xml:
                attribute: true
                name: WantAuthnRequestsSigned
          xml:
            name: IDPSSODescriptor
        XMLNS:
          type: string
          example: urn:oasis:names:tc:SAML:2.0:metadata
          xml:
            attribute: true
            name: xmlns
      xml:
        name: EntityDescriptor
    QRCodeResponse:
      description: QR Code Response
      type: object
      properties:
        code:
          type: string
          example: ZGQzMjFhOGEtMjk0ZC00YmZmLThiYTItMTY4ODQ1MmQ1NmVmIzIwMjUtMDQtMjlUMDU6MDY6NDIuNTI2Wg==
    AccessTokenByPingQRCodeResponse:
      description: Access Token By Ping QR Code Response
      type: object
      properties:
        access_token:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
          nullable: true
    QRCodeMapToToken:
      description: QR Code Map to Access Token Request
      type: object
      properties:
        access_token:
          type: string
          example: 68106262-3938-4435-87ed-3e410b360209
        code:
          type: string
          example: MzUwOTczMDAtODM0MC00Y2FkLWE3MDgtNmY2ZDRiMDA4NjZlIzIwMjEtMTItMjlUMTc6NDk6MjIuNDY0Wg==
    QRCodeMapToTokenResponse:
      description: QR Code Map to Access Token Response
      type: object
      properties:
        isPosted:
          type: boolean
    PasswordEncryptionModel:
      type: object
      properties:
        IsPerPasswordSalt:
          type: boolean
          default: false
          description: Whether to generate a unique salt for each password
          example: true
        NumberOfIteration:
          type: integer
          minimum: 0
          nullable: true
          description: Number of hashing iterations to apply.
          example: 100000
        PasswordHasherVersion:
          type: string
          default: V1
          description: Version identifier for the Password hashing algorithm.
          example: V1
          enum:
            - V1
            - V2
            - V3
            - V4
            - V5
        SubKeyLength:
          type: integer
          minimum: 0
          nullable: true
          description: Length of the derived key (in bytes).
          example: 32
        SaltKeyLength:
          type: integer
          minimum: 0
          nullable: true
          description: Length of the salt key (in bytes).
          example: 16
        Salt:
          type: string
          nullable: true
          description: Global salt value (used when IsPerPasswordSalt is false)
          example: c2FsdFZhbHVlMTIz
        Type:
          type: string
          description: The encryption or hashing algorithm used.
          example: PBKDF2
          enum:
            - MD5
            - BCRYPT
            - PBKDF2
            - SHA1
            - SHA256
            - SHA512
            - HMAC_SHA1
            - HMAC_SHA256
            - ARGON2ID
            - ARGON2I
        SaltAttachType:
          type: string
          description: How to attach salt to password
          example: Prepend
          enum:
            - None
            - Prepend
            - Append
        PasswordHashEncodingType:
          type: string
          nullable: true
          description: Encoding type for the Password hash output
          example: Base64
          enum:
            - Default
            - Base64
            - HexaDecimal
            - UTF8
            - BitConverter
        PasswordSaltEncodingType:
          type: string
          nullable: true
          description: Encoding type for the salt
          example: Base64
          enum:
            - Default
            - Base64
            - HexaDecimal
            - UTF8
            - BitConverter
        PlaintextPasswordEncoding:
          type: string
          nullable: true
          description: Encoding type for the plaintext Password before hashing.
          example: Default
          enum:
            - Default
            - Base64
            - UTF8
        PasswordHashThread:
          type: integer
          nullable: true
          minimum: 0
          maximum: 128
          description: Number of threads for Argon2 algorithms
          example: 2
        PasswordHashMemory:
          type: integer
          nullable: true
          minimum: 0
          maximum: 8192
          description: Memory usage (in KB) for Argon2 algorithms
          example: 64
      required:
        - Type
    DeltaMigrationModel:
      type: object
      properties:
        DeltaMigration:
          type: boolean
          description: Indicates if delta migration is enabled.
          example: true
        OverWriteDuplicate:
          type: boolean
          description: If true, existing records will be overwritten when duplicates are found.
          example: false
        UniqueFields:
          type: array
          description: Fields used to determine record uniqueness.
          items:
            type: string
          example:
            - email
            - phone
      required:
        - DeltaMigration
        - OverWriteDuplicate
    BatchUpload:
      type: object
      properties:
        PasswordEncryption:
          $ref: '#/components/schemas/PasswordEncryptionModel'
        Profiles:
          type: array
          items:
            $ref: '#/components/schemas/ProfileRequestModel'
          description: A list of User profile objects to be uploaded in batch.
        DeltaMigrationModel:
          $ref: '#/components/schemas/DeltaMigrationModel'
      required:
        - Profiles
    BulkInsertErrorReport:
      type: object
      properties:
        RecordNumber:
          type: integer
          format: int32
          description: Row no of the record that failed.
          example: 3
        Message:
          type: string
          description: Description of the error encountered during insert or update.
          example: Email address already exists
      required:
        - RecordNumber
        - Message
    BulkInsertReport:
      type: object
      properties:
        RecordInserted:
          type: integer
          format: int64
          description: Number of records successfully inserted.
          example: 150
        RecordUpdated:
          type: integer
          format: int64
          description: Number of records successfully updated.
          example: 50
        Failed:
          type: array
          description: List of records that failed to insert or update.
          items:
            $ref: '#/components/schemas/BulkInsertErrorReport'
      required:
        - RecordInserted
        - RecordUpdated
    BatchUploadResponse:
      type: object
      properties:
        Profile:
          $ref: '#/components/schemas/BulkInsertReport'
        Roles:
          $ref: '#/components/schemas/BulkInsertReport'
      required:
        - Profile
    BatchUploadErrorResponse:
      type: object
      required:
        - ErrorCode
        - Message
        - Description
      properties:
        ErrorCode:
          type: integer
          format: int32
          description: Error code for identifying the error type.
          example: 908
        Message:
          type: string
          description: Brief message describing the error.
          example: A parameter is not formatted correctly
        Description:
          type: string
          description: Detailed description of the error.
          example: A parameter is not formatted correctly in the request, please check all the parameters in the API call.
        Errors:
          type: array
          description: List of individual field errors.
          items:
            type: object
            properties:
              FieldName:
                type: string
                description: Identifier for the record that caused the error.
                example: Record 1
              ErrorMessage:
                type: string
                description: Description of the specific error related to the field.
                example: Email address is already registered with your LoginRadius site
            required:
              - FieldName
              - ErrorMessage
    ConsentOptions:
      type: object
      properties:
        ConsentId:
          type: string
          description: Unique identifier for the consent option.
          example: d290f1ee6c544b90e6d701748f0851
        Title:
          type: string
          description: Title of the consent option.
          example: SMS Consent
        Description:
          type: string
          description: Description of the consent option.
          example: Consent to receive SMS notifications
        CreatedOn:
          type: string
          format: date-time
          description: Creation date of the consent option.
          example: '2023-01-01T00:00:00Z'
          nullable: true
        IsActive:
          type: boolean
          description: Indicates if the consent option is currently active.
          example: true
    ConsentOptionModel:
      type: object
      properties:
        Title:
          type: string
          description: Title of the consent option.
          example: SMS Consent
          maxLength: 150
        Description:
          type: string
          description: Description of the consent option.
          example: Consent to receive SMS notifications
          maxLength: 1000
    ConsentFormEvent:
      type: object
      properties:
        IsCustom:
          type: boolean
          description: Indicates if the event is custom.
          example: true
        Name:
          type: string
          description: Name of the event.
          example: Register
    ConsentFormOption:
      type: object
      properties:
        IsRequired:
          type: boolean
          description: Indicates if this consent option is required.
          example: true
        ConsentOptionId:
          type: string
          description: Unique identifier for the consent option.
          example: 123e4567e89b12d3a456426614174000
        IsActive:
          type: boolean
          description: Indicates if the consent option is active.
          example: true
    ConsentForm:
      type: object
      properties:
        IsActive:
          type: boolean
          description: Indicates if the consent form is active.
          example: true
        Version:
          type: integer
          format: int32
          description: Version number of the consent form.
          example: 1
        Events:
          type: array
          items:
            $ref: '#/components/schemas/ConsentFormEvent'
          description: List of events associated with the consent form.
        StartFromDate:
          type: string
          format: date-time
          nullable: true
          description: Start date of the consent form.
          example: '2023-01-01T00:00:00Z'
        CreatedOnDate:
          type: string
          format: date-time
          nullable: true
          description: Creation date of the consent form.
          example: '2023-01-01T00:00:00Z'
        ConsentOptions:
          type: array
          items:
            $ref: '#/components/schemas/ConsentFormOption'
          description: List of consent options in the form.
        TermOfService:
          type: string
          description: Terms of service text.
          example: I agree to the terms of service.
        PrivacyPolicy:
          type: string
          description: Privacy Policy text.
          example: I agree to the Privacy Policy.
        IsWorkflowForm:
          type: boolean
          description: Indicates if this is a workflow form.
          example: true
    ConsentFormOptions:
      type: object
      properties:
        IsRequired:
          type: boolean
          description: Indicates if this consent option is required.
          example: true
        ConsentOptionId:
          type: string
          description: Unique identifier for the consent option.
          example: 123e4567e89b12d3a456426614174000
    ConsentFormModel:
      type: object
      properties:
        Events:
          type: array
          items:
            type: string
          description: List of events associated with the consent form.
          example:
            - Register
            - Login
        StartFromDate:
          type: string
          format: date-time
          nullable: true
          description: Start date of the consent form.
          example: '2023-01-01T00:00:00Z'
        ConsentOptions:
          type: array
          items:
            $ref: '#/components/schemas/ConsentFormOptions'
          description: List of consent options in the form.
        TermOfService:
          type: string
          description: Terms of service text.
          example: I agree to the terms of service.
        PrivacyPolicy:
          type: string
          description: Privacy Policy text.
          example: I agree to the Privacy Policy.
        IsWorkflowForm:
          type: boolean
          description: Indicates if this is a workflow form.
          example: true
    BigCommerceLoginUrlResponse:
      type: object
      properties:
        loginUrl:
          type: string
          description: BigCommerce login URL for the customer.
          example: https://store-abc123.mybigcommerce.com/login/token/eyJhbGciOiJIUzI1NiJ9
    BigCommerceTokenPostRequest:
      type: object
      required:
        - access_token
      properties:
        access_token:
          type: string
          description: LoginRadius access token of the authenticated user.
          example: 1234567890abcdef1234567890abcdef
        password:
          type: string
          description: Optional password for BigCommerce customer creation.
        return_url:
          type: string
          description: URL to redirect the user to after login.
          example: https://example.com/dashboard
    BigCommerceValidatePasswordRequest:
      type: object
      required:
        - emailid
        - password
      properties:
        emailid:
          type: string
          description: Email address of the BigCommerce customer.
          example: user@example.com
        password:
          type: string
          description: Password to validate for the BigCommerce customer.
          example: MyPassword123
    BigCommerceValidatePasswordResponse:
      type: object
      properties:
        verified:
          type: boolean
          description: Whether the password is valid for the BigCommerce customer.
          example: true
    ShopifyLoginUrlResponse:
      type: object
      properties:
        url:
          type: string
          description: Shopify Multipass login URL for the customer.
          example: https://mystore.myshopify.com/account/login/multipass/v1/eyJhbGciOiJIUzI1NiJ9
    PerfectMindSessionResponse:
      type: object
      properties:
        SessionId:
          type: string
          description: PerfectMind session identifier.
          example: abc123-def456-ghi789
        URL:
          type: string
          description: PerfectMind login URL with the session.
          example: https://mysite.perfectmind.com/session/abc123
        IsNewLink:
          type: boolean
          description: Whether a new session link was generated.
          example: true
    PerfectMindContactResponse:
      type: object
      properties:
        Email:
          type: string
          description: Email address associated with the PerfectMind contact.
          example: user@example.com
        ContactId:
          type: array
          items:
            type: string
          description: List of PerfectMind contact IDs matching the email.
          example:
            - '12345'
            - '67890'
  examples:
    ResetPasswordByEmailAndOTP:
      summary: Reset using OTP and Email (QQ Captcha)
      value:
        otp: '123456'
        email: user@example.com
        Password: new_secure_password
        welcomeemailtemplate: welcome_template
        ResetPasswordEmailTemplate: reset_password_template
        SecurityAnswer:
          9d1f4208bda845d885eab43266d6543f: Buddy
        qq_captcha_ticket: qq-ticket-abc
        qq_captcha_randstr: qq-randstr-xyz
    ResetPasswordByUsernameAndOTP:
      summary: Reset using OTP and Username (hCaptcha)
      value:
        otp: '654321'
        username: user123
        Password: new_secure_password
        welcomeemailtemplate: welcome_template
        ResetPasswordEmailTemplate: reset_password_template
        SecurityAnswer:
          9d1f4208bda845d885eab43266d6543f: Delhi
        h-captcha-response: hcaptcha-token-999
    ResetPasswordByResetToken:
      summary: Reset using ResetToken (Google Recaptcha)
      value:
        ResetToken: xxxxxxxxxxxxxxxxxxxx
        Password: new_secure_password
        welcomeemailtemplate: welcome_template
        ResetPasswordEmailTemplate: reset_password_template
        SecurityAnswer:
          9d1f4208bda845d885eab43266d6543f: Fluffy
          9d1f4208bda845d885eab43266d65500: Blue
        g-recaptcha-response: google-captcha-token-123
    API_KEY_REQUIRED:
      summary: API_KEY_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The apikey is a required parameter.
    API_KEY_NOT_WELL_FORMATTED:
      summary: API_KEY_NOT_WELL_FORMATTED
      value:
        ErrorCode: 920
        Message: API key is invalid
        Description: The provided LoginRadius API key is invalid, please use a valid API key of your LoginRadius account.
    DANGEROUS_REQUEST:
      summary: DANGEROUS_REQUEST
      value:
        ErrorCode: 1214
        Message: Dangerous request
        Description: A potentially dangerous request value was detected.
    CONTENT_TYPE_INVALID:
      summary: CONTENT_TYPE_INVALID
      value:
        ErrorCode: 1083
        Message: This content type header is not supported
        Description: Please use a valid content type header as application/json.
    JSON_PUT_BODY_REQUIRED:
      summary: JSON_PUT_BODY_REQUIRED
      value:
        ErrorCode: 1079
        Message: Put body is invalid or empty
        Description: Please use a valid put body in JSON format in order to process this request.
    API_KEY_AND_RESET_TOKEN_REQUIRED:
      summary: API_KEY_AND_RESET_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The apikey is a required parameter,The resettoken is a required parameter.
    API_KEY_AND_PASSWORD_REQUIRED:
      summary: API_KEY_AND_PASSWORD_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The apikey is a required parameter,The password is a required parameter.
    PASSWORD_AND_RESET_TOKEN_REQUIRED:
      summary: PASSWORD_AND_RESET_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The password is a required parameter,The resettoken is a required parameter.
    RESET_TOKEN_REQUIRED:
      summary: RESET_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The resettoken is a required parameter.
    PASSWORD_REQUIRED:
      summary: PASSWORD_REQUIRED
      value:
        Message: Password is required
        ErrorCode: 908
        Description: The password is required in order to process this request.
    SERVER_SIDE_VALIDATION_ERROR:
      summary: SERVER_SIDE_VALIDATION_ERROR
      value:
        ErrorCode: 1134
        Message: Validation failed for one or more fields
        Description: Validation failed for one or more fields. Please check the errors field for more information.
    USERNAME_REQUIRED_PARAM:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The username is a required parameter. Please provide a valid username to process the request.
    OTP_REQUIRED:
      summary: OTP_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The OTP is a required parameter.
    EMAILID_ID_FORMAT_NOT_VALID:
      summary: EMAILID_ID_FORMAT_NOT_VALID
      value:
        ErrorCode: 1038
        Message: Valid email ID is required
        Description: The provided email ID is invalid or not well-formatted, a valid email ID is required in order to process this request.
    EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED:
      summary: EMAIL_PHONE_USERNAME_PAYLOAD_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email/username/phone is a required parameter.
    EMAIL_REQUIRED:
      summary: EMAIL_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email is a required parameter.
    GENERIC_AUTH_ERROR:
      summary: GENERIC_AUTH_ERROR
      value:
        errorCode: 1409
        message: Authentication failed
        description: The credentials provided could not be authenticated.
    API_KEY_NOT_VALID:
      summary: API_KEY_NOT_VALID
      value:
        ErrorCode: 901
        Message: The API key is unauthorized
        Description: The provided LoginRadius API key is invalid or is not authorized, please use a valid or authorized LoginRadius API key or check the API key for your LoginRadius account.
    TRIAL_PLAN_EXPIRED:
      summary: TRIAL_PLAN_EXPIRED
      value:
        ErrorCode: 6003
        Message: Trial plan expired
        Description: The trial plan has expired. To continue using the service, please contact support.
    RAAS_PROFILE_NOT_EXISTS:
      summary: RAAS_PROFILE_NOT_EXISTS
      value:
        ErrorCode: 1039
        Message: An email profile is not created or does not exist
        Description: An email profile is not created on this Account ID, please use a valid Account ID or create an email profile before processing this request.
    USER_ID_BLOCKED:
      summary: USER_ID_BLOCKED
      value:
        ErrorCode: 991
        Message: User ID is blocked
        Description: The user ID is blocked, please use a valid user ID in order to process this request.
    USER_ID_LOCKED_WITH_TIMEOUT:
      summary: USER_ID_LOCKED_WITH_TIMEOUT
      value:
        Data:
          LoginLockedTimeout: '2025-07-11T21:40:44.875Z'
        Description: Your account has been locked, please try again after sometime.
        ErrorCode: 1198
        Message: Your account has been locked
    LOGIN_IS_LOCKED_FOR_RECAPTCHA:
      summary: LOGIN_IS_LOCKED_FOR_RECAPTCHA
      value:
        ErrorCode: 1132
        Message: Your account has been locked
        Description: Your account has been locked, please login with a valid reCAPTCHA in order to continue.
    USER_ID_LOCKED:
      summary: USER_ID_LOCKED
      value:
        ErrorCode: 1198
        Message: Your account has been locked
        Description: Your account has been locked, please try again after sometime.
    LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
      summary: LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION
      value:
        ErrorCode: 1148
        Message: Your account has been locked
        Description: Your account has been locked, please login with an answer to the security question in order to continue.
    SECURITY_QUESTION_NOT_VALID:
      summary: SECURITY_QUESTION_NOT_VALID
      value:
        ErrorCode: 1091
        Message: Security question is invalid
        Description: This security question is invalid, please use a correct or valid security question.
    SECURITY_QUESTION_OR_ANSWER_INVALID:
      summary: SECURITY_QUESTION_OR_ANSWER_INVALID
      value:
        ErrorCode: 1094
        Message: Your security answer or question is incorrect.
        Description: Your security question or answer is incorrect, please enter the correct security question or answer.
    SECURITY_ANSWER_INVALID:
      summary: SECURITY_ANSWER_INVALID
      value:
        ErrorCode: 1093
        Message: Security answer is invalid
        Description: The security answer is invalid, please use a valid security answer in order to process this request.
    VERIFICATION_OTP_NOT_VALID:
      summary: VERIFICATION_OTP_NOT_VALID
      value:
        ErrorCode: 1185
        Message: Verification OTP is invalid
        Description: The LoginRadius verification OTP is invalid, please use a valid verification OTP in order to process this request.
    VERIFICATION_VTOKEN_NOT_VALID:
      summary: VERIFICATION_VTOKEN_NOT_VALID
      value:
        ErrorCode: 1063
        Message: Verification token (vtoken) is invalid
        Description: The LoginRadius verification token is invalid, please use a valid verification token in order to process this request.
    LINK_EXPIRED:
      summary: LINK_EXPIRED
      value:
        ErrorCode: 975
        Message: Your verification link or otp has expired
        Description: This verification link or otp has expired, please request for new verification link or otp.
    LINK_ALREADY_VERIFIED:
      summary: LINK_ALREADY_VERIFIED
      value:
        ErrorCode: 974
        Message: The email verification link has already been used
        Description: Each link can only be used once, you can log in now if you have already verified the email, OR use the ‘forgot password’ option.
    USER_NOT_EXISTS:
      summary: USER_NOT_EXISTS
      value:
        ErrorCode: 938
        Message: User does not exist
        Description: The user does not exist, please use a valid user in order to process this request.
    WEAK_PASSWORD:
      value:
        ErrorCode: 1216
        Message: Weak password
        Description: A potential password vulnerability was detected.
    PASSWORD_IN_HISTORY:
      summary: PASSWORD_IN_HISTORY
      value:
        ErrorCode: 1015
        Message: The new password is invalid
        Description: Your new password is too similar to your old passwords, please try a different password.
    BREACHED_PASSWORD:
      summary: BREACHED_PASSWORD
      value:
        ErrorCode: 1315
        Message: The password you’re trying to set is exposed in an external data breach.
        Description: The specific password you’re setting is found in a data breach unrelated to this app/service. Please set a different password.
    ACTIVE_SESSIONS_EXCEEDED:
      summary: ACTIVE_SESSIONS_EXCEEDED
      value:
        ErrorCode: 1338
        Message: Exceeded active login session limit
        Description: You have exceeded the maximum number of allowed active login sessions. Please log out of any other active session before attempting to log in again. If you need further assistance, contact support.
    PRIVACY_POLICY_MISMATCHED:
      summary: PRIVACY_POLICY_MISMATCHED
      value:
        Data:
          access_token: 6******2-3**8-4**5-8**d-3**********9
          expires_in: 300
          refresh_token: 6******2-3**8-4**5-8**d-3**********9
        Description: You have not accepted the current Privacy Policy.
        ErrorCode: 1194
        Message: Privacy Policy does not match
    POST_BODY_INVALID:
      summary: POST_BODY_INVALID
      value:
        ErrorCode: 965
        Message: The post body is invalid
        Description: Please use a valid post body and make sure that it is in a valid JSON format.
    USERNAME_REQUIRED:
      summary: USERNAME_REQUIRED
      value:
        ErrorCode: 1075
        Message: Username is required
        Description: The username is required in order to process this request.
    EMAIL_ID_OR_USER_REQUIRED:
      summary: EMAIL_ID_OR_USER_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email/username is a required parameter.
    CAPTCHA_NOT_VALID:
      summary: CAPTCHA_NOT_VALID
      value:
        errorcode: 982
        message: Captcha is not valid
        description: The captcha is not valid, please use a valid captcha in order to process this request.
    RESET_PASSWORD_URL_INVALID:
      summary: RESET_PASSWORD_URL_INVALID
      value:
        ErrorCode: 1252
        Message: Reset password URL is invalid
        Description: The reset password URL is invalid, please use a valid reset password URL in order to process this request.
    EMAIL_SEND_LIMIT_REACHED:
      value:
        Description: The account limit for email requests for this resource has been reached for this time due to too many request.
        ErrorCode: 1122
        Message: You have reached a limit for sending emails
    ACCESS_TOKEN_REQUIRED:
      summary: ACCESS_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The access_token is a required parameter.
    OAUTH_TOKEN_CONFIG_NOT_FOUND:
      summary: OAUTH_TOKEN_CONFIG_NOT_FOUND
      value:
        Description: Unable to retrieve token configuration for the specified app.
        ErrorCode: 2017
        Message: Request is invalid
    OLD_PASSWORD_REQUIRED:
      summary: OLD_PASSWORD_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The oldpassword is a required parameter.
    NEW_PASSWORD_REQUIRED:
      summary: NEW_PASSWORD_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The newpassword is a required parameter.
    INVALID_PASSWORD:
      summary: INVALID_PASSWORD
      value:
        ErrorCode: 967
        Message: Current password is invalid
        Description: Your current password is invalid, please use the correct password.
    ACCESS_TOKEN_NOT_VALID:
      summary: ACCESS_TOKEN_NOT_VALID
      value:
        ErrorCode: 905
        Message: Access token is invalid
        Description: The LoginRadius access token is invalid, please use the correct or valid access token in order to process this request.
    ACCESS_TOKEN_EXPIRED:
      summary: ACCESS_TOKEN_EXPIRED
      value:
        ErrorCode: 906
        Message: Access token has expired
        Description: The LoginRadius access token has expired, please request a new token from LoginRadius API.
    PHONE_REQUIRED:
      summary: PHONE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The Phone is a required parameter.
    INVALID_PHONE_NUMBER:
      summary: INVALID_PHONE_NUMBER
      value:
        ErrorCode: 1096
        Message: Invalid phone number.
        Description: The provided phone number is not valid or not well-formatted, please review the phone number in order to process this request.
    PHONE_NO_LOGIN_NOT_ENABLED:
      summary: PHONE_NO_LOGIN_NOT_ENABLED
      value:
        ErrorCode: 1074
        Message: Phone number login is not enabled
        Description: The phone number login is not enabled, please enable the phone number login in order to process this request.
    OTP_NOT_EXISTS:
      summary: OTP_NOT_EXISTS
      value:
        ErrorCode: 1067
        Message: Invalid OTP Code
        Description: The OTP code is invalid, please request for a new OTP.
    OTP_INVALID:
      summary: OTP_INVALID
      value:
        ErrorCode: 1070
        Message: The OTP cannot be accessed
        Description: This OTP is either expired or has already been used, please request for a new OTP.
    OTP_ALREADY_USED:
      summary: OTP_ALREADY_USED
      value:
        ErrorCode: 1068
        Message: The OTP has already been used
        Description: Each OTP can only be used once, you can now login if you have already verified the phone number.
    OTP_EXPIRED:
      summary: OTP_EXPIRED
      value:
        ErrorCode: 1069
        Message: Verification OTP has expired
        Description: This verification OTP has expired, please use ‘resend OTP’ option to verify your phone number.
    SMS_CONFIGURATION_NOT_EXISTS:
      summary: SMS_CONFIGURATION_NOT_EXISTS
      value:
        ErrorCode: 1071
        Message: SMS configuration does not exist
        Description: The SMS configuration does not exist, please use a valid SMS configuration in order to process this request.
    SMS_SEND_LIMIT_REACHED:
      summary: SMS_SEND_LIMIT_REACHED
      value:
        ErrorCode: 1123
        Message: You have reached a limit for sending SMS
        Description: The account limit for SMS requests for this resource has been reached for this time due to too many request.
    OTP_SEND_FAILED:
      summary: OTP_SEND_FAILED
      value:
        Description: The Verification OTP Code sending failed, please try again.
        ErrorCode: 1072
        Message: The Verification code (OTP) send failed
    OPERATION_FAILED:
      summary: OPERATION_FAILED
      value:
        ErrorCode: 950
        Message: Operation failed due to an unknown error
        Description: An unknown error has occurred, please try again in a few minutes or contact your system admin.
    VOICE_SMS_CONFIGURATION_NOT_ENABLED:
      summary: VOICE_SMS_CONFIGURATION_NOT_ENABLED
      value:
        ErrorCode: 1281
        Message: Voice OTP has not been configured
        Description: The Voice OTP has not been configured, please configure it.
    OTP_LIMIT_REACHED:
      summary: OTP_LIMIT_REACHED
      value:
        ErrorCode: 1179
        Message: You have reached a limit for generating OTP
        Description: The limit for generating OTP for this resource has been reached. The limit will auto reset upon reaching the configured request disabled period.
    ResetPasswordBySecurityAnswerAndEmail:
      summary: Reset Password By Security Answer and Email Example
      value:
        SecurityAnswer:
          9d1f4208bda845d885eab43266d6543f: Smith
        ResetPasswordEmailTemplate: reset-password-template
        password: MySecureP@ssw0rd
        Email: user@example.com
    ResetPasswordBySecurityAnswerAndPhone:
      summary: Reset Password By Security Answer and Phone Example
      value:
        SecurityAnswer:
          9d1f4208bda845d885eab43266d6543f: Smith
        ResetPasswordEmailTemplate: reset-password-template
        password: MySecureP@ssw0rd
        Phone: '+919876543210'
    ResetPasswordBySecurityAnswerAndUserId:
      summary: Reset Password By Security Answer and UserId Example
      value:
        SecurityAnswer:
          9d1f4208bda845d885eab43266d6543f: Smith
        ResetPasswordEmailTemplate: reset-password-template
        password: MySecureP@ssw0rd
        userid: john_doe
    ResetPasswordBySecurityAnswerAndUsername:
      summary: Reset Password By Security Answer and Username Example
      value:
        SecurityAnswer:
          9d1f4208bda845d885eab43266d6543f: Smith
        ResetPasswordEmailTemplate: reset-password-template
        password: MySecureP@ssw0rd
        UserName: john_doe
    SECUREITY_ANSWER_REQUIRED_VALIDATION:
      summary: SECUREITY_ANSWER_REQUIRED_VALIDATION
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of secuityanswer can not be null or empty.
    PASSWORD_REQUIRED_VALIDATION:
      summary: PASSWORD_REQUIRED_VALIDATION
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of password can not be null or empty.
    SECURITY_QUESTION_OR_ANSWER_NOT_ENABLED:
      value:
        ErrorCode: 1095
        Message: Security question or answer is not enabled
        Description: The security question or answer is not enabled. Please enable the security question or answer.
    SECURITY_QUESTION_NOT_SAVED_IN_PROFILE:
      summary: SECURITY_QUESTION_NOT_SAVED_IN_PROFILE
      value:
        ErrorCode: 1092
        Message: Security question and answer is not saved in profile
        Description: This security question and answer is not saved in your profile, please update the security question and answer in profile.
    EMAIL_ALLREADY_VERIFIED:
      summary: EMAIL_ALLREADY_VERIFIED
      value:
        ErrorCode: 1025
        Message: This email address is already verified
        Description: This email address has already been confirmed, so you cannot resend the verification email.
    EMAILID_VERIFICATION_DISABLE:
      summary: EMAILID_VERIFICATION_DISABLE
      value:
        ErrorCode: 1034
        Message: Verification emails cannot be sent, as the email verification option is disabled for your site
        Description: The email address verification option is disabled for your site, please enable it before sending any verification emails.
    VERIFICATION_URL_IS_NOT_VALID:
      summary: VERIFICATION_URL_IS_NOT_VALID
      value:
        ErrorCode: 1249
        Message: The VerificationUrl URL is invalid
        Description: The VerificationUrl is invalid, please reach out to LoginRadius support for more information.
    SOTT_REQUIRED:
      summary: SOTT_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The sott is a required parameter.
    PHONE_REQUIRED_PARAM:
      summary: PHONE_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The PhoneId is a required parameter.
    PHONE_OR_EMAIL_REQUIRED_PARAM:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email/phone number is a required parameter. Please provide a valid email or phone number to process the request.
    EMAIL_REQUIRED_PARAM:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email is a required parameter. Please provide a valid email to process the request.
    EMAIL_PHONE_REQUIRED_PARAM:
      summary: EMAIL_PHONE_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email is a required parameter,The PhoneId is a required parameter.
    USERNAME_EMAIL_REQUIRED_PARAM:
      summary: USERNAME_EMAIL_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The username is a required parameter,The email is a required parameter.
    EMAIL_TYPE_REQUIRED:
      summary: EMAIL_TYPE_REQUIRED
      value:
        ErrorCode: 1201
        Message: Email type is required
        Description: The email type is required in order to process this request.
    GENDER_INVALID:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of gender is invalid. Please use a valid value of gender to process the request.
    BIRTH_DATE_INVALID:
      summary: BIRTH_DATE_INVALID
      value:
        ErrorCode: 968
        Message: The date is invalid or has an invalid format
        Description: The provided birth date either is in the future or has an invalid format. Please use a valid date and date format (mm/dd/yyyy).
    ADDRESS_TYPE_REQUIRED:
      summary: ADDRESS_TYPE_REQUIRED
      value:
        ErrorCode: 1125
        Message: Address type is required
        Description: The request couldn't be processed. The address type must be specified in the address.
    PARAMETER_NOT_FORMATTED:
      summary: PARAMETER_NOT_FORMATTED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly.
        Description: A parameter is not formatted correctly in the request, please check all the parameters in the API call
    ADDRESS_TYPE_CAN_NOT_BE_SAME:
      summary: ADDRESS_TYPE_CAN_NOT_BE_SAME
      value:
        ErrorCode: 1107
        Message: Address type can not be same
        Description: Please use different address types in the case of multiple addresses.
    EMAIL_ID_CAN_NOT_BE_SAME:
      value:
        ErrorCode: 1202
        Message: Email address can not be same
        Description: Please use different email addresses in the case of multiple email addresses.
    PRIMARY_EMAIL_CAN_BE_ONLY_ONE:
      value:
        ErrorCode: 1203
        Message: Primary email address can be only one
        Description: The primary email address can be only one.
    INVITATION_TOKEN_INVALID:
      summary: INVITATION_TOKEN_INVALID
      value:
        ErrorCode: 8173
        Message: Invitation token is not valid.
        Description: Invitation token is not valid, this invitation either accepted, expired or revoked.
    EMAIL_VALUE_REQUIRED_PARAM:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value is a required parameter. Please ensure it is provided and correctly formatted.
    INVALID_INVITATION_ID_ACCEPTED:
      summary: INVALID_INVITATION_ID_ACCEPTED
      value:
        ErrorCode: 8175
        Message: The invitation id/token is invalid
        Description: This invitation id/token is accepted. Please enter a valid invitation id/token.
    INVALID_INVITATION_ID_EXPIRED:
      summary: INVALID_INVITATION_ID_EXPIRED
      value:
        ErrorCode: 8175
        Message: The invitation id/token is invalid
        Description: This invitation id/token is expired. Please enter a valid invitation id/token.
    INVALID_INVITATION_ID_REVOKED:
      summary: INVALID_INVITATION_ID_REVOKED
      value:
        ErrorCode: 8175
        Message: The invitation id/token is invalid
        Description: This invitation id/token is revoked. Please enter a valid invitation id/token.
    TRIAL_PLAN_USER_LIMIT_REACHED:
      summary: TRIAL_PLAN_USER_LIMIT_REACHED
      value:
        ErrorCode: 6004
        Message: User creation limit reached for the trial plan
        Description: The trial plan user creation limit has been reached. Upgrade your plan to add more users.
    SECURED_ONE_TIME_TOKEN_IS_INVALID:
      summary: SECURED_ONE_TIME_TOKEN_IS_INVALID
      value:
        ErrorCode: 1049
        Message: Secured one-time token (SOTT) is invalid
        Description: Secured one-time token (SOTT) is invalid, please use a valid secure one-time token (SOTT) in order to process this request.
    ORGANIZATION_NOT_ACTIVE:
      summary: ORGANIZATION_NOT_ACTIVE
      value:
        ErrorCode: 8180
        Message: Organization is not active
        Description: Organization is not active, Please provide valid organization id.
    TRADITIONAL_REGISTRATION_DISABLED:
      summary: TRADITIONAL_REGISTRATION_DISABLED
      value:
        ErrorCode: 1190
        Message: Traditional registration is disabled
        Description: The traditional registration is disabled, please enable the traditional registration in order to process this request.
    CUSTOM_FIELD_NOT_VALID:
      summary: CUSTOM_FIELD_NOT_VALID
      value:
        ErrorCode: 993
        Message: Custom field is invalid
        Description: This custom field is invalid. Please use a correct or valid custom field.
    EMAILID_ALREADY_REGISTERED:
      summary: EMAILID_ALREADY_REGISTERED
      value:
        ErrorCode: 936
        Message: Email ID is already registered
        Description: The provided email ID is already registered, please use a different email ID.
    EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT:
      summary: EMAILID_ALREADY_REGISTERED_WITH_SOCIAL_ACCOUNT
      value:
        ErrorCode: 1030
        Message: This email address cannot be registered, as it is already registered under a social account
        Description: An account already exists with this email address. If you've forgotten which social provider you have previously registered under, please use the forgot user ID or social provider link.
    EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER:
      summary: EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER
      value:
        ErrorCode: 1247
        Message: Email id domain is not allowed to register
        Description: The provided Email ID domain is not allowed to register, please use a different email ID.
    THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER:
      summary: THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER
      value:
        ErrorCode: 1056
        Message: This email ID is not allowed to register
        Description: The email ID you are trying to register with is not allowed.
    ACCOUNT_NOT_ALLOWED_TO_LOGIN:
      summary: ACCOUNT_NOT_ALLOWED_TO_LOGIN
      value:
        ErrorCode: 1220
        Message: Account is not allowed to login
        Description: The account is not allowed to login, please use a valid account in order to process this request.
    PIN_REQUIRED:
      value:
        ErrorCode: 1234
        Message: PIN is required.
        Description: The PIN is a required field. Please provide a valid PIN.
    CONSENT_FORM_NOT_SUBMITTED:
      summary: CONSENT_FORM_NOT_SUBMITTED
      value:
        Data:
          ConsentProfile:
            AcceptedConsentVersions:
              - Event: FirstLogin
                IsCustom: false
                Version: 1
            Consents:
              Options:
                - ConsentOptionId: 123e4567e89b12d3a456426614174000
          ConsentToken: 6******2-3**8-4**5-8**d-3**********9
          Events:
            - IsCustom: false
              Name: Login
        Description: Consent form not submitted, please accept the consent form.
        ErrorCode: 1226
        Message: Consent form not submitted.
    CONSENT_FORM_VALIDATION_FAILED:
      value:
        Description: Consent form validation failed.
        ErrorCode: 1225
        Message: Consent form validation failed
    PRIVACY_POLICY_NOT_ACCEPTED:
      value:
        ErrorCode: 1196
        Message: Privacy Policy is not accepted
        Description: Privacy Policy must be accepted for registration.
    AGE_UNDERAGE:
      summary: AGE_UNDERAGE
      value:
        ErrorCode: 1163
        Message: You are not eligible for registration
        Description: You are not eligible for registration, your age must be above specified by admin of this site.
    PHONE_NO_ALREADY_REGISTERED:
      summary: PHONE_NO_ALREADY_REGISTERED
      value:
        ErrorCode: 1058
        Message: Phone number is already registered with your LoginRadius site
        Description: The phone number has to be unique for your LoginRadius site, please use a different phone number.
    USERNAME_ALREADY_REGISTERED:
      summary: USERNAME_ALREADY_REGISTERED
      value:
        ErrorCode: 1017
        Message: This username is already registered with this website
        Description: The username you have selected is already in use, please choose a different username.
    INVITATION_NOT_FOUND:
      summary: INVITATION_NOT_FOUND
      value:
        ErrorCode: 8169
        Message: Invitation not found
        Description: Invitation not found, Please provide valid invitation id.
    ORGANIZATION_NOT_FOUND:
      summary: ORGANIZATION_NOT_FOUND
      value:
        ErrorCode: 1026
        Message: Organization not found
        Description: The organization not found, please use a valid organization in order to process this request.
    ROLE_DOES_NOT_EXISTS_PARTNER:
      summary: ROLE_DOES_NOT_EXISTS_PARTNER
      value:
        ErrorCode: 8125
        Message: Role does not exist
        Description: Role does not exist, Please provide valid Role id.
    OPERATION_FAILED_PARTNER:
      summary: OPERATION_FAILED_PARTNER
      value:
        Message: Operation failed due to an internal error.
        Description: An unknown internal error occurred, please try again in a few minutes or contact your system administrator.
        ErrorCode: 7909
    PASSKEY_NOT_ENABLED_IN_APP:
      summary: PASSKEY_NOT_ENABLED_IN_APP
      value:
        ErrorCode: 1320
        Message: Passkeys not enabled in this application.
        Description: Please enable passkeys in the admin console to allow users to log in with passkeys.
    PASSKEY_CONFIG_INVALID:
      summary: PASSKEY_CONFIG_INVALID
      value:
        ErrorCode: 1322
        Message: Passkey configuration is invalid
        Description: The pass key configuration is invalid, please use a valid pass key configuration in order to process this request.
    PASSKEY_VERIFICATION_FAILED:
      summary: PASSKEY_VERIFICATION_FAILED
      value:
        ErrorCode: 1321
        Message: Passkey verification failed
        Description: The pass key verification failed, please use a valid pass key in order to process this request.
    EMAIL_TYPE_REQUIRED_PARAM:
      summary: EMAIL_TYPE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The type is a required parameter.
    PASS_KEY_CREDENTIAL_REQUIRED:
      summary: PASS_KEY_CREDENTIAL_REQUIRED
      value:
        Message: Pass key credential is required
        ErrorCode: 908
        Description: The pass key credential is required in order to process this request.
    LoginByEmailRequest:
      summary: LoginByEmailRequest
      description: Login by email payload where email,password is required. securityanswer should be passed if the user is blocked by security question.
      value:
        email: john.doe@example.com
        password: password123
        securityanswer:
          db7****8a73e4******bd9****8c20: Answer
    LoginByUserNameRequest:
      summary: LoginByUsernameRequest
      description: Login by username payload where username,password is required. securityanswer should be passed if the user is blocked by security question.
      value:
        username: johndoe
        password: password123
        securityAnswer:
          db7****8a73e4******bd9****8c20: Answer
    LoginByPhoneRequest:
      summary: LoginByPhone
      description: Login by phone payload where phone,password is required. securityanswer should be passed if the user is blocked by security question.
      value:
        phone: '+1234567890'
        password: password123
        securityAnswer:
          db7****8a73e4******bd9****8c20: Answer
    DUO_REDIRECT_URI_REQUIRED:
      summary: DUO_REDIRECT_URI_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The duo redirect uri is a required parameter.
    USERNAME_PASSWORD_REQUIRED:
      summary: USERNAME_PASSWORD_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The username is a required parameter,The password is a required parameter.
    PHONE_OR_EMAIL_OR_USER_REQUIRED_PARAM:
      summary: PHONE_OR_EMAIL_OR_USER_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email/username/phone is a required parameter
    PHONE_OR_EMAIL_OR_USER_REQUIRED_PASSWORD_REQUIRED_PARAM:
      summary: PHONE_OR_EMAIL_OR_USER_REQUIRED_PASSWORD_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email/username/phone is a required parameter,The password is a required parameter.
    USERNAME_OR_PASSWORD_WRONG:
      summary: USERNAME_OR_PASSWORD_WRONG
      value:
        ErrorCode: 966
        Message: Username or password is wrong
        Description: The username or password is wrong, please use a valid username or password in order to process this request.
    USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT:
      summary: USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT
      value:
        Description: You have {count} tries left before your account gets suspended.
        ErrorCode: 966
        Message: Invalid user ID and/or password
    USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT:
      summary: USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT
      value:
        Description: You have {count} tries left before your account gets blocked.
        ErrorCode: 966
        Message: Invalid user ID and/or password
    USER_NAME_AUTHENTICATION_ENABLED:
      summary: USER_NAME_AUTHENTICATION_ENABLED
      value:
        ErrorCode: 1183
        Message: UserName authentication is enabled
        Description: You can't login from email/phone, please use username for login.
    LOGIN_WITH_PASSWORD_NOT_ENABLED:
      summary: LOGIN_WITH_PASSWORD_NOT_ENABLED
      value:
        ErrorCode: 1023
        Message: Login with password is not enabled
        Description: The login with password is not enabled, please enable the login with password in order to process this request.
    APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT:
      summary: APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT
      value:
        ErrorCode: 909
        Message: Your LoginRadius site does not have permission to access this endpoint
        Description: Your LoginRadius site does not have permission to access this endpoint, please contact LoginRadius support for more information.
    LOGIN_DISABLED:
      summary: LOGIN_DISABLED
      value:
        ErrorCode: 1130
        Message: Login services have been disabled for your account
        Description: Login services have been disabled for your account, please contact the admin or site owner.
    BREACHED_PASSWORD_LOGIN:
      summary: BREACHED_PASSWORD_LOGIN
      value:
        ErrorCode: 1316
        Message: Your password is exposed in an external data breach.
        Description: Your password is found in a data breach unrelated to this app/service. Please reset your password using the email we sent you.
    EMAIL_NOT_VERIFIED:
      summary: EMAIL_NOT_VERIFIED
      value:
        ErrorCode: 970
        Message: Email is not verified
        Description: The email is not verified, please verify the email in order to process this request.
    PHONE_NOT_VERIFIED:
      summary: PHONE_NOT_VERIFIED
      value:
        ErrorCode: 1066
        Message: Phone is not verified
        Description: The phone is not verified, please verify the phone in order to process this request.
    EMAIL_OR_PHONE_NUMBER_REQUIRED_VERIFIED:
      summary: EMAIL_OR_PHONE_NUMBER_REQUIRED_VERIFIED
      value:
        ErrorCode: 1287
        Message: Email or phone number is required and verified
        Description: The email or phone number is required and verified in order to process this request.
    RBA_ACCOUNT_IS_BLOCKED_BY_BROWSER_RISK:
      value:
        Description: Your account has been blocked by the system admin, please contact the admin for more information.
        ErrorCode: 1164
        ExtraInfo:
          - Description: Login attempt from a new browser is detected.
            ErrorCode: 1168
            Message: Login attempt from a new browser is detected
        Message: Your account has been blocked due to suspicious activity
    RBA_ACCOUNT_IS_BLOCKED_BY_CITY_RISK:
      value:
        Description: Your account has been blocked by the system admin, please contact the admin for more information.
        ErrorCode: 1164
        ExtraInfo:
          - Description: Login attempt from a new city is detected.
            ErrorCode: 1169
            Message: Login attempt from a new city is detected
        Message: Your account has been blocked due to suspicious activity
    RBA_ACCOUNT_IS_BLOCKED_BY_COUNTRY_RISK:
      value:
        Description: Your account has been blocked by the system admin, please contact the admin for more information.
        ErrorCode: 1164
        ExtraInfo:
          - Description: Login attempt from a new country is detected.
            ErrorCode: 1170
            Message: Login attempt from a new country is detected
        Message: Your account has been blocked due to suspicious activity
    RBA_ACCOUNT_IS_BLOCKED_BY_DEVICE_RISK:
      value:
        Description: Your account has been blocked by the system admin, please contact the admin for more information.
        ErrorCode: 1164
        ExtraInfo:
          - Description: Login attempt from a new device is detected.
            ErrorCode: 1301
            Message: Login attempt from a new device is detected
        Message: Your account has been blocked due to suspicious activity
    RBA_ACCOUNT_IS_BLOCKED_BY_IP_RISK:
      value:
        Description: Your account has been blocked by the system admin, please contact the admin for more information.
        ErrorCode: 1164
        ExtraInfo:
          - Description: Login attempt from a new ip is detected.
            ErrorCode: 1171
            Message: Login attempt from a new ip is detected
        Message: Your account has been blocked due to suspicious activity
    RBA_EMAIL_VERIFICATION_BY_BROWSER_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your email to secure your account.
        ErrorCode: 1166
        ExtraInfo:
          - Description: Login attempt from a new browser is detected.
            ErrorCode: 1168
            Message: Login attempt from a new browser is detected
        Message: A verification code has been sent to your email
    RBA_EMAIL_VERIFICATION_BY_CITY_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your email to secure your account.
        ErrorCode: 1166
        ExtraInfo:
          - Description: Login attempt from a new city is detected.
            ErrorCode: 1169
            Message: Login attempt from a new city is detected
        Message: A verification code has been sent to your email
    RBA_EMAIL_VERIFICATION_BY_COUNTRY_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your email to secure your account.
        ErrorCode: 1166
        ExtraInfo:
          - Description: Login attempt from a new country is detected.
            ErrorCode: 1170
            Message: Login attempt from a new country is detected
        Message: A verification code has been sent to your email
    RBA_EMAIL_VERIFICATION_BY_DEVICE_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your email to secure your account.
        ErrorCode: 1166
        ExtraInfo:
          - Description: Login attempt from a new device is detected.
            ErrorCode: 1301
            Message: Login attempt from a new device is detected
        Message: A verification code has been sent to your email
    RBA_EMAIL_VERIFICATION_BY_IP_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your email to secure your account.
        ErrorCode: 1166
        ExtraInfo:
          - Description: Login attempt from a new ip is detected.
            ErrorCode: 1171
            Message: Login attempt from a new ip is detected
        Message: A verification code has been sent to your email
    RBA_SECURITY_ANSWER_VERIFICATION_BY_BROWSER_RISK:
      value:
        Description: We have identified a suspicious activity with your account, please answer the security question's to secure your account.
        ErrorCode: 1165
        ExtraInfo:
          - Description: Login attempt from a new browser is detected.
            ErrorCode: 1168
            Message: Login attempt from a new browser is detected
        Message: Please answer the security question's to secure your account
    RBA_SECURITY_ANSWER_VERIFICATION_BY_CITY_RISK:
      value:
        Description: We have identified a suspicious activity with your account, please answer the security question's to secure your account.
        ErrorCode: 1165
        ExtraInfo:
          - Description: Login attempt from a new city is detected.
            ErrorCode: 1169
            Message: Login attempt from a new city is detected
        Message: Please answer the security question's to secure your account
    RBA_SECURITY_ANSWER_VERIFICATION_BY_COUNTRY_RISK:
      value:
        Description: We have identified a suspicious activity with your account, please answer the security question's to secure your account.
        ErrorCode: 1165
        ExtraInfo:
          - Description: Login attempt from a new country is detected.
            ErrorCode: 1170
            Message: Login attempt from a new country is detected
        Message: Please answer the security question's to secure your account
    RBA_SECURITY_ANSWER_VERIFICATION_BY_DEVICE_RISK:
      value:
        Description: We have identified a suspicious activity with your account, please answer the security question's to secure your account.
        ErrorCode: 1165
        ExtraInfo:
          - Description: Login attempt from a new device is detected.
            ErrorCode: 1301
            Message: Login attempt from a new device is detected
        Message: Please answer the security question's to secure your account
    RBA_SMS_VERIFICATION_BY_BROWSER_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your phone to secure your account.
        ErrorCode: 1167
        ExtraInfo:
          - Description: Login attempt from a new browser is detected.
            ErrorCode: 1168
            Message: Login attempt from a new browser is detected
        Message: A verification code has been sent to you phone
    RBA_SMS_VERIFICATION_BY_CITY_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your phone to secure your account.
        ErrorCode: 1167
        ExtraInfo:
          - Description: Login attempt from a new city is detected.
            ErrorCode: 1169
            Message: Login attempt from a new city is detected
        Message: A verification code has been sent to you phone
    RBA_SMS_VERIFICATION_BY_COUNTRY_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your phone to secure your account.
        ErrorCode: 1167
        ExtraInfo:
          - Description: Login attempt from a new country is detected.
            ErrorCode: 1170
            Message: Login attempt from a new country is detected
        Message: A verification code has been sent to you phone
    RBA_SMS_VERIFICATION_BY_DEVICE_RISK:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your phone to secure your account.
        ErrorCode: 1167
        ExtraInfo:
          - Description: Login attempt from a new device is detected.
            ErrorCode: 1301
            Message: Login attempt from a new device is detected
        Message: A verification code has been sent to you phone
    RBA_SMS_VERIFICATION_BY_IP_RISK:
      value:
        Description: We have identified a suspicious activity with your account, please answer the security question's to secure your account.
        ErrorCode: 1165
        ExtraInfo:
          - Description: Login attempt from a new ip is detected.
            ErrorCode: 1171
            Message: Login attempt from a new ip is detected
        Message: Please answer the security question's to secure your account
    PIN_IS_REQUIRED:
      summary: PIN_IS_REQUIRED
      value:
        Data:
          PINAuthToken: 6******2-3**8-4**5-8**d-3**********9
        Description: The PIN is required and needs to be set, please set PIN in the profile for login.
        ErrorCode: 1243
        Message: PIN is required
    TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD:
      summary: TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD
      value:
        ErrorCode: 1098
        Message: Two factor authentication client is not configured
        Description: The Google two factor authentication client is not enabled, please configure or enable at least one two factor authentication client on your profile for login.
    SOMETHING_GOING_WRONG:
      summary: SOMETHING_GOING_WRONG
      value:
        ErrorCode: 2030
        Message: Oops, something went wrong, please try again.
        Description: Oops, something went wrong, please try again.
    TWO_FACTOR_AUTHENTICATION_PUSH_CONFIG_INVALID:
      summary: TWO_FACTOR_AUTHENTICATION_PUSH_CONFIG_INVALID
      value:
        ErrorCode: 1298
        Message: Push Notification configuration error
        Description: There appears to be a problem with the settings for using push notifications as a two-factor authentication method. Please review your configuration to ensure it's valid.
    TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID:
      summary: TWO_FACTOR_AUTHENTICATION_DUO_AUTH_CONFIG_INVALID
      value:
        ErrorCode: 1331
        Message: Duo Authenticator configuration error
        Description: It appears to be a configuration issue with Duo Authenticator for two-factor authentication. Please review your configuration to ensure it is valid.
    EMAIL_ID_NOT_EXISTS:
      value:
        ErrorCode: 1023
        Message: Email address does not exist
        Description: The provided email address does not exist. Please use a valid email address.
    DUO_AUTHENTICATOR_REDIRECT_URI_INVALID:
      summary: DUO_AUTHENTICATOR_REDIRECT_URI_INVALID
      value:
        ErrorCode: 1336
        Message: Duo Authenticator redirect URI is invalid
        Description: Duo Authenticator redirect URI is invalid, Please provide the valid Duo Authenticator redirect URI.
    DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED:
      summary: DUO_AUTHENTICATOR_REDIRECT_URI_NOT_WHITELISTED
      value:
        ErrorCode: 1335
        Message: Duo Authenticator redirect URI is not whitelisted
        Description: Please whitelist the Duo Authenticator redirect URI or reach out to support.
    VERIFICATION_TOKEN_REQUIRED:
      summary: VERIFICATION_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The verificationtoken is a required parameter.
    EMAIL_UUID_OTP_REQUIRED:
      summary: EMAIL_UUID_OTP_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The otp is a required parameter,The email or uuid is a required parameter.
    EMAIL_UUID_REQUIRED:
      summary: EMAIL_UUID_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email or uuid is a required parameter.
    VERIFICATION_LINK_INVALID:
      summary: VERIFICATION_LINK_INVALID
      value:
        ErrorCode: 973
        Message: Invalid email verification link
        Description: The email verification link is invalid, please request a new link.
    EMAIL_OTP_NOT_EXISTS:
      summary: EMAIL_OTP_NOT_EXISTS
      value:
        ErrorCode: 1188
        Message: Invalid email verification OTP
        Description: The email verification OTP is invalid, please request a new OTP.
    EMAIL_OTP_ALREADY_USED:
      summary: EMAIL_OTP_ALREADY_USED
      value:
        ErrorCode: 1186
        Message: The email verification OTP has already been used
        Description: Each OTP can only be used once, you can log in now if you have already verified the email, OR use the ‘forgot password’ option.
    EMAIL_OTP_EXPIRED:
      summary: EMAIL_OTP_EXPIRED
      value:
        ErrorCode: 1187
        Message: Email Verification OTP has expired
        Description: This email verification OTP has expired, please use the ‘forgot password’ option to verify your email.
    CONSENT_FORM_NOT_AVAILABLE:
      summary: CONSENT_FORM_NOT_AVAILABLE
      value:
        ErrorCode: 1224
        Message: Consent form is not available
        Description: There is no consent form available currently for your LoginRadius site, please configure consent form.
    INVALID_UUID:
      summary: INVALID_UUID
      value:
        ErrorCode: 1291
        Message: This uuid is invalid
        Description: This is not a valid uuid, please use a valid uuid.
    API_SECRET_NOT_VALID:
      summary: API_SECRET_NOT_VALID
      value:
        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.
    APP_NOT_EXISTS:
      value:
        Description: The provided site does not exist, please use a valid LoginRadius site in order to process this request.
        ErrorCode: 942
        Message: Site does not exist
    EMAIL_ALREADY_USED:
      summary: EMAIL_ALREADY_USED
      value:
        ErrorCode: 1046
        Message: This email has already been registered with your LoginRadius site
        Description: This email has already been registered with your LoginRadius site, please use a different mail address.
    EMAIL_TYPE_CAN_NOT_NULL:
      summary: EMAIL_TYPE_CAN_NOT_NULL
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The type is a required parameter.
    ACCOUNT_ID_IS_INVALID:
      summary: ACCOUNT_ID_IS_INVALID
      value:
        ErrorCode: 984
        Message: Account ID is invalid
        Description: The provided account ID is invalid, please use a valid account ID in order to process this request.
    CANNOT_ADD_EMAIL_ADDRESS:
      summary: CANNOT_ADD_EMAIL_ADDRESS
      value:
        ErrorCode: 1177
        Message: Cannot add email address
        Description: The email address you are trying to add is not allowed.
    DELETE_BODY_INVALID:
      summary: DELETE_BODY_INVALID
      value:
        ErrorCode: 1084
        Message: Delete body is invalid
        Description: Please use a valid delete body and make sure that it is in a valid JSON format.
    ONE_EMAILID_IS_REQUIRED:
      summary: ONE_EMAILID_IS_REQUIRED
      value:
        ErrorCode: 1005
        Message: User account should have at least one email address
        Description: This email address cannot be deleted as this is the only email address in your Profile. Please add an additional email address in order to remove this.
    PASSKEY_NOT_CONFIGURED_IN_PROFILE:
      summary: PASSKEY_NOT_CONFIGURED_IN_PROFILE
      value:
        ErrorCode: 1323
        Message: Passkey not configured in your profile.
        Description: Please add a passkey in your profile to use this feature. You can configure your passkey in the profile settings.
    PASSKEY_VERIFICATION_FAILED_FOR_BLOCK_LOCKOUT:
      summary: PASSKEY_VERIFICATION_FAILED_FOR_BLOCK_LOCKOUT
      value:
        Description: You have {count} tries left before your account gets blocked.
        ErrorCode: 1321
        Message: An unexpected error occurred while verifying your passkey.
    PASSKEY_VERIFICATION_FAILED_FOR_SUSPEND_LOCKOUT:
      summary: PASSKEY_VERIFICATION_FAILED_FOR_SUSPEND_LOCKOUT
      value:
        Description: You have {count} tries left before your account gets suspended.
        ErrorCode: 1321
        Message: An unexpected error occurred while verifying your passkey.
    PASSKEY_AUTOFILL_NOT_ENABLED_IN_APP:
      summary: PASSKEY_AUTOFILL_NOT_ENABLED_IN_APP
      value:
        Message: Passkeys autofill not enabled in this application.
        ErrorCode: 1326
        Description: Passkey autofill functionality is currently disabled. Please enable it in the admin console to allow users to log in with autofill.
    SECOND_FACTOR_AUTH_TOKEN_REQUIRED:
      summary: SECOND_FACTOR_AUTH_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The secondfactorauthenticationtoken is a required parameter.
    TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID:
      summary: TWO_FACTOR_AUTHENTICATION_TOKEN_NOT_VALID
      value:
        ErrorCode: 1103
        Message: Two factor authentication token is invalid
        Description: The LoginRadius two factor authentication token is invalid, please use the correct or valid token in order to process this request.
    TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED:
      summary: TWO_FACTOR_AUTHENTICATION_TOKEN_EXPIRED
      value:
        ErrorCode: 1104
        Message: Two factor authentication token has expired
        Description: The LoginRadius two factor authentication token has expired, please request a new token from LoginRadius API.
    TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
      summary: TWO_FACTOR_AUTHENTICATION_NOT_ENABLED
      value:
        ErrorCode: 1097
        Message: Two factor authentication is not enabled
        Description: Two factor authentication is not enabled, please enable two factor authentication for login.
    TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED:
      summary: TWO_FACTOR_AUTHENTICATION_PASSKEY_AUTHENTICATION_NOT_ENABLED
      value:
        ErrorCode: 1327
        Message: Passkeys are not set up for Two-Factor Authentication
        Description: Please set up passkeys for two-factor authentication in your account settings.
    PASSKEY_ONLY_SUPPORT_EMAIL:
      summary: PASSKEY_ONLY_SUPPORT_EMAIL
      value:
        ErrorCode: 1324
        Message: Passkey login unavailable for this account type.
        Description: Passkey login is only available if registered with an email ID. Please try logging in with your email or consider updating your account information if you have the option.
    LOGIN_IS_LOCKED_FOR_MFA:
      summary: LOGIN_IS_LOCKED_FOR_MFA
      value:
        ErrorCode: 1263
        Message: Your account has been locked
        Description: Your account has been locked, please login with your credentials again in order to unlock your account.
    TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE:
      summary: TWO_FACTOR_PASSKEY_NOT_CONFIGURED_ON_PROFILE
      value:
        ErrorCode: 1328
        Message: Passkey as two factor authentication is not configured for this profile
        Description: Passkey as two factor authentication is not configured, please configure or enable two factor authentication on your profile for login.
    TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED:
      summary: TWO_FACTOR_AUTHENTICATION_Push_AUTHENTICATION_NOT_ENABLED
      value:
        ErrorCode: 1299
        Message: Push Notifications are not set up for Two-Factor Authentication
        Description: Please set up push notifications for two-factor authentication in your account settings.
    MFA_PUSH_VERIFICATION_COMPLETE:
      summary: MFA_PUSH_VERIFICATION_COMPLETE
      value:
        ErrorCode: 1311
        Message: Push Notification Verification Already Done
        Description: You have already verified your account with push notification. You don't need to verify again.
    TWO_FACTOR_PUSH_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
      summary: TWO_FACTOR_PUSH_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE
      value:
        ErrorCode: 1313
        Message: Push notification as two factor authentication is not configured for this profile
        Description: Push notification as two factor authentication is not configured, please configure or enable two factor authentication on your profile for login.
    MFA_PUSH_VERIFICATION_PENDING:
      summary: MFA_PUSH_VERIFICATION_PENDING
      value:
        ErrorCode: 1295
        Message: Push Notification Verification Pending
        Description: We've sent a verification message to your registered device. Please tap Approve when it arrives to complete the process.
    MFA_PUSH_VERIFICATION_DENIED:
      summary: MFA_PUSH_VERIFICATION_DENIED
      value:
        ErrorCode: 1312
        Message: Push Notification Verification Denied
        Description: It appears you declined the push notification request for verification. To proceed, please tap Approve on the notification when it reappears on your device.
    TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG:
      summary: TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED_IN_APP_CONFIG
      value:
        ErrorCode: 1280
        Message: SMS OTP is not enabled for two-factor authentication
        Description: SMS OTP not enabled for two-factor authentication, please enable and try again.
    TWO_FACTOR_AUTHENTICATION_PHONE_NOT_VERIFIED:
      summary: TWO_FACTOR_AUTHENTICATION_PHONE_NOT_VERIFIED
      value:
        ErrorCode: 1117
        Message: This phone number is not registered
        Description: This phone number is not registered on your profile for two factor authentication
    DUO_CODE_REQUIRED:
      summary: DUO_CODE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The code is a required parameter.
    DUO_STATE_REQUIRED:
      summary: DUO_STATE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The state is a required parameter.
    DUO_CODE_STATE_REQUIRED:
      summary: DUO_CODE_STATE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The state is a required parameter,The code is a required parameter.
    DUO_AUTH_NOT_ENABLED:
      summary: DUO_AUTH_NOT_ENABLED
      value:
        ErrorCode: 1330
        Message: Duo Authenticator is not set up for two-factor authentication
        Description: Please set up Duo Authenticator for two-factor authentication in your account settings.
    DUO_STATE_NOT_VALID:
      summary: DUO_STATE_NOT_VALID
      value:
        ErrorCode: 908
        Message: Duo Authenticator state is not valid
        Description: Please enter the correct state value for Duo Authenticator.
    DUO_AUTHENTICATOR_VERIFICATION_FAILED:
      summary: DUO_AUTHENTICATOR_VERIFICATION_FAILED
      value:
        ErrorCode: 1332
        Message: Duo Authenticator verification failed
        Description: Please try again as Duo Authenticator verification failed.
    BACKUP_CODE_REQUIRED:
      summary: BACKUP_CODE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The backupcode is a required parameter.
    TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_CONFIGURED:
      summary: TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_CONFIGURED
      value:
        ErrorCode: 1128
        Message: Two factor authentication backup code is not configured
        Description: The two factor authentication backup code is not enabled, please enable or configure two factor authentication for login.
    TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_VALID:
      summary: TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_NOT_VALID
      value:
        ErrorCode: 1129
        Message: Two factor authentication backup code is not valid or has already been used
        Description: The two factor authentication backup code is not valid or has already been used, please use a valid two factor authentication backup code for login.
    EMAIL_NOT_FORMATTED:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly.
        Description: The value of email can not be null or empty.
    OTP_NOT_FORMATTED:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly.
        Description: The value of OTP can not be null or empty.
    EMAILID_REQUIRD:
      summary: EMAILID_REQUIRD
      value:
        ErrorCode: 1032
        Message: Email address is required
        Description: Email address is required, please use a valid email address in order to process this request.
    TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED:
      summary: TWO_FACTOR_AUTHENTICATION_EmailOTP_AUTHENTICATION_NOT_ENABLED
      value:
        ErrorCode: 1256
        Message: Email OTP two factor authentication is not enabled
        Description: The Email OTP two factor authentication is not enabled, please enable Email OTP two factor authentication for login.
    CLIENT_GUID_REQUIRED:
      summary: CLIENT_GUID_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The clientguid is a required parameter.
    ACCESS_TOKEN_OR_CLIENT_GUID_REQUIRED:
      summary: ACCESS_TOKEN_OR_CLIENT_GUID_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The access_token or clientGuid is a required parameter.
    INVALID_PROVIDER_IN_ORGANIZATION:
      summary: INVALID_PROVIDER_IN_ORGANIZATION
      value:
        ErrorCode: 1269
        Message: Invalid provider in organization
        Description: The specified provider is not valid or not configured for this organization. Please check your configuration.
    SP_JWT_CONFIG_NOT_FOUND:
      summary: SP_JWT_CONFIG_NOT_FOUND
      value:
        ErrorCode: 1282
        Message: SP JWT configuration not found
        Description: The SP JWT configuration not found, please use a valid SP JWT configuration in order to process this request.
    CLIENT_GUID_NOT_VALID:
      summary: CLIENT_GUID_NOT_VALID
      value:
        ErrorCode: 1140
        Message: Client GUID is invalid
        Description: The client GUID is invalid or expired, please use a valid client GUID in order to process this request.
    AUTOLOGIN_LINK_ALREADY_USED:
      summary: AUTOLOGIN_LINK_ALREADY_USED
      value:
        ErrorCode: 1137
        Message: Autologin link already used
        Description: The autologin link already used, please use a valid autologin link in order to process this request.
    NO_CALLBACK_LOGIN_NOT_ENABLED:
      summary: NO_CALLBACK_LOGIN_NOT_ENABLED
      value:
        ErrorCode: 1160
        Message: No callback login is enabled
        Description: The no callback login is enabled, please disable the no callback login in order to process this request.
    PROVIDER_NOT_CONFIGURED:
      summary: PROVIDER_NOT_CONFIGURED
      value:
        Description: This social provider has not been configured for the site.
        ErrorCode: 1223
        Message: Social provider has not been configured for the site.
    PROVIDER_NOT_SUPPORTED:
      summary: PROVIDER_NOT_SUPPORTED
      value:
        ErrorCode: 1232
        Message: Provider is not supported.
        Description: Oops, this ID Provider is not supported in your LoginRadius account.
    PROVIDER_NOT_VALID:
      summary: PROVIDER_NOT_VALID
      value:
        ErrorCode: 1065
        Message: Provider is not valid
        Description: The provider is not valid, please use a valid provider in order to process this request.
    PROVIDER_SIDE_ERROR:
      summary: PROVIDER_SIDE_ERROR
      value:
        ErrorCode: 1000
        Message: Provider side error
        Description: The provider side error, please use a valid provider in order to process this request.
    JWT_SP_TOKEN_INVALID:
      summary: JWT_SP_TOKEN_INVALID
      value:
        ErrorCode: 1283
        Message: Invalid or expired JWT token
        Description: JWT service provider token is invalid or expired, please use a valid token to process this request.
    PROVIDER_ID_MISSING:
      summary: PROVIDER_ID_MISSING
      value:
        ErrorCode: 1302
        Message: provider ID is missing in social data
        Description: provider ID is missing in social data.
    EMAIL_ALLREADY_VERIFIED_TOKEN:
      summary: EMAIL_ALLREADY_VERIFIED_TOKEN
      value:
        ErrorCode: 1126
        Message: Email has already been verified
        Description: Provided email address has already been verified, so its verification token couldn’t be generated.
    DELETE_TOKEN_REQUIRED:
      summary: DELETE_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The deletetoken is a required parameter.
    EMAIL_OTP_REQUIRED:
      summary: EMAIL_OTP_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The otp is a required parameter,The email is a required parameter.
    OTP_OR_DELETE_TOKEN_REQUIRED:
      summary: OTP_OR_DELETE_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The deleteToken/(otp & email) is a required parameter.
    DELETE_TOKEN_IS_INVALID:
      summary: DELETE_TOKEN_IS_INVALID
      value:
        ErrorCode: 1119
        Message: The LoginRadius DeleteToken is invalid
        Description: The LoginRadius DeleteToken is invalid, please use the correct or valid DeleteToken in order to process this request.
    LINK_INVALID:
      summary: LINK_INVALID
      value:
        ErrorCode: 979
        Message: The link cannot be accessed
        Description: The link is either expired or has already been used, please request a new link.
    PHONE_DOES_NOT_EXIST:
      summary: PHONE_DOES_NOT_EXIST
      value:
        ErrorCode: 1292
        Message: A phone number is not currently linked to your account
        Description: Your request cannot be processed as no phone number is linked to your account.
    PREVENT_REFRESH_NOT_VALID:
      summary: PREVENT_REFRESH_NOT_VALID
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value 'preventRefresh' is not valid.
    SOCIAL_REGISTRATION_NOT_ALLOWED:
      value:
        Description: The new social registration are not allowed, please login from your existing account or link this account.
        ErrorCode: 1051
        Message: New social registration is not allowed
    EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION:
      summary: EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION
      value:
        Description: The email domain used is not allowed for this organization connection. Please use an valid domain.
        ErrorCode: 2065
        Message: Email domain not allowed in organization connection
    UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_PHONE_ID:
      value:
        Description: Please verify your phoneid first to log in with this social provider.
        ErrorCode: 1285
        Message: Cannot login with this social provider as phoneid is not yet verified
    SIGNUP_NOT_ALLOWED_IN_ORG:
      value:
        Description: User signup is restricted for this organization.
        ErrorCode: 1271
        Message: Signup not allowed in organization
    AUTOLOOKUP_DOMAIN_NOT_MATCH:
      value:
        Description: The email domain does not exist in the AutoLookUp configuration. Please enter a valid email domain name.
        ErrorCode: 1288
        Message: Invalid email domain.
    UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID:
      summary: UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID
      value:
        ErrorCode: 1026
        Message: Cannot login with this social provider as email address is not yet verified
        Description: Please verify your email address first to log in with this social provider.
    UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED:
      summary: UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED
      value:
        ErrorCode: 1033
        Message: Cannot login with this social provider as the same email address is already being used with another account
        Description: please login with your existing account. If you’ve forgotten which provider you have previously registered under, please use the Forgot User ID or Social Provider link.
    EMAIL_TYPE_VALUE_REQUIRED_PARAM:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The type and value are required parameters. Please ensure both are provided and correctly formatted.
    CUSTOM_FIELD_LENGTH_EXCEEDED:
      value:
        ErrorCode: 6007
        Message: Custom field length exceeded
        Description: The value provided for the custom field is too long. Please ensure it does not exceed 1000 characters and try again.
    PHONE_TYPE_CAN_NOT_BE_SAME:
      value:
        ErrorCode: 1124
        Message: Phone type cannot be same
        Description: Please use different phone types in the case of multiple phone numbers.
    PHONE_TYPE_REQUIRED:
      value:
        ErrorCode: 1213
        Message: Phone type is required
        Description: The request couldn't be processed, the phone type must be specified in the phone numbers.
    EMAIL_ID_NOT_ALLOWED_TO_UPDATE:
      value:
        ErrorCode: 1174
        Message: Email update is not allowed
        Description: Update email is not allowed as email already exists in this account
    ACTIVE_LOGIN_SESSIONS_NOT_ENABLED:
      summary: ACTIVE_LOGIN_SESSIONS_NOT_ENABLED
      value:
        ErrorCode: 1339
        Message: Restrict Login Sharing feature not enabled
        Description: Please enable the Restrict Login Sharing feature to proceed further.
    DELETE_URL_IS_NOT_WHITELISTED:
      summary: DELETE_URL_IS_NOT_WHITELISTED
      value:
        ErrorCode: 2066
        Message: The delete URL is not whitelisted
        Description: The delete URL is not whitelisted, please whitelist the URL on the tenant settings.
    USER_ID_NOT_VALID:
      summary: USER_ID_NOT_VALID
      value:
        ErrorCode: 937
        Message: User ID is invalid
        Description: The user ID is invalid, please use a valid user ID in order to process this request.
    EMAIL_ID_NOT_EXIST_IN_PROFILE:
      summary: EMAIL_ID_NOT_EXIST_IN_PROFILE
      value:
        ErrorCode: 1340
        Message: Email address does not exist in the profile
        Description: The request cannot be processed as the email address does not exist in the user's profile.
    AUTH_PARAMETER_REQUIRED:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly.
        Description: The authenticatorcode is a required parameter.
    TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD:
      summary: TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG_OLD
      value:
        ErrorCode: 1279
        Message: Google Authenticator is not enabled for two-factor authentication
        Description: Google Authenticator not enabled for two-factor authentication, please enable and try again.
    TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG:
      summary: TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_ENABLED_IN_APP_CONFIG
      value:
        ErrorCode: 1279
        Message: The authenticator method is not enabled for two-factor authentication.
        Description: Please enable the authenticator method for two-factor authentication and try again.
    TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT:
      summary: TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT
      value:
        ErrorCode: 1102
        Message: The two-factor authenticator code is incorrect
        Description: Please enter the correct authenticator code.
    TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT_OLD:
      summary: TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT
      value:
        ErrorCode: 1331
        Message: Google two factor authentication code is incorrect
        Description: The Google two factor authentication code is incorrect, please enter the correct authentication code for login.
    TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED:
      summary: TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED
      value:
        ErrorCode: 1098
        Message: A two-factor authentication method is not enabled
        Description: A working two-factor authentication method is necessary. Please configure or enable a two-factor authentication method.
    TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE:
      summary: TWO_FACTOR_AUTHENTICATION_NOT_VALID_FOR_DELETE
      value:
        ErrorCode: 1121
        Message: This is not valid request for removing two factor authentication
        Description: This is not valid request for removing two factor authentication
    TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED:
      summary: TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED
      value:
        ErrorCode: 1099
        Message: Two-factor authenticator is not configured.
        Description: Two-factor authenticator app is not configured. Please configure an authenticator to enable two-factor authentication.
    TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD:
      summary: TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_NOT_CONFIGURED_OLD
      value:
        ErrorCode: 1099
        Message: Two-factor authenticator is not configured.
        Description: Two-factor authenticator app is not configured. Please configure an authenticator to enable two-factor authentication.
    TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED:
      summary: TWO_FACTOR_AUTHENTICATION_OTP_AUTHENTICATION_NOT_ENABLED
      value:
        ErrorCode: 1100
        Message: OTP two factor authentication is not enabled
        Description: The OTP two factor authentication is not enabled, please enable OTP two factor authentication for login.
    PRIVACY_POLICY_NOT_AVAILABLE:
      value:
        ErrorCode: 1195
        Message: Privacy Policy is not available
        Description: There is no Privacy Policy available currently for your LoginRadius site.
    PRIVACY_POLICY_ALREADY_ACCEPTED:
      value:
        ErrorCode: 1222
        Message: Current Privacy Policy is already accepted
        Description: Current Privacy Policy is already accepted.
    INVALID_PASSKEY_ID:
      summary: INVALID_PASSKEY_ID
      value:
        ErrorCode: 1325
        Message: Invalid Passkey ID
        Description: The provided Passkey ID is invalid; it cannot be removed.
    TWO_FACTOR_DUO_AUTHENTICATOR_NOT_CONFIGURED_ON_PROFILE:
      summary: TWO_FACTOR_DUO_AUTHENTICATOR_NOT_CONFIGURED_ON_PROFILE
      value:
        ErrorCode: 1334
        Message: Duo Authenticator as two-factor authentication method is not configured for this profile
        Description: Please configure or enable two-factor authentication in your account for login.
    TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE:
      summary: TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_ON_PROFILE
      value:
        ErrorCode: 1101
        Message: Two factor authentication is not configured for this profile
        Description: Two factor authentication is not configured, please configure or enable two factor authentication on your profile for login.
    TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_ALREADY_CONFIGURED:
      summary: TWO_FACTOR_AUTHENTICATION_BACKUP_CODE_ALREADY_CONFIGURED
      value:
        ErrorCode: 1127
        Message: Two factor authentication backup code is already generated
        Description: The two factor authentication backup code is already generated, please reset your two factor authentication backup code.
    EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED:
      summary: EVENT_BASED_TWO_FACTOR_AUTHENTICATION_NOT_ENABLED
      value:
        ErrorCode: 1191
        Message: Event Based two factor authentication is not enabled
        Description: Event Based two factor authentication is not enabled, please enable event based two factor authentication for login.
    OTP_PAYLOAD_REQUIRED:
      summary: OTP_PAYLOAD_REQUIRED
      value:
        Message: A parameter is not formatted correctly
        ErrorCode: 908
        Description: The otp is a required parameter.
    RESET_PASSKEY_URL_INVALID:
      summary: RESET_PASSKEY_URL_INVALID
      value:
        ErrorCode: 1329
        Message: The reset passkey URL is invalid
        Description: The reset passkey Url is invalid, please reach out to LoginRadius support for more information.
    ACCOUNT_ALREADY_UNLOCKED:
      value:
        ErrorCode: 1221
        Message: Account is already unlocked
        Description: The account is already unlocked, you can access or manage your profile.
    CAPTCHA_IS_NOT_VALID:
      summary: CAPTCHA_IS_NOT_VALID
      value:
        ErrorCode: 1218
        Message: CAPTCHA is invalid
        Description: CAPTCHA is invalid, please enter the correct CAPTCHA value.
    CANDIDATE_TOKEN_REQUIRED:
      summary: CANDIDATE_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The candidatetoken is a required parameter.
    ACCOUNT_LINKING_DISABLED:
      summary: ACCOUNT_LINKING_DISABLED
      value:
        ErrorCode: 1054
        Message: Account linking is disabled
        Description: The account linking is disabled, please enable the account linking in order to process this request.
    SAME_PROVIDER_CANT_BE_LINKED:
      summary: SAME_PROVIDER_CANT_BE_LINKED
      value:
        ErrorCode: 1251
        Message: Same provider can't be linked
        Description: The same provider can't be linked, please use a valid provider in order to process this request.
    EMAIL_NOT_VERIFIED_CAN_NOT_LINK:
      summary: EMAIL_NOT_VERIFIED_CAN_NOT_LINK
      value:
        ErrorCode: 1254
        Message: Email is not verified can not link
        Description: The email is not verified can not link, please verify the email in order to process this request.
    ACCOUNT_IS_ALREADY_EXIST_WITH_SAME_EMAIL:
      summary: ACCOUNT_IS_ALREADY_EXIST_WITH_SAME_EMAIL
      value:
        ErrorCode: 1253
        Message: Account is already exist with same email
        Description: The account is already exist with same email, please use a valid account in order to process this request.
    SAME_ACCOUNT_CANT_BE_LINKED:
      summary: SAME_ACCOUNT_CANT_BE_LINKED
      value:
        ErrorCode: 983
        Message: Same account can't be linked
        Description: The same account can't be linked, please use a valid account in order to process this request.
    ACCOUNT_IS_ALREADY_LINKED:
      summary: ACCOUNT_IS_ALREADY_LINKED
      value:
        ErrorCode: 986
        Message: Account is already linked
        Description: The account is already linked, please use a valid account in order to process this request.
    PROVIDER_IS_REQUIRED:
      summary: PROVIDER_IS_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of provider can not be null or empty.
    PROVIDER_ID_IS_REQUIRED:
      summary: PROVIDER_ID_IS_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of providerid can not be null or empty.
    ENDPOINT_NOT_SUPPORTED_BY_PROVIDER:
      summary: ENDPOINT_NOT_SUPPORTED_BY_PROVIDER
      value:
        ErrorCode: 1078
        Message: Endpoint not supported by provider
        Description: The endpoint not supported by provider, please use a valid endpoint in order to process this request.
    SAME_ACCOUNT_CANT_BE_UNLINKED:
      summary: SAME_ACCOUNT_CANT_BE_UNLINKED
      value:
        ErrorCode: 1219
        Message: Account cannot be unlinked
        Description: An account cannot be unlinked from itself.
    ACCOUNT_IS_NOT_LINKED_WITH_ANY_ACCOUNT:
      summary: ACCOUNT_IS_NOT_LINKED_WITH_ANY_ACCOUNT
      value:
        ErrorCode: 987
        Message: Account cannot be unlinked
        Description: This account is not linked to any other account, so it cannot be unlinked.
    PROVIDER_ID_NOT_LINKED_WITH_THIS_ACCOUNT:
      summary: PROVIDER_ID_NOT_LINKED_WITH_THIS_ACCOUNT
      value:
        ErrorCode: 989
        Message: Provider ID cannot be unlinked
        Description: This provider ID is not linked to any other account, so it cannot be unlinked.
    CAPTCHA_REQUIRED:
      summary: CAPTCHA_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The captcha is a required parameter.
    NO_REGISTRATION_NOT_ENABLED:
      summary: NO_REGISTRATION_NOT_ENABLED
      value:
        ErrorCode: 1146
        Message: One touch login is not enabled for your LoginRadius site
        Description: The one touch login is not enabled for your LoginRadius site, please reach out to LoginRadius support for more information.
    CLIENT_GUID_MUST_BE_UNIQUE:
      summary: CLIENT_GUID_MUST_BE_UNIQUE
      value:
        ErrorCode: 1136
        Message: Client GUID must be unique
        Description: You have already used this client GUID, please use a unique client GUID.
    REDIRECT_URL_IS_NOT_WHITELISTED:
      summary: REDIRECT_URL_IS_NOT_WHITELISTED
      value:
        ErrorCode: 2067
        Message: The redirect URL is not whitelisted
        Description: The redirect URL is not whitelisted, please whitelist the URL on the tenant settings.
    NO_REGISTRATION_LOGIN_LINK_ALREADY_USED:
      summary: NO_REGISTRATION_LOGIN_LINK_ALREADY_USED
      value:
        ErrorCode: 1145
        Message: The one touch login link has already been used
        Description: Each link can only be used once, please click the sign in button for a new link.
    PIN_AUTH_WRONG:
      summary: PIN_AUTH_WRONG
      value:
        ErrorCode: 1236
        Message: Invalid PIN
        Description: Please use a valid PIN for the Authentication.
    PIN_AUTH_NOT_ENABLED:
      summary: PIN_AUTH_NOT_ENABLED
      value:
        ErrorCode: 1233
        Message: PIN Authentication is not configured.
        Description: PIN Authentication is not configured, please reach out to LoginRadius support for more information.
    PIN_NOT_CONFIGURED:
      summary: PIN_AUTH_NOT_CONFIGURED
      value:
        ErrorCode: 1235
        Message: PIN is not available
        Description: The PIN is not available in the profile, please add PIN in the profile in order to process this request.
    PASSWORD_IS_WRONG:
      summary: PASSWORD_IS_WRONG
      value:
        ErrorCode: 1205
        Message: Invalid password
        Description: Please use a valid password.
    EMAIL_OR_PHONE_NOT_VERIFIED:
      summary: EMAIL_OR_PHONE_NOT_VERIFIED
      value:
        ErrorCode: 1162
        Message: Email or Phone is not verified
        Description: This email has not yet been verified, please click the link in your email to confirm your email address.
    TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED_OLD_MFA:
      summary: TWO_FACTOR_AUTHENTICATION_NOT_CONFIGURED
      value:
        ErrorCode: 1098
        Message: Two factor authentication client is not configured
        Description: The Google two factor authentication client is not enabled, please configure or enable at least one two factor authentication client on your profile for login.
    GOOGLE_AUTH_CODE_REQUIRED:
      summary: GOOGLE_AUTH_CODE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The googleauthenticatorcode is a required parameter.
    AUTHENTICATOR_CODE_REQUIRED:
      summary: AUTHENTICATOR_CODE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The authenticatorcode is a required parameter.
    TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT_OLD_MFA:
      summary: TWO_FACTOR_AUTHENTICATION_AUTHENTICATOR_CODE_INCORRECT
      value:
        ErrorCode: 1102
        Message: Google two factor authentication code is incorrect
        Description: The Google two factor authentication code is incorrect, please enter the correct authentication code for login.
    RESOURCE_NOT_FOUND:
      summary: RESOURCE_NOT_FOUND
      value:
        ErrorCode: 404
        Message: Resource not found
        Description: Sorry, the resource you were looking for was not found.
    SECURITY_QUES_ANS_REQUIRED:
      summary: SECURITY_QUES_ANS_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The securityquestionanswer is a required parameter.
    TWO_FACTOR_SECURITY_QUESTION_AUTHENTICATION_NOT_VERIFIED:
      summary: TWO_FACTOR_SECURITY_QUESTION_AUTHENTICATION_NOT_VERIFIED
      value:
        ErrorCode: 1259
        Message: Security question two factor authentication is not verified on the profile
        Description: The Security question two factor authentication is not verified on profile, please verify security question two factor authentication on profile.
    TWO_FACTOR_AUTHENTICATION_METHOD_ENABLED:
      summary: TWO_FACTOR_AUTHENTICATION_METHOD_ENABLED
      value:
        ErrorCode: 1258
        Message: One of the Two Factor authentication methods is already enabled
        Description: One of the Two Factor authentication methods is already enabled, can not update Two Factor authentication security question answers.
    AUTOLOGIN_NOT_ENABLED:
      summary: AUTOLOGIN_NOT_ENABLED
      value:
        ErrorCode: 1135
        Message: Smart login option is not enabled for your LoginRadius site
        Description: The smart login option is not enabled for your LoginRadius site, please reach out to LoginRadius support for more information.
    AUTOLOGIN_LINK_ALREADY_VERIFIED:
      summary: AUTOLOGIN_LINK_ALREADY_VERIFIED
      value:
        ErrorCode: 1138
        Message: The smart login link has already been verified
        Description: This smart login link has already been verified, please click the smart login button for a new link.
    EMAIL_PHONE_USERNAME_AND_CLIENT_GUID_REQUIRED:
      summary: EMAIL_PHONE_USERNAME_AND_CLIENT_GUID_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email/username/phone is a required parameter.,The clientguid is a required parameter.
    AUTOLOGIN_LINK_NOT_VERIFIED:
      summary: AUTOLOGIN_LINK_NOT_VERIFIED
      value:
        ErrorCode: 1139
        Message: The smart login link has not been verified
        Description: This smart login link has not been verified, please click the smart login link in your email to verify.
    ONE_CLICK_SIGIN_NOT_ENABLED:
      summary: ONE_CLICK_SIGIN_NOT_ENABLED
      value:
        ErrorCode: 1059
        Message: Password less login option is not enabled for your LoginRadius site
        Description: The password less login option is not enabled for your LoginRadius site, please reach out to LoginRadius support for more information.
    TOKEN_LIMIT_REACHED:
      summary: TOKEN_LIMIT_REACHED
      value:
        ErrorCode: 1178
        Message: You have reached a limit for generating token
        Description: The limit for generating a token for this resource has been reached. The limit will auto reset upon reaching the configured request disabled period.
    PHONE_NUMBER_NOT_EXISTS:
      summary: PHONE_NUMBER_NOT_EXISTS
      value:
        ErrorCode: 1043
        Message: Phone number is invalid or does not exist
        Description: The provided phone number is invalid or does not exist, please use a valid phone number in order to process this request.
    LINK_ALREADY_USED:
      summary: LINK_ALREADY_USED
      value:
        ErrorCode: 1062
        Message: The password less login link has already been used
        Description: Each link can only be used once, please click the password less login button for a new link.
    PHONE_NOT_BLANK:
      summary: PHONE_NOT_BLANK
      value:
        ErrorCode: 912
        Message: A parameter is not formatted correctly
        Description: The value of Phone cannot be null or empty.
    OTP_NOT_BLANK:
      summary: OTP_NOT_BLANK
      value:
        ErrorCode: 910
        Message: A parameter is not formatted correctly
        Description: The value of OTP cannot be null or empty.
    USER_NAME_NOT_BLANK:
      summary: USER_NAME_NOT_BLANK
      value:
        ErrorCode: 910
        Message: A parameter is not formatted correctly
        Description: The value of UserName cannot be null or empty.
        HTTPStatusCode: 400
    USER_NAME_AUTHENTICATION_NOT_ENABLED:
      summary: USER_NAME_AUTHENTICATION_NOT_ENABLED
      value:
        ErrorCode: 1238
        Message: UserName authentication is not enabled
        Description: UserName authentication is not enabled.
    EMAIL_NOT_BLANK:
      summary: EMAIL_NOT_BLANK
      value:
        ErrorCode: 912
        Message: A parameter is not formatted correctly
        Description: The value of Email cannot be null or empty.
    PIN_REQUIRED_PARAM:
      summary: PIN_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The pin is a required parameter.
    SESSION_TOKEN_REQUIRED:
      summary: SESSION_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The session_token is a required parameter.
    PIN_AUTH_SESSION_TOKEN_NOT_VALID:
      summary: PIN_AUTH_SESSION_TOKEN_NOT_VALID
      value:
        ErrorCode: 1245
        Message: Session token is invalid
        Description: PIN authentication session token is invalid, please use valid PIN authentication session token.
    PIN_AUTH_SESSION_TOKEN_EXPIRED:
      summary: PIN_AUTH_SESSION_TOKEN_EXPIRED
      value:
        ErrorCode: 1246
        Message: Session token has expired
        Description: The LoginRadius PIN authentication session token expired, please request a new PIN authentication session token from LoginRadius API.
    PIN_LOGIN_NOT_ENABLED:
      summary: PIN_LOGIN_NOT_ENABLED
      value:
        ErrorCode: 1244
        Message: PIN Login is not enabled
        Description: PIN Login is not enabled.
    CUSTOM_OBJECTS_RESPONSE_EXAMPLE:
      summary: CustomObjectsResponseModel
      value:
        Count: 2
        data:
          - 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'
          - IsActive: false
            IsDeleted: true
            CustomObject:
              company: Acme Corp
              Role: Engineer
            Id: def789
            Uid: user789
            DateCreated: '2024-05-20T08:00:00Z'
            DateModified: '2024-05-21T10:00:00Z'
    CUSTOM_OBJECT_NAME_REQUIRED:
      summary: CUSTOM_OBJECT_NAME_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The objectname is a required parameter.
    CUSTOM_OBJECT_NOT_CONFIGURED:
      summary: CUSTOM_OBJECT_NOT_CONFIGURED
      value:
        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.
    CUSTOM_OBJECT_NAME_NOT_VALID:
      summary: CUSTOM_OBJECT_NAME_NOT_VALID
      value:
        ErrorCode: 1064
        Message: Custom object name is invalid
        Description: The custom object name used in this request is incorrect or does not exist.
    CUSTOM_OBJECT_RECORD_NOT_EXIST:
      summary: CUSTOM_OBJECT_RECORD_NOT_EXIST
      value:
        ErrorCode: 1057
        Message: Custom object is not found or does not exist
        Description: The requested custom object of the user's account could not be found, please create a custom object before requesting.
    CUSTOM_OBJECT_RESPONSE_EXAMPLE:
      summary: CustomObjectResponseModel
      value:
        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'
    CUSTOM_OBJECT_JSON_NOT_VALID:
      summary: CUSTOM_OBJECT_JSON_NOT_VALID
      value:
        ErrorCode: 1035
        Message: Custom object JSON is invalid
        Description: The provided custom object JSON is invalid, please use a valid or well-formatted JSON in order to process this request
    CUSTOM_OBJECT_RECORD_ID_NOT_VALID:
      summary: CUSTOM_OBJECT_RECORD_ID_NOT_VALID
      value:
        ErrorCode: 995
        Message: Unique record ID is invalid
        Description: This unique record Id is invalid, please enter a valid unique record ID.
    PHONE_NUMBER_ALREADY_VERIFIED:
      summary: PHONE_NUMBER_ALREADY_VERIFIED
      value:
        ErrorCode: 1073
        Message: This phone number has already been confirmed
        Description: This phone number has already been confirmed, so you cannot resend the verification OTP
    ACCESS_TOKEN_INVALID_OR_PHONE_NUMBER_ALREADY_VERIFIED:
      summary: ACCESS_TOKEN_INVALID_OR_PHONE_NUMBER_ALREADY_VERIFIED
      value:
        ErrorCode: 1120
        Message: Access token is invalid or phone number is already verified
        Description: The LoginRadius access token is invalid or the phone number has already been verified.
    OLD_PIN_REQUIRED_PARAM:
      summary: OLD_PIN_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of oldpin can not be null or empty.
    NEW_PIN_REQUIRED_PARAM:
      summary: NEW_PIN_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of newpin can not be null or empty.
    OLD_PIN_WRONG:
      summary: OLD_PIN_WRONG
      value:
        ErrorCode: 1241
        Message: Current pin is invalid
        Description: Your current pin is invalid, please use the correct pin.
    PIN_AUTH_TOKEN_REQUIRED:
      summary: PIN_AUTH_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The pinauthtoken is a required parameter.
    PIN_AUTH_TOKEN_NOT_VALID:
      summary: PIN_AUTH_TOKEN_NOT_VALID
      value:
        ErrorCode: 1239
        Message: PINAuth token is invalid
        Description: PINAuth token is invalid, please use the correct or valid PINAuth token in order to process this request.
    PIN_AUTH_TOKEN_EXPIRED:
      summary: PIN_AUTH_TOKEN_EXPIRED
      value:
        ErrorCode: 1240
        Message: PINAuth token has expired
        Description: The LoginRadius PINAuth token expired, please request a new PINAuth token from LoginRadius API.
    RESET_PIN_URL_INVALID:
      summary: RESET_PIN_URL_INVALID
      value:
        ErrorCode: 1248
        Message: The reset pin URL is invalid
        Description: The reset pin Url is invalid, please reach out to LoginRadius support for more information.
    PHONE_PAYLOAD_REQUIRED:
      summary: PHONE_PAYLOAD_REQUIRED
      value:
        Description: The phone is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    PIN_LINK_ALREADY_VERIFIED:
      summary: PIN_LINK_ALREADY_VERIFIED
      value:
        ErrorCode: 1242
        Message: The email verification link has already been used
        Description: Each link can only be used once, you can log in now if you have already verified the email, OR use the 'forgot pin' option.
    MFA_PHONE_REQUIRED:
      summary: MFA_PHONE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The phoneno2fa is a required parameter.
    TWO_FACTOR_AUTHENTICATION_PHONE_ALREADY_USED:
      summary: TWO_FACTOR_AUTHENTICATION_PHONE_ALREADY_USED
      value:
        ErrorCode: 1106
        Message: This phone number is already registered
        Description: This phone number is already registered on your profile for two factor authentication., please use a different phone number for login.
    TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE_OLD:
      summary: TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE_OLD
      value:
        ErrorCode: 1250
        Message: This is not valid request for updating phone number for two factor authentication
        Description: Google two factor or OTP two factor authentication or security question two factor authentication is already enabled on the profile, please use the update profile API for updating phone number.
    TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE:
      summary: TWO_FACTOR_AUTHENTICATION_INVALID_PHONE_UPDATE
      value:
        ErrorCode: 1250
        Message: Invalid request to update the phone number for two-factor authentication.
        Description: Authenticator, OTP, or security question-based two-factor authentication method is already enabled. Please use the update profile API to update the phone number.
    CONSENT_FORM_NOT_ENABLED:
      summary: CONSENT_FORM_NOT_ENABLED
      value:
        ErrorCode: 1227
        Message: Consent Management is not enabled.
        Description: Consent Management is not enabled, please reach out to LoginRadius support for more information.
    CONSENT_TOKEN_REQUIRED:
      summary: CONSENT_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The consenttoken is a required parameter.
    CONSENT_TOKEN_NOT_VALID:
      summary: CONSENT_TOKEN_NOT_VALID
      value:
        ErrorCode: 1229
        Message: Consent token is invalid
        Description: Consent token is invalid, please use the correct or valid consent token in order to process this request.
    CONSENT_TOKEN_EXPIRED:
      summary: CONSENT_TOKEN_EXPIRED
      value:
        ErrorCode: 1230
        Message: Consent token has expired
        Description: The LoginRadius consent token expired, please request a new consent token from LoginRadius API.
    TOKEN_REQUIRED:
      summary: TOKEN_REQUIRED
      value:
        error: invalid_request
        error_description: The token is a required parameter.
    CONSENT_LOGS_NOT_AVAILABLE:
      summary: CONSENT_LOGS_NOT_AVAILABLE
      value:
        ErrorCode: 1228
        Message: Consent logs not available.
        Description: Consent logs not available.
    EVENT_REQUIRED:
      summary: EVENT_REQUIRED
      value:
        error: invalid_request
        error_description: The event is a required parameter.
    ISCUSTOM_REQUIRED:
      summary: IS_CUSTOM_REQUIRED
      value:
        error: invalid_request
        error_description: The is_custom parameter is a required parameter.
    INVITATION_TOKEN_REQUIRED:
      summary: INVITATION_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The Invitation token is required. Please enter a valid Invitation token.
    TOKEN_TYPE_REQUIRED:
      summary: TOKEN_TYPE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The tokentype is a required parameter.
    API_SECRET_NOT_WELL_FORMATTED:
      summary: API_SECRET_NOT_WELL_FORMATTED
      value:
        ErrorCode: 921
        Message: API secret is invalid
        Description: The provided LoginRadius API secret is invalid, please use a valid API secret of your LoginRadius account.
    API_SECRET_OR_SIGNATURE_REQUIRED:
      summary: API_SECRET_OR_SIGNATURE_REQUIRED
      value:
        ErrorCode: 1209
        Message: API-Signature/API-Secret is missing
        Description: The request is missing the API-Signature/API-Secret, please use a valid API-Signature/API-Secret parameter in order to process this request.
    API_SECRET_REQUIRED:
      summary: API_SECRET_REQUIRED
      value:
        ErrorCode: 923
        Message: API secret is missing
        Description: The request is missing the API secret, please use the valid API secret parameter in order to process this request.
    API_SIGNATURE_REQUIRED:
      summary: API_SIGNATURE_REQUIRED
      value:
        ErrorCode: 1207
        Message: API signature is missing
        Description: The request is missing the API signature, please use a valid API signature parameter in order to process this request.
    EMAILID_OR_USERNAME_REQUIRD:
      summary: EMAILID_OR_USERNAME_REQUIRD
      value:
        ErrorCode: 1141
        Message: Email address or username is required
        Description: Email address or username is required, please use a valid email address or username in order to process this request.
    API_SIGNATURE_INVALID:
      summary: API_SIGNATURE_INVALID
      value:
        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.
    REQUEST_EXPIRY_TIME_INVALID_FORMAT:
      summary: REQUEST_EXPIRY_TIME_INVALID_FORMAT
      value:
        ErrorCode: 1211
        Message: The request expiry time has an invalid format
        Description: The request expiry time has an invalid format, please use a valid date-time format.
    REQUEST_EXPIRY_TIME_REQUIRED:
      summary: REQUEST_EXPIRY_TIME_REQUIRED
      value:
        ErrorCode: 1210
        Message: Request expiry time is missing
        Description: The request is missing the request expiry time, please use a valid request expiry time parameter in order to process this request.
    UID_REQUIRED:
      summary: UID_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The uid is a required parameter.
    EMAIL_TYPE_CAN_NOT_NULL-EMAIL_REQUIRED-UID_REQUIRED:
      summary: EMAIL_TYPE_CAN_NOT_NULL-EMAIL_REQUIRED-UID_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The type is a required parameter,The email is a required parameter,The uid is a required parameter.
    EMAIL_OR_USER_REQUIRED_PARAM:
      summary: EMAIL_OR_USER_REQUIRED_PARAM
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email/username is a required parameter.
    EMAIL_OR_USER_REQUIRED_PARAM-CLIENT_GUID_REQUIRED:
      summary: EMAIL_OR_USER_REQUIRED_PARAM-CLIENT_GUID_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The email/username is a required parameter,The clientguid is a required parameter.
    CLIENT_GUID_REQUIRED-EMAIL_REQUIRED:
      summary: CLIENT_GUID_REQUIRED-EMAIL_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The clientguid is a required parameter,The email is a required parameter.
    INVALID_TOKEN_TYPE:
      summary: INVALID_TOKEN_TYPE
      value:
        ErrorCode: 1181
        Message: You have entered an invalid token type
        Description: The allowed token types are emailverification, addemail, forgotpassword, deleteuser, passwordlesslogin, forgotpin, onetouchlogin and autologin.
    SECRET_DOESNT_HAVE_ACCESS:
      summary: SECRET_DOESNT_HAVE_ACCESS
      value:
        ErrorCode: 1143
        Message: Access Unauthorized
        Description: Your LoginRadius site secret does not have authorization to access this endpoint.
    REQUEST_EXPIRY_TIME_IS_INVALID:
      summary: REQUEST_EXPIRY_TIME_IS_INVALID
      value:
        ErrorCode: 1212
        Message: The request expiry time is invalid
        Description: The request expiry time is invalid, please use a valid request expiry time in order to process this request.
    SMS_OTP_TYPE_REQUIRED:
      summary: SMS_OTP_TYPE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The smsotptype is a required parameter.
    PHONE_REQUIRED_PARAM-UID_REQUIRED:
      summary: PHONE_REQUIRED_PARAM-UID_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The PhoneId is a required parameter,The uid is a required parameter.
    ACCESS_TOKEN_INVALID_OR_EXPIRED:
      summary: ACCESS_TOKEN_INVALID_OR_EXPIRED
      value:
        ErrorCode: 2024
        Message: The Access Token is expired or invalid
        Description: The Access Token is expired or invalid, please request a new Access Token from the LoginRadius API.
    B2B_FEATURE_ENABLED:
      summary: B2B_FEATURE_ENABLED
      value:
        ErrorCode: 8179
        Message: B2B feature is enabled
        Description: Request couldn't be processed, B2B feature is enabled for this site.
    PUT_BODY_INVALID:
      summary: PUT_BODY_INVALID
      value:
        ErrorCode: 1079
        Message: Put body is invalid
        Description: Please use a valid put body and make sure that it is in a valid JSON format.
    PARAMETER_NOT_WELL_FORMATTED_CONTEXT:
      summary: PARAMETER_NOT_WELL_FORMATTED_CONTEXT
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The context is a required parameter.
    PARAMETER_NOT_WELL_FORMATTED_ROLE:
      summary: PARAMETER_NOT_WELL_FORMATTED_ROLE
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The Roles is a required parameter.
    PARAMETER_NOT_WELL_FORMATTED_ROLE_NULL:
      summary: PARAMETER_NOT_WELL_FORMATTED_ROLE_NULL
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of Roles can not be null or empty.
    INVALID_DATE_ROLES:
      summary: INVALID_DATE_ROLES
      value:
        ErrorCode: 1172
        Message: Invalid date
        Description: A date was specified that was not in the correct format or not a valid date.
    ROLE_DOES_NOT_EXISTS:
      summary: ROLE_DOES_NOT_EXISTS
      value:
        ErrorCode: 1047
        Message: Role does not exist
        Description: The provided Role for the user does not exist, please use a valid Role in order to process this request.
    CONTEXT_NAME_REQUIRED:
      summary: CONTEXT_NAME_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The contextName is a required parameter.
    ROLE_CONTEXT_NOT_VALID:
      summary: ROLE_CONTEXT_NOT_VALID
      value:
        ErrorCode: 1133
        Message: Role Context Name is not Valid.
        Description: Your Role context name is not valid, please use a valid Role context name.
    ROLES_CAN_NOT_BE_EMPTY:
      summary: ROLES_CAN_NOT_BE_EMPTY
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of Roles can not be null or empty.
    PARAMETER_NOT_WELL_FORMATTED_ADDPERMISSION_NULL:
      summary: PARAMETER_NOT_WELL_FORMATTED_ADDPERMISSION_NULL
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of additionalPermissions can not be null or empty.
    PARAMETER_NOT_WELL_FORMATTED_ADDPERMISSION:
      summary: PARAMETER_NOT_WELL_FORMATTED_ADDPERMISSION
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The additionalPermissions is a required parameter.
    ADDITIONALPERMISSIONS_NOT_EXITS:
      summary: ADDITIONALPERMISSIONS_NOT_EXITS
      value:
        ErrorCode: 1142
        Message: Additional Permission does not exist
        Description: Additional Permission for the user does not exist, please use a valid additional Permission in order to process this request.
    IP_ACCESS_DENIED:
      summary: IP_ACCESS_DENIED
      value:
        ErrorCode: 1206
        Message: IP Access Denied
        Description: Access denied to the resource due to unauthorized IP.
    REFRESH_TOKEN_REQUIRED:
      summary: REFRESH_TOKEN_REQUIRED
      value:
        ErrorCode: 1337
        Message: Refresh token is missing from social ID provider
        Description: The ID Provider refresh token is required to generate the LoginRadius access token, please use the correct token in order to process this request.
    REFRESH_TOKEN_INVALID:
      summary: REFRESH_TOKEN_INVALID
      value:
        ErrorCode: 1217
        Message: Refresh token invalid
        Description: LoginRadius refresh token is invalid.
    OPERATION_FAILED_OIDC:
      summary: OPERATION_FAILED_OIDC
      value:
        Message: Operation failed due to an unknown error
        Description: An unknown error has occurred, please try again in a few minutes or contact your system admin.
        ErrorCode: 950
    Q_REQUIRED:
      summary: Q_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The q is a required parameter.
    Q_NOT_VALID:
      summary: Q_NOT_VALID
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of q is not valid.
    QUERY_KEY_REQUIRED:
      summary: QUERY_KEY_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The query key is a required parameter.
    QUERY_VALUE_REQUIRED:
      summary: QUERY_VALUE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The query value is a required parameter.
    MULTIPLE_QUERY_PARAMETERS:
      value:
        ErrorCode: 1277
        Message: Multiple query parameters
        Description: Multiple query parameters in request. Please pass any required one.
    QUERY_KEY_INDEX_NOT_FOUND:
      summary: QUERY_KEY_INDEX_NOT_FOUND
      value:
        ErrorCode: 1341
        Message: Query key index not found
        Description: The specified query key index does not exist, please reach out to LoginRadius support for more information.
    USERNAME_NOT_EXISTS:
      value:
        ErrorCode: 1022
        Message: Username does not exist
        Description: The provided username does not exist. Please enter a valid username.
    PHONE_NUMBER_LOGIN_ENABLED:
      value:
        ErrorCode: 1077
        Message: Phone number login is enabled
        Description: The phone number login is enabled, so login or get Profile by email ID is unavailable. Please use a verified phone number for login or get Profile.
    UID_IS_NOT_VALID:
      value:
        ErrorCode: 1200
        Message: Uid is not valid
        Description: The uid is not valid. The uid can contain alphabets, digits, underscore, and dash only, and its length must be between 1 to 50.
    ACCOUNT_ID_IS_ALREADY_REGISTERED:
      summary: ACCOUNT_ID_IS_ALREADY_REGISTERED
      value:
        ErrorCode: 1044
        Message: This account ID is already registered with your site
        Description: The account ID has to be unique for your site. Please use a different account ID to process this request.
    PRIVACY_POLICY_NOT_VALID:
      summary: PRIVACY_POLICY_NOT_VALID
      value:
        ErrorCode: 1197
        Message: Privacy Policy version is not valid
        Description: The Privacy Policy version is not valid.
    INVALID_EMAIL:
      value:
        ErrorCode: 8137
        Message: Invalid email
        Description: Invalid email, Please provide valid email.
    USERNAME_REQUIRED_CORE:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The UserName is a required parameter. Please provide a valid UserName to process the request.
    INVALID_REQUEST_BODY:
      value:
        ErrorCode: 1090
        Message: Invalid request body or payload
        Description: An error has occurred while parsing the API payload. Please review the request and try again.
    SEND_EMAIL_INVALID_PARAMETER:
      summary: SEND_EMAIL_INVALID_PARAMETER
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value 'invalid_value' is not valid for sendemail.
    VERIFICATION_TYPE_REQUIRED:
      summary: VERIFICATION_TYPE_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The vtype is a required parameter.
    VTYPE_INVALID:
      summary: VTYPE_INVALID
      value:
        ErrorCode: 1306
        Message: The vtype is invalid
        Description: The provided vtype is invalid, please provide a valid verification type (email).
    EXPIRE_IN_INVALID_FORMAT:
      summary: EXPIRE_IN_INVALID_FORMAT
      value:
        Description: Please provide expiry time in number format only.
        ErrorCode: 1307
        Message: The expires_in has invalid format
    EMAIL_CAN_NOT_NULL:
      summary: EMAIL_CAN_NOT_NULL
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value of email can not be null or empty.
    EMAIL_TYPE_AND_VALUE_CAN_NOT_NULL:
      summary: EMAIL_TYPE_AND_VALUE_CAN_NOT_NULL
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The type is a required parameter,The value is a required parameter
    EMAIL_VALUE_CAN_NOT_NULL:
      summary: EMAIL_VALUE_CAN_NOT_NULL
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The value is a required parameter
    CAN_NOT_ENFORCE_EMAIL_INVALIDATION:
      summary: CAN_NOT_ENFORCE_EMAIL_INVALIDATION
      value:
        ErrorCode: 1113
        Message: The profile cannot be enforced to invalidate the email verification.
        Description: The request could not be processed. There is no email profile associated with this UID, thus the email verification cannot be enforced.
    EMAIL_ALREADY_UNVERIFIED:
      summary: EMAIL_ALREADY_UNVERIFIED
      value:
        ErrorCode: 1115
        Message: The profile cannot be enforced to invalidate the email verification.
        Description: The request could not be processed. Email already unverified associated with UID, thus cannot enforce email verification.
    CAN_NOT_ENFORCE_PHONE_INVALIDATION:
      summary: CAN_NOT_ENFORCE_PHONE_INVALIDATION
      value:
        ErrorCode: 1147
        Message: The profile cannot be enforced to invalidate the phone verification.
        Description: The request could not be processed. There is no phone profile associated with UID, so the phone verification cannot be enforced.
    PHONE_NUMBER_ALREADY_UNVERIFIED:
      summary: PHONE_NUMBER_ALREADY_UNVERIFIED
      value:
        ErrorCode: 1161
        Message: This phone number is already unverified
        Description: This phone number is unverified, cannot invalidate.
    SECOND_FACTOR_VALIDATION_TOKEN_REQUIRED:
      summary: SECOND_FACTOR_VALIDATION_TOKEN_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The secondfactorvalidationtoken is a required parameter.
    SECOND_FACTOR_VERIFICATION_TOKEN_NOT_VALID:
      summary: SECOND_FACTOR_VERIFICATION_TOKEN_NOT_VALID
      value:
        ErrorCode: 1193
        Message: Two factor validation token is invalid
        Description: The LoginRadius two factor Validation token is invalid, please use the correct or valid token in order to process this request.
    GENERIC_REQUIRED:
      summary: GENERIC_REQUIRED
      value:
        errorCode: 908
        message: A parameter is not formatted correctly
        description: A parameter is not formatted correctly in the request, please check all the parameters in the API call.
    OAUTH_TOKEN_CONFIG_NOT_FOUND_NATIVE:
      summary: OAUTH_TOKEN_CONFIG_NOT_FOUND
      value:
        errorCode: 2017
        message: Request is invalid
        description: Unable to retrieve token configuration for the specified app.
    API_SECRET_NOT_VALID_NATIVE:
      summary: API_SECRET_NOT_VALID
      value:
        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.
    ACCESS_TOKEN_NOT_VALID_NATIVE:
      summary: ACCESS_TOKEN_NOT_VALID
      value:
        errorCode: 905
        message: Access token is invalid
        description: The LoginRadius access token is invalid, please use the correct or valid access token in order to process this request.
    ACCESS_TOKEN_EXPIRED_NATIVE:
      summary: ACCESS_TOKEN_EXPIRED
      value:
        errorCode: 906
        message: Access token has expired
        description: The LoginRadius access token has expired, please request a new token from LoginRadius API.
    REFRESH_TOKEN_INVALID_NATIVE:
      summary: REFRESH_TOKEN_INVALID_NATIVE
      value:
        errorCode: 1217
        message: Refresh token invalid
        description: LoginRadius refresh token is invalid.
    APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT_NATIVE:
      summary: APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT
      value:
        errorCode: 909
        message: Your LoginRadius site does not have permission to access this endpoint
        description: Your LoginRadius site does not have permission to access this endpoint, please contact LoginRadius support for more information.
    ENDPOINT_NOT_SUPPORTED_BY_CURRENT_PROVIDER:
      summary: ENDPOINT_NOT_SUPPORTED_BY_CURRENT_PROVIDER
      value:
        errorCode: 910
        message: Endpoint is not supported by the current provider
        description: The requested endpoint is not supported by this social identity provider.
    PROVIDER_SIDE_ERROR_NATIVE:
      summary: PROVIDER_SIDE_ERROR
      value:
        errorCode: 1000
        message: An error has occurred at the social identity provider’s end.
        description: An error has occurred at the social identity provider’s end, please check the ‘providerErrorResponse’ for more details.
    DANGEROUS_REQUEST_NATIVE:
      summary: DANGEROUS_REQUEST
      value:
        errorCode: 1214
        message: Dangerous request
        description: A potentially dangerous request value was detected.
    REQUEST_TOKEN_NOT_VALID_NATIVE:
      summary: REQUEST_TOKEN_NOT_VALID
      value:
        errorCode: 903
        message: Request token is invalid
        description: The LoginRadius request token is invalid, please check the POST request on your callback page and the token field in the request.
    REQUEST_TOKEN_EXPIRED:
      summary: REQUEST_TOKEN_EXPIRED
      value:
        errorCode: 904
        message: Request token has expired
        description: The LoginRadius request token has expired, please request a new token from LoginRadius API.
    API_KEY_REQUIRED_NATIVE:
      summary: API_KEY_REQUIRED
      value:
        errorCode: 922
        message: API key is missing
        description: The request is missing the API key, please use the valid API key parameter in order to process this request.
    API_SECRET_REQUIRED_NATIVE:
      summary: API_SECRET_REQUIRED
      value:
        errorCode: 923
        message: API secret is missing
        description: The request is missing the API secret, please use the valid API secret parameter in order to process this request.
    API_SECRET_NOT_WELL_FORMATTED_NATIVE:
      summary: API_SECRET_NOT_WELL_FORMATTED
      value:
        errorCode: 921
        message: API secret is invalid
        description: The provided LoginRadius API secret is invalid, please use a valid API secret of your LoginRadius account.
    API_KEY_NOT_WELL_FORMATTED_NATIVE:
      summary: API_KEY_NOT_WELL_FORMATTED
      value:
        errorCode: 920
        message: API key is invalid
        description: The provided LoginRadius API key is invalid, please use a valid API key of your LoginRadius account.
    API_KEY_NOT_VALID_NATIVE:
      summary: API_KEY_NOT_VALID
      value:
        errorCode: 901
        message: The API key is unauthorized
        description: The provided LoginRadius API key is invalid or is not authorized, please use a valid or authorized LoginRadius API key or check the API key for your LoginRadius account.
    PROFILE_ID_MISSING:
      summary: PROFILE_ID_MISSING
      value:
        errorCode: 1061
        message: Profile ID is missing
        description: This request is missing the Profile ID, please use a valid Profile ID parameter in order to process this request.
    USER_ID_NOT_VALID_NATIVE:
      summary: USER_ID_NOT_VALID
      value:
        errorCode: 937
        message: User ID is invalid
        description: The user ID is invalid, please use a valid user ID in order to process this request.
    ACCOUNT_ID_REQUIRED:
      summary: ACCOUNT_ID_REQUIRED
      value:
        errorCode: 1037
        message: Account ID is required
        description: The account ID is required, please use a valid account ID in order to process this request.
    ACCOUNT_ID_IS_INVALID_NATIVE:
      summary: ACCOUNT_ID_IS_INVALID
      value:
        errorCode: 984
        message: Account ID is invalid
        description: This Account ID is invalid, please use valid account ID.
    ACTIVE_TOKEN_NOT_EXISTS:
      summary: ACTIVE_TOKEN_NOT_EXISTS
      value:
        errorCode: 1055
        message: Session has expired
        description: The LoginRadius session token has expired, there is no current active session for this user.
    ACCESS_TOKEN_REQUIRED_OIDC:
      summary: ACCESS_TOKEN_REQUIRED
      value:
        errorCode: 1060
        message: Access token is missing
        description: This request is missing the access token, please use the valid access token parameter in order to process this request.
    JWTAPP_PROVIDER_REQUIRED:
      summary: JWTAPP_PROVIDER_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The providername is a required parameter.
    PROVIDER_NAME_REQUIRED:
      summary: PROVIDER_NAME_REQUIRED
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The providerName is a required parameter.
    API_KEY_REQUIRED_PROVIDER:
      summary: API_KEY_REQUIRED_PROVIDER
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The apikey is a required parameter.
    PROVIDER_NAME_NOT_VALID:
      summary: PROVIDER_NAME_NOT_VALID
      value:
        ErrorCode: 912
        Message: Provider is not valid
        Description: The provider name is invalid, please use a valid provider name.
    INVITATION_ID_REQUIRED:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The invitation id is required.
    INVALID_INVITATION_ID:
      value:
        ErrorCode: 8175
        Message: The invitation id/token is invalid
        Description: The invitation id is invalid. Please enter a valid invitation id.
    B2B_NOT_ENABLED:
      summary: B2B_NOT_ENABLED
      value:
        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
    UNAUTHORIZED_ACCESS:
      value:
        Message: Access Unauthorized
        Description: Access Unauthorized, please use valid authorization to access this endpoint.
        ErrorCode: 6002
    ORGANIZATION_NOT_FOUND_PARTNER:
      summary: ORGANIZATION_NOT_FOUND_PARTNER
      value:
        Description: The entered organization or its configuration does not exist.
        ErrorCode: 8118
        Message: Organization not found
    INVALID_JSON_BODY:
      value:
        ErrorCode: 8044
        Message: Invalid Body
        Description: BodyType is selected as JSON, but the Body doesn't contain valid JSON data. Please input valid JSON data.
    JSON_PUT_BODY_REQUIRED_PARTNER:
      summary: JSON_PUT_BODY_REQUIRED_PARTNER
      value:
        Message: Put body is invalid or empty
        Description: Please use a valid put body in JSON format in order to process this request.
        ErrorCode: 7934
    ROLE_OR_RESEND_EMAIL_REQUIRED:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The RoleIds or ResendEmail field is required. Please enter at least one field.
    INVALID_INVITATION_URL:
      value:
        ErrorCode: 8176
        Message: The Invitation URL is invalid
        Description: The Invitation is invalid, please whitelist the url.
    INVITATION_ACCEPTED:
      value:
        ErrorCode: 8175
        Message: The invitation id/token is invalid
        Description: This invitation id/token is accepted. Please enter a valid invitation id/token.
    INVITATION_EXPIRED:
      value:
        ErrorCode: 8175
        Message: The invitation id/token is invalid
        Description: This invitation id/token is expired. Please enter a valid invitation id/token.
    INVITATION_REVOKED:
      value:
        ErrorCode: 8175
        Message: The invitation id/token is invalid
        Description: This invitation id/token is revoked. Please enter a valid invitation id/token.
    INVALID_ROLE_ID:
      value:
        Description: Invalid Role id, Please provide valid Role id.
        ErrorCode: 8124
        Message: Invalid Role id
    INVALID_INVITER_UID:
      value:
        ErrorCode: 8174
        Message: Inviter uid invalid or inviter does not exist/active
        Description: Inviter uid invalid or inviter does not exist/active, Please provide the valid inviter uid.
    ROLE_NOT_EXIST:
      value:
        ErrorCode: 8125
        Message: Role does not exist
        Description: Role does not exist, Please provide valid Role id.
    ORGANIZATION_ID_REQUIRED:
      value:
        ErrorCode: 8129
        Message: Organization id is required
        Description: Organization id is required, Please provide organization id.
    ORGANIZATION_ID_INVALID:
      value:
        Description: This Organization ID is invalid, please use valid Organization ID.
        ErrorCode: 8117
        Message: Organization ID is invalid
    JSON_POST_BODY_REQUIRED:
      value:
        ErrorCode: 7914
        Message: Post body is invalid
        Description: Please use a valid post body in JSON format.
    SEND_INVITATION_REQUIRED:
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly
        Description: The OrgId, InviterUid, EmailId, RoleIds are required.
    INVITATION_ALREADY_ACTIVE:
      value:
        ErrorCode: 8171
        Message: invitation is active
        Description: Invitation is already active, Can not send the invite again.
    USER_EXISTS_IN_ORG:
      value:
        ErrorCode: 8170
        Message: User already exist in an organization
        Description: User already exist in an organization, Please provide correct email id.
    DOMAIN_DUPLICATE:
      value:
        Description: The Domain is already in use. Please enter a valid Domain.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    DOMAIN_NAME_INVALID:
      value:
        Description: The DomainName is invalid. Please enter a valid DomainName.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    DOMAIN_NO_VALID_MX_RECORD:
      value:
        Description: The domain is not configured to handle emails. Please verify that the domain has valid MX records set up.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    DOMAIN_SPAM_OR_GENERIC_DOMAIN:
      value:
        Description: The Domain is a spam or generic domain. Please enter a valid Domain.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    NAME_REQUIRED:
      value:
        Description: The Name is required. Please enter a valid Name.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    TRIAL_PLAN_ORG_LIMIT_REACHED:
      value:
        Message: Organization creation limit reached for the trial plan
        Description: The trial plan organization creation limit has been reached. Upgrade your plan to create more organizations.
        ErrorCode: 8188
    ORGANIZATION_ALREADY_EXIST:
      value:
        Description: Organization exists with the same name. Use a different organization name.
        ErrorCode: 8116
        Message: Organization exists with the same name
    ORGANIZATION_DOMAIN_ALREADY_EXIST:
      value:
        Description: Domain exists with the same name. Use a different Domain name.
        ErrorCode: 8157
        Message: Domain exists with the same name
    ORGANIZATION_MEMBER_ROLE_NOT_VALID:
      value:
        Description: This Organization member Role is invalid, please use valid Organization member Role
        ErrorCode: 8159
        Message: Organization member Role is invalid
    STATUS_UPDATE_INVALID:
      value:
        Description: Status update is invalid, Please provide valid status.
        ErrorCode: 8167
        Message: Status update is invalid
    ORGANIZATION_DOMAIN_CAN_NOT_DELETED:
      value:
        Description: Organization domain can not be deleted, domain is currently being used in a connection.
        ErrorCode: 8178
        Message: Organization domain can not be deleted
    ORGANIZATION_JIT_POLICY_NOT_ALLOWED:
      value:
        Description: Just-In-Time (JIT) provisioning is not allowed because there are no active connections configured for this organization. Please check your organization settings.
        ErrorCode: 8181
        Message: JIT policy not allowed in organization
    ORGANIZATION_MFA_ENFORCEMENT_NOT_ALLOWED:
      value:
        Description: Organization MFA enforcement can not be enabled because MFA is disabled for the tenant.
        ErrorCode: 8160
        Message: Organization MFA enforcement not allowed
    ORGANIZATION_MFA_NONE_ENFORCEMENT_NOT_ALLOWED:
      value:
        Description: Organization MFA enforcement can not be disabled because MFA is enabled for the tenant.
        ErrorCode: 8160
        Message: Organization MFA enforcement not allowed
    ORGANIZATION_MFA_ENFORCEMENT_ONLY_FORCE_ALLOWED:
      value:
        Description: MFA enforcement must be set to 'Force' because this tenant has a mandatory MFA flow configured.
        ErrorCode: 8160
        Message: Organization MFA enforcement not allowed
    ORGANIZATION_MFA_FORCE_AUTHENTICATORS_DISABLED:
      value:
        Description: To enable 'force' MFA enforcement, at least one MFA authenticator method must be enabled for this tenant.
        ErrorCode: 8160
        Message: Organization MFA enforcement not allowed
    ORGANIZATION_ENABLE_MFA_ENFORCEMENT_NOT_ALLOWED:
      value:
        Description: Organization MFA enforcement can not be enabled because MFA is disabled for the tenant.
        ErrorCode: 8160
        Message: Organization MFA enforcement not allowed
    ORGANIZATION_DISABLE_MFA_ENFORCEMENT_NOT_ALLOWED:
      value:
        Description: Organization MFA enforcement can not be disabled because MFA is enabled for the tenant.
        ErrorCode: 8160
        Message: Organization MFA enforcement not allowed
    CONNECTION_DOMAIN_ALREADY_EXIST:
      value:
        Description: The domain is associated with a different connection. Please use a different organization domain.
        ErrorCode: 8149
        Message: Domain exists with another connection
    STATUS_UPDATED_ALREADY:
      value:
        Description: Status already updated, Please provide valid status.
        ErrorCode: 8166
        Message: Status already updated
    CONNECTION_TYPE_INVALID:
      value:
        Description: The ConnectionType is invalid. Please enter a valid ConnectionType.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    CONNECTION_TYPE_REQUIRED:
      value:
        Description: The ConnectionType is required. Please enter a valid ConnectionType.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    CUSTOM_MAPPING_INVALID:
      value:
        Description: The CustomMapping provided is invalid. Please enter a valid CustomMapping.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    NAME_INVALID:
      value:
        Description: Invalid Name. It must be alphanumeric, hyphens (-), underscores (_), not start/end with hyphen/underscore, and max length 60.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    OIDC_IDP_ISSUER_INVALID:
      value:
        Description: The provided Identity Provider (IdP) issuer is invalid. Please verify the Issuer
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    CONN_SAML_IDP_CERTIFICATE_INVALID:
      value:
        Description: The IdpCertificate is invalid. Please enter a valid IdpCertificate.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    SAML_METADATA_ENDPOINT_INVALID:
      value:
        Description: The provided SAML metadata endpoint is invalid or not accessible. Please verify the IDPMetadataURL
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    ORGANIZATION_DOMAIN_NOT_VERIFIED:
      value:
        Description: Organization domain is not verified, Please verify the domain.
        ErrorCode: 8177
        Message: Organization domain is not verified
    ORGANIZATION_DOMAIN_NOT_EXIST:
      value:
        Description: The provided domain is not associated with the organization. Please use a different organization domain.
        ErrorCode: 8150
        Message: Domain does not exist within the organization
    CONNECTION_ALREADY_EXIST:
      value:
        Description: Connection exists with the same name. Use a different Connection name.
        ErrorCode: 8148
        Message: Connection exists with the same name
    CONNECTION_ID_INVALID:
      value:
        Description: This Connection ID is invalid, please use valid Connection ID.
        ErrorCode: 8151
        Message: Connection ID is invalid
    GROUP_ROLE_GROUP_ID_REQUIRED:
      value:
        Description: The GroupId is required. Please enter a valid GroupId.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    GROUP_ROLE_ROLE_ID_INVALID:
      value:
        Description: The RoleId is invalid. Please enter a valid RoleId.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    GROUP_ROLE_ROLE_ID_REQUIRED:
      value:
        Description: The RoleId is required. Please enter a valid RoleId.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    GROUP_ROLE_NAME_ALREADY_EXIST:
      value:
        Description: Connection GroupRole exists with the same name. Use a Connection GroupRole name.
        ErrorCode: 8161
        Message: GroupRole exists with the same name
    GROUP_ROLE_GROUP_ID_ALREADY_EXIST:
      value:
        Description: Connection GroupRole exists with the same GroupId. Use a different GroupRole GroupId.
        ErrorCode: 8162
        Message: GroupRole exists with the same GroupId
    GROUP_ROLE_ID_INVALID:
      value:
        Description: This GroupRole ID is invalid, Please use a valid GroupRole ID.
        ErrorCode: 8164
        Message: GroupRole ID is invalid
    GROUP_ROLE_NOT_EXIST:
      value:
        Description: This GroupRole ID is not exist, Please use a valid GroupRole ID.
        ErrorCode: 8163
        Message: GroupRole ID not exist
    ORGANIZATION_DOMAIN_ID_INVALID:
      value:
        Description: This Domain ID is invalid, please use valid Domain ID.
        ErrorCode: 8154
        Message: Domain ID is invalid
    ORGANIZATION_DOMAIN_NAME_INVALID:
      value:
        Description: The DomainName is invalid. Please enter a valid DomainName.
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
    DOMAIN_TXT_RECORD_FAILED:
      value:
        Description: Unable to fetch the Domain TXT record. Please ensure the domain is valid and correctly configured.
        ErrorCode: 8168
        Message: Failed to fetch Domain TXT record
    ORGANIZATION_DOMAIN_ALREADY_VERIFY:
      value:
        Description: This Organization domain is already verified
        ErrorCode: 8156
        Message: Domain already verified
    PARAMETER_NOT_WELL_FORMATTED_REQUIRED:
      value:
        Message: A parameter is not formatted correctly.
        Description: The parameter is not formatted correctly, please check all the parameters in the API call
        ErrorCode: 7900
    INVALID_ID:
      value:
        Message: Invalid ID
        Description: Invalid ID, please provide a valid ID.
        ErrorCode: 8080
    DUPLICATE_PERMISSION_NAME:
      value:
        ErrorCode: 8120
        Message: Duplicate Permission name
        Description: Duplicate Permission name, Please provide valid Permission name.
    PERMISSION_ID_REQUIRED:
      value:
        ErrorCode: 8122
        Message: Permission id is required
        Description: Permission id is required, Please provide Permission id.
    PERMISSION_ID_INVALID:
      value:
        ErrorCode: 8119
        Message: Invalid Permission id
        Description: Invalid Permission id, Please provide valid Permission id.
    NAME_NOT_ALLOWED_TO_UPDATE:
      value:
        ErrorCode: 8231
        Message: Name field is not allowed to update
        Description: Name field is not allowed to update. Please use the same name value in update request.
    INVALID_BODY_JSON:
      value:
        Message: Invalid Body
        Description: BodyType is selected as JSON, but the Body doesn't contain valid JSON data. Please input valid JSON data.
        ErrorCode: 8044
    DUPLICATE_ROLE_NAME:
      value:
        ErrorCode: 8123
        Message: Duplicate Role name
        Description: Duplicate Role name, Please provide valid Role name.
    ROLE_ID_REQUIRED:
      value:
        ErrorCode: 8126
        Message: Role id is required
        Description: Role id is required, Please provide Role id.
    DEFAULT_ROLE_CANNOT_BE_DELETED:
      value:
        ErrorCode: 8128
        Message: Default Role cannot be deleted
        Description: Default Role cannot be deleted, Please provide valid Role id.
    ROLE_NAME_REQUIRED:
      value:
        ErrorCode: 8127
        Message: Role name is required
        Description: Role name is required, Please provide Role name.
    ROLE_DOES_NOT_BELONGS_TO_TENANT:
      value:
        ErrorCode: 8143
        Message: Role does not belong to tenant
        Description: Role does not belong to tenant, Please provide valid Role id.
    USER_ID_REQUIRED:
      value:
        ErrorCode: 8131
        Message: User id is required
        Description: User id is required, Please provide user id.
    USER_DOES_NOT_EXISTS:
      value:
        ErrorCode: 8132
        Message: User does not exist
        Description: User does not exist, Please provide valid user id.
    USER_NOT_FOUND_IN_ORG:
      value:
        Description: User not found in organization, Please provide valid user id.
        ErrorCode: 8135
        Message: User not found in organization
    ROLE_DOES_NOT_BELONGS_TO_ORG:
      value:
        ErrorCode: 8142
        Message: Role does not belong to organization
        Description: Role does not belong to organization, Please provide valid Role id.
    B2B_EMAIL_NOT_AVAILABLE:
      summary: B2B_EMAIL_NOT_AVAILABLE
      value:
        ErrorCode: 8045
        Message: Email is missing
        Description: Cannot assign Role to the user in the organization because the email is not available for the user. Please provide a valid uid.
    USER_ROLE_ALREADY_EXISTS:
      value:
        ErrorCode: 8130
        Message: User Role already exists
        Description: User Role already exists, Please provide valid Role id.
    PARAMETER_NOT_WELL_FORMATTED:
      value:
        Message: A parameter is not formatted correctly.
        Description: A parameter is not formatted correctly in the request, please check all the parameters in the API call
        ErrorCode: 7900
    SOTT_NOT_FOUND:
      value:
        Message: SOTT not found
        Description: SOTT not found or the resource does not exist.
        ErrorCode: 8068
    TECHNOLOGY_SELECTION_INVALID:
      value:
        Message: Sott configuration is invalid
        Description: Technology selection is invalid, Please provide valid value.
        ErrorCode: 8101
    IDENTITY_ORCHESTRATION_NOT_ENABLED:
      value:
        ErrorCode: 8070
        Message: Workflows are not enabled for this app/site.
        Description: The request cannot be processed. Please enable workflows and try again to proceed with this request.
    WORKFLOW_CONFIG_NOT_FOUND:
      value:
        Message: Workflow config not found.
        Description: Workflow config not found, Please configure the workflow config.
        ErrorCode: 8033
    WORKFLOW_PAYLOAD:
      value:
        Name: mfa-auth
        ThemeName: default
        Data:
          edges:
            - id: reactflow__edge-6799ebff-ab72-4ebd-869b-65672bd0a799true-SuccessFinalNode
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: 6799ebff-ab72-4ebd-869b-65672bd0a799
              sourceHandle: 'true'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: SuccessFinalNode
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-6799ebff-ab72-4ebd-869b-65672bd0a799false-FailureFinalNode
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: 6799ebff-ab72-4ebd-869b-65672bd0a799
              sourceHandle: 'false'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: FailureFinalNode
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913false-1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              sourceHandle: 'false'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-1eb72cc9-7a2c-44f7-817d-00a94a9c1a24authenticator-ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              sourceHandle: authenticator
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-ac8ae2f4-48b9-4c35-bd68-4cbf11730b8bfalse-FailureFinalNode
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              sourceHandle: 'false'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: FailureFinalNode
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-initialNodeoutput-dd8723a2-afc1-4529-a0a6-2c0712af3e65
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: initialNode
              sourceHandle: output
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-dd8723a2-afc1-4529-a0a6-2c0712af3e65output-b92fb05a-578a-4097-aec0-2df33b4c27a0
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              sourceHandle: output
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: b92fb05a-578a-4097-aec0-2df33b4c27a0
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-b92fb05a-578a-4097-aec0-2df33b4c27a0true-e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: b92fb05a-578a-4097-aec0-2df33b4c27a0
              sourceHandle: 'true'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-b92fb05a-578a-4097-aec0-2df33b4c27a0false-FailureFinalNode
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: b92fb05a-578a-4097-aec0-2df33b4c27a0
              sourceHandle: 'false'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: FailureFinalNode
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-ac8ae2f4-48b9-4c35-bd68-4cbf11730b8btrue-4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              sourceHandle: 'true'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913authenticator-4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              sourceHandle: authenticator
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-4fd9fc82-5cc5-4410-94c7-cc8ac301a31eoutput-6799ebff-ab72-4ebd-869b-65672bd0a799
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              sourceHandle: output
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: 6799ebff-ab72-4ebd-869b-65672bd0a799
              targetHandle: null
              type: smoothstep
          innerNodes:
            46d6674e-bbc6-44bc-951f-98cffd6441b6:
              data:
                description: Displays the option to field to enter TOTP (when Authenticator is already configured).
                label: Authenticator Input
                properties: null
              dragging: 'false'
              extent: parent
              height: '50'
              hidden: 'true'
              id: 46d6674e-bbc6-44bc-951f-98cffd6441b6
              isChildNode: 'true'
              nodes: null
              parentNode: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              position:
                x: '290.33256209500405'
                'y': '-206.97348008280136'
              positionAbsolute:
                x: '290.33256209500405'
                'y': '-206.97348008280136'
              selected: 'false'
              type: authenticatorinput
              width: '150'
            a655db76-8831-411b-82f5-1be2784e4a78:
              data:
                description: Prompts the user to enter the email and stores the input. It is used with the Web Page node.
                label: Email
                properties:
                  - elementType: emailonlyasinput
                    id: '1'
                    label: Email Only as Input
                    type: checkbox
                    value: 'false'
                  - elementType: isprimary
                    id: '2'
                    label: Is Primary
                    primaryParentId: '1'
                    type: checkbox
                    value: 'true'
                  - elementType: emailtype
                    id: '3'
                    label: Email Type
                    primaryParentId: '1'
                    secondaryParentId: '2'
                    type: text
                    value: ''
                  - elementType: rules
                    id: '4'
                    label: Validation String
                    primaryParentId: '1'
                    type: text
                    value: ''
              draggable: 'true'
              dragging: 'false'
              extent: parent
              height: '50'
              hidden: 'true'
              id: a655db76-8831-411b-82f5-1be2784e4a78
              isChildNode: 'true'
              nodes: null
              parentNode: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              position:
                x: '-499.8966093003752'
                'y': '-455.39881839572'
              positionAbsolute:
                x: '-499.8966093003752'
                'y': '-455.39881839572'
              selected: 'false'
              type: email
              width: '150'
            fff21a66-437c-4a8a-96e0-744efaff8d87:
              data:
                description: Prompts the user to enter their password and stores the input. This node is to be used for entering the password during registration, login, password update and password forget etc. It is used with the Web Page node.
                label: Password
                properties:
                  - elementType: passwordonlyasinput
                    id: '1'
                    label: Password Only as Input
                    tag: password
                    type: checkbox
                    value: 'false'
                  - elementType: oldpassword
                    id: '2'
                    label: Old Password
                    primaryParentId: '1'
                    tag: password
                    type: checkbox
                    value: 'false'
                  - elementType: newpassword
                    id: '3'
                    label: New Password
                    primaryParentId: '1'
                    tag: password
                    type: checkbox
                    value: 'false'
                  - elementType: confirmpassword
                    id: '4'
                    label: Confirm Password
                    primaryParentId: '1'
                    tag: password
                    type: checkbox
                    value: 'false'
                  - elementType: validatepassword
                    id: '5'
                    label: Validate Password
                    primaryParentId: '1'
                    tag: policy
                    type: checkbox
                    value: 'false'
              draggable: 'true'
              dragging: 'false'
              extent: parent
              height: '50'
              hidden: 'true'
              id: fff21a66-437c-4a8a-96e0-744efaff8d87
              isChildNode: 'true'
              nodes: null
              parentNode: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              position:
                x: '-480.96896447653376'
                'y': '-480.2413522270118'
              positionAbsolute:
                x: '-480.96896447653376'
                'y': '-480.2413522270118'
              selected: 'false'
              type: password
              width: '150'
          nodes:
            1eb72cc9-7a2c-44f7-817d-00a94a9c1a24:
              data:
                description: 'Define the MFA flow (mandatory or optional), settings and method(s) for all users. To let users register/configure the MFA method from the available method(s) on login. '
                label: Configure MFA
                properties:
                  - elementType: mfaflow
                    id: '1'
                    label: MFA Flow
                    options:
                      - text: Mandatory
                        value: Mandatory
                      - text: Optional
                        value: Optional
                    required: 'true'
                    type: select
                    value: Mandatory
                  - elementType: message
                    id: '2'
                    label: Message
                    required: 'true'
                    type: text
                    value: Authenticator
                  - elementType: mfamethods
                    id: '3'
                    label: MFA Methods
                    options:
                      - checked: 'false'
                        text: Authenticator
                        value: Authenticator
                      - checked: 'false'
                        text: Security Question
                        value: Security Question
                      - checked: 'false'
                        text: Email OTP
                        value: Email OTP
                      - checked: 'false'
                        text: SMS OTP
                        value: SMS OTP
                    outputSelector: 'true'
                    required: 'true'
                    type: multiselect
                    value:
                      - Authenticator
                  - elementType: authenticatorbuttontext
                    id: '4'
                    label: Authenticator Button Text
                    parentPropertyId: '3'
                    parentPropertyValue: Authenticator
                    required: 'true'
                    type: text
                    value: Configure Authenticator
                  - elementType: securityquestionbuttontext
                    id: '5'
                    label: Security Question Button Text
                    parentPropertyId: '3'
                    parentPropertyValue: Security Question
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: emailotpbuttontext
                    id: '6'
                    label: Email OTP Button Text
                    parentPropertyId: '3'
                    parentPropertyValue: Email OTP
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: smsotpbuttontext
                    id: '7'
                    label: SMS OTP Button Text
                    parentPropertyId: '3'
                    parentPropertyValue: SMS OTP
                    required: 'true'
                    type: text
                    value: ''
              dragging: 'false'
              height: '130'
              id: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              nodes: null
              output:
                - displayName: EmailOTP
                  id: emailotp
                - displayName: SMSOTP
                  id: smsotp
                - displayName: Authenticator
                  id: authenticator
                - displayName: SecurityQuestion
                  id: securityquestion
                - displayName: Skip
                  id: skip
                - displayName: 'False'
                  id: 'false'
              position:
                x: '-189.86368278693385'
                'y': '-453.57986075944297'
              positionAbsolute:
                x: '-189.86368278693385'
                'y': '-453.57986075944297'
              selected: 'false'
              type: configuremfa
              width: '164'
            4fd9fc82-5cc5-4410-94c7-cc8ac301a31e:
              data:
                description: Combines multiple nodes that request input into a single page for display to the user. Drag and drop nodes onto the web page node to combine them.
                label: Web Page
                properties:
                  - elementType: title
                    id: '1'
                    label: Web Page Header
                    required: 'true'
                    type: text
                    value: Authenticator Code
                  - elementType: description
                    id: '2'
                    label: Web Page Description
                    required: 'true'
                    type: text
                    value: Enter the Authenticator Code
                  - elementType: buttontext
                    id: '3'
                    label: Submit Button Text
                    required: 'true'
                    type: text
                    value: Verify
                  - elementType: footer
                    id: '4'
                    label: Web Page Footer
                    required: 'true'
                    type: text
                    value: LoginRadius
                  - elementType: buttons
                    id: '5'
                    label: Buttons
                    type: buttons
                    value: null
              dragging: 'false'
              height: '114'
              id: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              nodes:
                - data:
                    label: Authenticator Input
                  id: 46d6674e-bbc6-44bc-951f-98cffd6441b6
                  isChildNode: 'true'
                  type: authenticatorinput
              output:
                - displayName: output
                  id: output
              position:
                x: '276.136828477123'
                'y': '-237.73090292154373'
              positionAbsolute:
                x: '276.136828477123'
                'y': '-237.73090292154373'
              selected: 'false'
              type: webpage
              width: '230'
            6799ebff-ab72-4ebd-869b-65672bd0a799:
              data:
                description: Verifies if the entered TOTP for authenticator is valid or not.
                label: Verify Authenticator
                properties: null
              dragging: 'false'
              height: '90'
              id: 6799ebff-ab72-4ebd-869b-65672bd0a799
              nodes: null
              output:
                - displayName: 'True'
                  id: 'true'
                - displayName: 'False'
                  id: 'false'
              position:
                x: '616.5127762283203'
                'y': '-370.34395454050144'
              positionAbsolute:
                x: '616.5127762283203'
                'y': '-370.34395454050144'
              selected: 'false'
              type: verifyauthenticatortotp
              width: '164'
            FailureFinalNode:
              data:
                description: 'Denotes that the workflow ended at failure. '
                label: Failure
                properties:
                  - id: '1'
                    label: Redirect URL
                    type: text
                    value: ''
              dragging: 'false'
              height: '40'
              id: FailureFinalNode
              nodes: null
              position:
                x: '868.1393360508125'
                'y': '-6.556228920048781'
              positionAbsolute:
                x: '868.1393360508125'
                'y': '-6.556228920048781'
              selected: 'false'
              type: finalNegative
              width: '40'
            SuccessFinalNode:
              data:
                description: 'Denotes that the workflow ended in success. '
                label: Success
                properties:
                  - id: '1'
                    label: Redirect URL
                    type: text
                    value: ''
              dragging: 'false'
              height: '40'
              id: SuccessFinalNode
              nodes: null
              position:
                x: '870.7506472583059'
                'y': '-346.426228223721'
              positionAbsolute:
                x: '870.7506472583059'
                'y': '-346.426228223721'
              selected: 'false'
              type: finalPositive
              width: '40'
            ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b:
              data:
                description: To configure the Authenticator method while setting up MFA. Businesses can also customize the labels and descriptions that will be displayed on the Authenticator screen.
                label: Configure Authenticator
                properties:
                  - elementType: issuerid
                    id: '1'
                    label: Issuer ID
                    required: 'true'
                    type: text
                    value: LR
                  - elementType: qrcodewidth
                    id: '2'
                    label: QR Code Width
                    required: 'true'
                    type: text
                    value: '200'
                  - elementType: qrcodeheight
                    id: '3'
                    label: QR Code Height
                    required: 'true'
                    type: text
                    value: '200'
                  - elementType: displaygetapp
                    id: '4'
                    label: Display Get App
                    type: checkbox
                    value: 'false'
                  - elementType: getapptext
                    id: '5'
                    label: Get App Text
                    parentPropertyId: '4'
                    parentPropertyValue: 'true'
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: getapplink
                    id: '6'
                    label: Get App Link
                    parentPropertyId: '4'
                    parentPropertyValue: 'true'
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: googleauthenticatorlabel
                    id: '7'
                    label: Authenticator label
                    required: 'true'
                    type: text
                    value: Configure Authenticator
                  - elementType: googleauthenticatordescription
                    id: '8'
                    label: Authenticator Description
                    required: 'true'
                    type: text
                    value: Configure authenticator to use MFA
                  - elementType: defaultbuttontext
                    id: '9'
                    label: Default Button Text
                    required: 'true'
                    type: text
                    value: Authenticator
              dragging: 'false'
              height: '90'
              id: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              nodes: null
              output:
                - displayName: 'True'
                  id: 'true'
                - displayName: 'False'
                  id: 'false'
              position:
                x: '39.63816595865569'
                'y': '-491.36370171146075'
              positionAbsolute:
                x: '39.63816595865569'
                'y': '-491.36370171146075'
              selected: 'false'
              type: configureauthenticator
              width: '164'
            b92fb05a-578a-4097-aec0-2df33b4c27a0:
              data:
                description: Verifies if the authentication is successful or not, along with other statutes such as account locked, password expired.
                label: Auth
                properties:
                  - elementType: accesstoken
                    id: '1'
                    label: Access Token
                    readOnly: 'true'
                    type: checkbox
                    value: 'true'
                  - elementType: sessiontoken
                    id: '2'
                    label: Session Token
                    type: checkbox
                    value: 'false'
                  - elementType: authvalidation
                    id: '3'
                    label: Auth Validation
                    options:
                      - text: Email Unverified
                        value: emailunverified
                      - text: Phone Unverified
                        value: phoneunverified
                      - text: Password Expired
                        value: passwordexpired
                      - text: Account Locked
                        value: accountlocked
                    type: multiselect
                    value: null
              height: '90'
              id: b92fb05a-578a-4097-aec0-2df33b4c27a0
              nodes: null
              output:
                - displayName: 'True'
                  id: 'true'
                - displayName: 'False'
                  id: 'false'
                - displayName: Account Locked
                  id: accountlocked
                - displayName: Password Expired
                  id: passwordexpired
                - displayName: Email Unverified
                  id: emailunverified
                - displayName: Phone Unverified
                  id: phoneunverified
              position:
                x: '-215.98193694275392'
                'y': '-66.19912170548083'
              selected: 'false'
              type: auth
              width: '164'
            dd8723a2-afc1-4529-a0a6-2c0712af3e65:
              data:
                description: Combines multiple nodes that request input into a single page for display to the user. Drag and drop nodes onto the web page node to combine them.
                label: Web Page
                properties:
                  - elementType: title
                    id: '1'
                    label: Web Page Header
                    required: 'true'
                    type: text
                    value: MFA Authenticator
                  - elementType: description
                    id: '2'
                    label: Web Page Description
                    required: 'true'
                    type: text
                    value: MFA Authenticator Flow
                  - elementType: buttontext
                    id: '3'
                    label: Submit Button Text
                    required: 'true'
                    type: text
                    value: Submit
                  - elementType: footer
                    id: '4'
                    label: Web Page Footer
                    required: 'true'
                    type: text
                    value: LoginRadius
                  - elementType: buttons
                    id: '5'
                    label: Buttons
                    type: buttons
                    value: null
              dragging: 'false'
              height: '158'
              id: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              nodes:
                - data:
                    label: Email
                  id: a655db76-8831-411b-82f5-1be2784e4a78
                  isChildNode: 'true'
                  type: email
                - data:
                    label: Password
                  id: fff21a66-437c-4a8a-96e0-744efaff8d87
                  isChildNode: 'true'
                  type: password
              output:
                - displayName: output
                  id: output
              position:
                x: '-520.0072319257067'
                'y': '-209.33943568578155'
              positionAbsolute:
                x: '-520.0072319257067'
                'y': '-209.33943568578155'
              selected: 'false'
              type: webpage
              width: '230'
            e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913:
              data:
                description: To check whether the user has configured MFA or not. If configured, it gets and displays the configured method(s) for the user to select one and proceed. If not, the next node should be Configure MFA node (if the business wants that user should not proceed without MFA).
                label: MFA Configured State
                properties:
                  - elementType: mfamethods
                    id: '1'
                    label: MFA Methods
                    options:
                      - checked: 'false'
                        text: Authenticator
                        value: Authenticator
                      - checked: 'false'
                        text: Security Question
                        value: Security Question
                      - checked: 'false'
                        text: Email OTP
                        value: Email OTP
                      - checked: 'false'
                        text: SMS OTP
                        value: SMS OTP
                    outputSelector: 'true'
                    required: 'true'
                    type: multiselect
                    value:
                      - Authenticator
                  - elementType: authenticatorbuttontext
                    id: '2'
                    label: Authenticator Button Text
                    parentPropertyId: '1'
                    parentPropertyValue: Authenticator
                    required: 'true'
                    type: text
                    value: Authenticator
                  - elementType: securityquestionbuttontext
                    id: '3'
                    label: Security Question Button Text
                    parentPropertyId: '1'
                    parentPropertyValue: Security Question
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: emailotpbuttontext
                    id: '4'
                    label: Email OTP Button Text
                    parentPropertyId: '1'
                    parentPropertyValue: Email OTP
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: smsotpbuttontext
                    id: '5'
                    label: SMS OTP Button Text
                    parentPropertyId: '1'
                    parentPropertyValue: SMS OTP
                    required: 'true'
                    type: text
                    value: ''
              dragging: 'false'
              height: '130'
              id: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              nodes: null
              output:
                - displayName: EmailOTP
                  id: emailotp
                - displayName: SMSOTP
                  id: smsotp
                - displayName: Authenticator
                  id: authenticator
                - displayName: SecurityQuestion
                  id: securityquestion
                - displayName: BackupCode
                  id: backupcode
                - displayName: 'False'
                  id: 'false'
              position:
                x: '28.222649657516513'
                'y': '-239.82180479922073'
              positionAbsolute:
                x: '28.222649657516513'
                'y': '-239.82180479922073'
              selected: 'false'
              type: mfastate
              width: '164'
            initialNode:
              data:
                label: initial node
              dragging: 'false'
              height: '40'
              id: initialNode
              nodes: null
              position:
                x: '-640.0257070587011'
                'y': '-185.85618992280232'
              positionAbsolute:
                x: '-640.0257070587011'
                'y': '-185.85618992280232'
              selected: 'false'
              type: initial
              width: '40'
          policies:
            email:
              - elementType: shouldrestrict
                id: '1'
                label: Should Restrict
                type: checkbox
                value: 'false'
              - elementType: blacklistwhitelist
                id: '2'
                label: Blacklist/Whitelist
                options:
                  - text: Blacklist
                    value: Blacklist
                  - text: Whitelist
                    value: Whitelist
                type: select
                value: ''
              - elementType: emaildomain
                id: '3'
                label: Email/Domain
                type: multivalue
                value: ''
            password:
              - elementType: rules
                id: '4'
                label: Password Validation
                tooltipMessage: Validate password property must be enabled
                type: text
                value: min_length[6]|max_length[32]|required
              - elementType: passwordexpiration
                id: '5'
                label: Password Expiration
                options:
                  - text: Days
                    value: Days
                  - text: Month
                    value: Month
                  - text: Year
                    value: Year
                type: selectinput
                value: ''
              - elementType: passwordhistory
                id: '6'
                label: Password History
                type: text
                value: ''
              - elementType: confirmpasswordprotection
                id: '7'
                label: Common Password Protection
                type: checkbox
                value: 'false'
              - elementType: dictionarypasswordprevention
                id: '8'
                label: Dictionary Password Prevention
                type: checkbox
                value: 'false'
              - elementType: profilefieldpasswordprevention
                id: '9'
                label: Profile Field Password Prevention
                type: checkbox
                value: 'false'
            phone:
              - elementType: isprimary
                id: '14'
                label: Is Primary
                type: checkbox
                value: 'false'
              - elementType: countrycode
                id: '15'
                label: Country Code
                type: checkbox
                value: 'false'
              - elementType: setdefaultcountrycode
                id: '16'
                isSearchEnabled: 'true'
                label: Set Default Country Code
                options: optionsofsetcountrycode
                primaryParentId: '15'
                type: select
                value: ''
              - elementType: allowparticularcountrycode
                id: '17'
                isSearchEnabled: 'true'
                label: Allow particular country code
                options: optionsofallowcountrycode
                primaryParentId: '15'
                type: multiselect
                value: null
            pininput:
              - elementType: rules
                id: '13'
                label: Pin Validation
                type: text
                value: ''
            username:
              - elementType: isprimary
                id: '10'
                label: Is Primary
                type: checkbox
                value: 'false'
              - elementType: duplicateemail
                id: '11'
                label: Duplicate Email
                primaryParentId: '10'
                type: checkbox
                value: 'false'
              - elementType: casesensitiveusername
                id: '12'
                label: Case sensitive Username
                type: checkbox
                value: 'false'
          tree:
            entryNodeId: dd8723a2-afc1-4529-a0a6-2c0712af3e65
            nodes:
              1eb72cc9-7a2c-44f7-817d-00a94a9c1a24:
                connections:
                  - emailotp: ''
                  - smsotp: ''
                  - authenticator: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
                  - securityquestion: ''
                  - skip: ''
                  - 'false': ''
                id: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
                type: configuremfa
              4fd9fc82-5cc5-4410-94c7-cc8ac301a31e:
                connections:
                  - output: 6799ebff-ab72-4ebd-869b-65672bd0a799
                id: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
                type: webpage
              6799ebff-ab72-4ebd-869b-65672bd0a799:
                connections:
                  - 'true': SuccessFinalNode
                  - 'false': FailureFinalNode
                id: 6799ebff-ab72-4ebd-869b-65672bd0a799
                type: verifyauthenticatortotp
              ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b:
                connections:
                  - 'true': 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
                  - 'false': FailureFinalNode
                id: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
                type: configureauthenticator
              b92fb05a-578a-4097-aec0-2df33b4c27a0:
                connections:
                  - 'true': e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
                  - 'false': FailureFinalNode
                  - accountlocked: ''
                  - passwordexpired: ''
                  - emailunverified: ''
                  - phoneunverified: ''
                id: b92fb05a-578a-4097-aec0-2df33b4c27a0
                type: auth
              dd8723a2-afc1-4529-a0a6-2c0712af3e65:
                connections:
                  - output: b92fb05a-578a-4097-aec0-2df33b4c27a0
                id: dd8723a2-afc1-4529-a0a6-2c0712af3e65
                type: webpage
              e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913:
                connections:
                  - emailotp: ''
                  - smsotp: ''
                  - authenticator: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
                  - securityquestion: ''
                  - backupcode: ''
                  - 'false': 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
                id: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
                type: mfastate
            staticNodes:
              failureFinalNode:
                position:
                  x: '400'
                  'y': '300'
              initialNode:
                position:
                  x: '-640.0257070587011'
                  'y': '-185.85618992280232'
              successFinalNode:
                position:
                  x: '100'
                  'y': '300'
          viewport:
            x: '647.0394243743131'
            'y': '464.4454913683603'
            zoom: '0.8972987530157684'
        Description: description
        State: ACTIVE
    WORKFLOW_RESPONSE:
      value:
        Id: 6799ebff-ab72-4ebd-869b-65672bd0a799
        Name: mfa-auth
        ThemeName: default
        Data:
          edges:
            - id: reactflow__edge-6799ebff-ab72-4ebd-869b-65672bd0a799true-SuccessFinalNode
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: 6799ebff-ab72-4ebd-869b-65672bd0a799
              sourceHandle: 'true'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: SuccessFinalNode
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-6799ebff-ab72-4ebd-869b-65672bd0a799false-FailureFinalNode
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: 6799ebff-ab72-4ebd-869b-65672bd0a799
              sourceHandle: 'false'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: FailureFinalNode
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913false-1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              sourceHandle: 'false'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-1eb72cc9-7a2c-44f7-817d-00a94a9c1a24authenticator-ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              sourceHandle: authenticator
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-ac8ae2f4-48b9-4c35-bd68-4cbf11730b8bfalse-FailureFinalNode
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              sourceHandle: 'false'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: FailureFinalNode
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-initialNodeoutput-dd8723a2-afc1-4529-a0a6-2c0712af3e65
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: initialNode
              sourceHandle: output
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-dd8723a2-afc1-4529-a0a6-2c0712af3e65output-b92fb05a-578a-4097-aec0-2df33b4c27a0
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              sourceHandle: output
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: b92fb05a-578a-4097-aec0-2df33b4c27a0
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-b92fb05a-578a-4097-aec0-2df33b4c27a0true-e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: b92fb05a-578a-4097-aec0-2df33b4c27a0
              sourceHandle: 'true'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-b92fb05a-578a-4097-aec0-2df33b4c27a0false-FailureFinalNode
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: b92fb05a-578a-4097-aec0-2df33b4c27a0
              sourceHandle: 'false'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: FailureFinalNode
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-ac8ae2f4-48b9-4c35-bd68-4cbf11730b8btrue-4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              sourceHandle: 'true'
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913authenticator-4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              sourceHandle: authenticator
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              targetHandle: null
              type: smoothstep
            - id: reactflow__edge-4fd9fc82-5cc5-4410-94c7-cc8ac301a31eoutput-6799ebff-ab72-4ebd-869b-65672bd0a799
              markerEnd:
                color: '#30b3ff'
                type: arrowclosed
              selected: 'false'
              source: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              sourceHandle: output
              style:
                stroke: '#30b3ff'
                strokeWidth: '1'
              target: 6799ebff-ab72-4ebd-869b-65672bd0a799
              targetHandle: null
              type: smoothstep
          innerNodes:
            46d6674e-bbc6-44bc-951f-98cffd6441b6:
              data:
                description: Displays the option to field to enter TOTP (when Authenticator is already configured).
                label: Authenticator Input
                properties: null
              dragging: 'false'
              extent: parent
              height: '50'
              hidden: 'true'
              id: 46d6674e-bbc6-44bc-951f-98cffd6441b6
              isChildNode: 'true'
              nodes: null
              parentNode: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              position:
                x: '290.33256209500405'
                'y': '-206.97348008280136'
              positionAbsolute:
                x: '290.33256209500405'
                'y': '-206.97348008280136'
              selected: 'false'
              type: authenticatorinput
              width: '150'
            a655db76-8831-411b-82f5-1be2784e4a78:
              data:
                description: Prompts the user to enter the email and stores the input. It is used with the Web Page node.
                label: Email
                properties:
                  - elementType: emailonlyasinput
                    id: '1'
                    label: Email Only as Input
                    type: checkbox
                    value: 'false'
                  - elementType: isprimary
                    id: '2'
                    label: Is Primary
                    primaryParentId: '1'
                    type: checkbox
                    value: 'true'
                  - elementType: emailtype
                    id: '3'
                    label: Email Type
                    primaryParentId: '1'
                    secondaryParentId: '2'
                    type: text
                    value: ''
                  - elementType: rules
                    id: '4'
                    label: Validation String
                    primaryParentId: '1'
                    type: text
                    value: ''
              draggable: 'true'
              dragging: 'false'
              extent: parent
              height: '50'
              hidden: 'true'
              id: a655db76-8831-411b-82f5-1be2784e4a78
              isChildNode: 'true'
              nodes: null
              parentNode: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              position:
                x: '-499.8966093003752'
                'y': '-455.39881839572'
              positionAbsolute:
                x: '-499.8966093003752'
                'y': '-455.39881839572'
              selected: 'false'
              type: email
              width: '150'
            fff21a66-437c-4a8a-96e0-744efaff8d87:
              data:
                description: Prompts the user to enter their password and stores the input. This node is to be used for entering the password during registration, login, password update and password forget etc. It is used with the Web Page node.
                label: Password
                properties:
                  - elementType: passwordonlyasinput
                    id: '1'
                    label: Password Only as Input
                    tag: password
                    type: checkbox
                    value: 'false'
                  - elementType: oldpassword
                    id: '2'
                    label: Old Password
                    primaryParentId: '1'
                    tag: password
                    type: checkbox
                    value: 'false'
                  - elementType: newpassword
                    id: '3'
                    label: New Password
                    primaryParentId: '1'
                    tag: password
                    type: checkbox
                    value: 'false'
                  - elementType: confirmpassword
                    id: '4'
                    label: Confirm Password
                    primaryParentId: '1'
                    tag: password
                    type: checkbox
                    value: 'false'
                  - elementType: validatepassword
                    id: '5'
                    label: Validate Password
                    primaryParentId: '1'
                    tag: policy
                    type: checkbox
                    value: 'false'
              draggable: 'true'
              dragging: 'false'
              extent: parent
              height: '50'
              hidden: 'true'
              id: fff21a66-437c-4a8a-96e0-744efaff8d87
              isChildNode: 'true'
              nodes: null
              parentNode: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              position:
                x: '-480.96896447653376'
                'y': '-480.2413522270118'
              positionAbsolute:
                x: '-480.96896447653376'
                'y': '-480.2413522270118'
              selected: 'false'
              type: password
              width: '150'
          nodes:
            1eb72cc9-7a2c-44f7-817d-00a94a9c1a24:
              data:
                description: 'Define the MFA flow (mandatory or optional), settings and method(s) for all users. To let users register/configure the MFA method from the available method(s) on login. '
                label: Configure MFA
                properties:
                  - elementType: mfaflow
                    id: '1'
                    label: MFA Flow
                    options:
                      - text: Mandatory
                        value: Mandatory
                      - text: Optional
                        value: Optional
                    required: 'true'
                    type: select
                    value: Mandatory
                  - elementType: message
                    id: '2'
                    label: Message
                    required: 'true'
                    type: text
                    value: Authenticator
                  - elementType: mfamethods
                    id: '3'
                    label: MFA Methods
                    options:
                      - checked: 'false'
                        text: Authenticator
                        value: Authenticator
                      - checked: 'false'
                        text: Security Question
                        value: Security Question
                      - checked: 'false'
                        text: Email OTP
                        value: Email OTP
                      - checked: 'false'
                        text: SMS OTP
                        value: SMS OTP
                    outputSelector: 'true'
                    required: 'true'
                    type: multiselect
                    value:
                      - Authenticator
                  - elementType: authenticatorbuttontext
                    id: '4'
                    label: Authenticator Button Text
                    parentPropertyId: '3'
                    parentPropertyValue: Authenticator
                    required: 'true'
                    type: text
                    value: Configure Authenticator
                  - elementType: securityquestionbuttontext
                    id: '5'
                    label: Security Question Button Text
                    parentPropertyId: '3'
                    parentPropertyValue: Security Question
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: emailotpbuttontext
                    id: '6'
                    label: Email OTP Button Text
                    parentPropertyId: '3'
                    parentPropertyValue: Email OTP
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: smsotpbuttontext
                    id: '7'
                    label: SMS OTP Button Text
                    parentPropertyId: '3'
                    parentPropertyValue: SMS OTP
                    required: 'true'
                    type: text
                    value: ''
              dragging: 'false'
              height: '130'
              id: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
              nodes: null
              output:
                - displayName: EmailOTP
                  id: emailotp
                - displayName: SMSOTP
                  id: smsotp
                - displayName: Authenticator
                  id: authenticator
                - displayName: SecurityQuestion
                  id: securityquestion
                - displayName: Skip
                  id: skip
                - displayName: 'False'
                  id: 'false'
              position:
                x: '-189.86368278693385'
                'y': '-453.57986075944297'
              positionAbsolute:
                x: '-189.86368278693385'
                'y': '-453.57986075944297'
              selected: 'false'
              type: configuremfa
              width: '164'
            4fd9fc82-5cc5-4410-94c7-cc8ac301a31e:
              data:
                description: Combines multiple nodes that request input into a single page for display to the user. Drag and drop nodes onto the web page node to combine them.
                label: Web Page
                properties:
                  - elementType: title
                    id: '1'
                    label: Web Page Header
                    required: 'true'
                    type: text
                    value: Authenticator Code
                  - elementType: description
                    id: '2'
                    label: Web Page Description
                    required: 'true'
                    type: text
                    value: Enter the Authenticator Code
                  - elementType: buttontext
                    id: '3'
                    label: Submit Button Text
                    required: 'true'
                    type: text
                    value: Verify
                  - elementType: footer
                    id: '4'
                    label: Web Page Footer
                    required: 'true'
                    type: text
                    value: LoginRadius
                  - elementType: buttons
                    id: '5'
                    label: Buttons
                    type: buttons
                    value: null
              dragging: 'false'
              height: '114'
              id: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
              nodes:
                - data:
                    label: Authenticator Input
                  id: 46d6674e-bbc6-44bc-951f-98cffd6441b6
                  isChildNode: 'true'
                  type: authenticatorinput
              output:
                - displayName: output
                  id: output
              position:
                x: '276.136828477123'
                'y': '-237.73090292154373'
              positionAbsolute:
                x: '276.136828477123'
                'y': '-237.73090292154373'
              selected: 'false'
              type: webpage
              width: '230'
            6799ebff-ab72-4ebd-869b-65672bd0a799:
              data:
                description: Verifies if the entered TOTP for authenticator is valid or not.
                label: Verify Authenticator
                properties: null
              dragging: 'false'
              height: '90'
              id: 6799ebff-ab72-4ebd-869b-65672bd0a799
              nodes: null
              output:
                - displayName: 'True'
                  id: 'true'
                - displayName: 'False'
                  id: 'false'
              position:
                x: '616.5127762283203'
                'y': '-370.34395454050144'
              positionAbsolute:
                x: '616.5127762283203'
                'y': '-370.34395454050144'
              selected: 'false'
              type: verifyauthenticatortotp
              width: '164'
            FailureFinalNode:
              data:
                description: 'Denotes that the workflow ended at failure. '
                label: Failure
                properties:
                  - id: '1'
                    label: Redirect URL
                    type: text
                    value: ''
              dragging: 'false'
              height: '40'
              id: FailureFinalNode
              nodes: null
              position:
                x: '868.1393360508125'
                'y': '-6.556228920048781'
              positionAbsolute:
                x: '868.1393360508125'
                'y': '-6.556228920048781'
              selected: 'false'
              type: finalNegative
              width: '40'
            SuccessFinalNode:
              data:
                description: 'Denotes that the workflow ended in success. '
                label: Success
                properties:
                  - id: '1'
                    label: Redirect URL
                    type: text
                    value: ''
              dragging: 'false'
              height: '40'
              id: SuccessFinalNode
              nodes: null
              position:
                x: '870.7506472583059'
                'y': '-346.426228223721'
              positionAbsolute:
                x: '870.7506472583059'
                'y': '-346.426228223721'
              selected: 'false'
              type: finalPositive
              width: '40'
            ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b:
              data:
                description: To configure the Authenticator method while setting up MFA. Businesses can also customize the labels and descriptions that will be displayed on the Authenticator screen.
                label: Configure Authenticator
                properties:
                  - elementType: issuerid
                    id: '1'
                    label: Issuer ID
                    required: 'true'
                    type: text
                    value: LR
                  - elementType: qrcodewidth
                    id: '2'
                    label: QR Code Width
                    required: 'true'
                    type: text
                    value: '200'
                  - elementType: qrcodeheight
                    id: '3'
                    label: QR Code Height
                    required: 'true'
                    type: text
                    value: '200'
                  - elementType: displaygetapp
                    id: '4'
                    label: Display Get App
                    type: checkbox
                    value: 'false'
                  - elementType: getapptext
                    id: '5'
                    label: Get App Text
                    parentPropertyId: '4'
                    parentPropertyValue: 'true'
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: getapplink
                    id: '6'
                    label: Get App Link
                    parentPropertyId: '4'
                    parentPropertyValue: 'true'
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: googleauthenticatorlabel
                    id: '7'
                    label: Authenticator label
                    required: 'true'
                    type: text
                    value: Configure Authenticator
                  - elementType: googleauthenticatordescription
                    id: '8'
                    label: Authenticator Description
                    required: 'true'
                    type: text
                    value: Configure authenticator to use MFA
                  - elementType: defaultbuttontext
                    id: '9'
                    label: Default Button Text
                    required: 'true'
                    type: text
                    value: Authenticator
              dragging: 'false'
              height: '90'
              id: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
              nodes: null
              output:
                - displayName: 'True'
                  id: 'true'
                - displayName: 'False'
                  id: 'false'
              position:
                x: '39.63816595865569'
                'y': '-491.36370171146075'
              positionAbsolute:
                x: '39.63816595865569'
                'y': '-491.36370171146075'
              selected: 'false'
              type: configureauthenticator
              width: '164'
            b92fb05a-578a-4097-aec0-2df33b4c27a0:
              data:
                description: Verifies if the authentication is successful or not, along with other statutes such as account locked, password expired.
                label: Auth
                properties:
                  - elementType: accesstoken
                    id: '1'
                    label: Access Token
                    readOnly: 'true'
                    type: checkbox
                    value: 'true'
                  - elementType: sessiontoken
                    id: '2'
                    label: Session Token
                    type: checkbox
                    value: 'false'
                  - elementType: authvalidation
                    id: '3'
                    label: Auth Validation
                    options:
                      - text: Email Unverified
                        value: emailunverified
                      - text: Phone Unverified
                        value: phoneunverified
                      - text: Password Expired
                        value: passwordexpired
                      - text: Account Locked
                        value: accountlocked
                    type: multiselect
                    value: null
              height: '90'
              id: b92fb05a-578a-4097-aec0-2df33b4c27a0
              nodes: null
              output:
                - displayName: 'True'
                  id: 'true'
                - displayName: 'False'
                  id: 'false'
                - displayName: Account Locked
                  id: accountlocked
                - displayName: Password Expired
                  id: passwordexpired
                - displayName: Email Unverified
                  id: emailunverified
                - displayName: Phone Unverified
                  id: phoneunverified
              position:
                x: '-215.98193694275392'
                'y': '-66.19912170548083'
              selected: 'false'
              type: auth
              width: '164'
            dd8723a2-afc1-4529-a0a6-2c0712af3e65:
              data:
                description: Combines multiple nodes that request input into a single page for display to the user. Drag and drop nodes onto the web page node to combine them.
                label: Web Page
                properties:
                  - elementType: title
                    id: '1'
                    label: Web Page Header
                    required: 'true'
                    type: text
                    value: MFA Authenticator
                  - elementType: description
                    id: '2'
                    label: Web Page Description
                    required: 'true'
                    type: text
                    value: MFA Authenticator Flow
                  - elementType: buttontext
                    id: '3'
                    label: Submit Button Text
                    required: 'true'
                    type: text
                    value: Submit
                  - elementType: footer
                    id: '4'
                    label: Web Page Footer
                    required: 'true'
                    type: text
                    value: LoginRadius
                  - elementType: buttons
                    id: '5'
                    label: Buttons
                    type: buttons
                    value: null
              dragging: 'false'
              height: '158'
              id: dd8723a2-afc1-4529-a0a6-2c0712af3e65
              nodes:
                - data:
                    label: Email
                  id: a655db76-8831-411b-82f5-1be2784e4a78
                  isChildNode: 'true'
                  type: email
                - data:
                    label: Password
                  id: fff21a66-437c-4a8a-96e0-744efaff8d87
                  isChildNode: 'true'
                  type: password
              output:
                - displayName: output
                  id: output
              position:
                x: '-520.0072319257067'
                'y': '-209.33943568578155'
              positionAbsolute:
                x: '-520.0072319257067'
                'y': '-209.33943568578155'
              selected: 'false'
              type: webpage
              width: '230'
            e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913:
              data:
                description: To check whether the user has configured MFA or not. If configured, it gets and displays the configured method(s) for the user to select one and proceed. If not, the next node should be Configure MFA node (if the business wants that user should not proceed without MFA).
                label: MFA Configured State
                properties:
                  - elementType: mfamethods
                    id: '1'
                    label: MFA Methods
                    options:
                      - checked: 'false'
                        text: Authenticator
                        value: Authenticator
                      - checked: 'false'
                        text: Security Question
                        value: Security Question
                      - checked: 'false'
                        text: Email OTP
                        value: Email OTP
                      - checked: 'false'
                        text: SMS OTP
                        value: SMS OTP
                    outputSelector: 'true'
                    required: 'true'
                    type: multiselect
                    value:
                      - Authenticator
                  - elementType: authenticatorbuttontext
                    id: '2'
                    label: Authenticator Button Text
                    parentPropertyId: '1'
                    parentPropertyValue: Authenticator
                    required: 'true'
                    type: text
                    value: Authenticator
                  - elementType: securityquestionbuttontext
                    id: '3'
                    label: Security Question Button Text
                    parentPropertyId: '1'
                    parentPropertyValue: Security Question
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: emailotpbuttontext
                    id: '4'
                    label: Email OTP Button Text
                    parentPropertyId: '1'
                    parentPropertyValue: Email OTP
                    required: 'true'
                    type: text
                    value: ''
                  - elementType: smsotpbuttontext
                    id: '5'
                    label: SMS OTP Button Text
                    parentPropertyId: '1'
                    parentPropertyValue: SMS OTP
                    required: 'true'
                    type: text
                    value: ''
              dragging: 'false'
              height: '130'
              id: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
              nodes: null
              output:
                - displayName: EmailOTP
                  id: emailotp
                - displayName: SMSOTP
                  id: smsotp
                - displayName: Authenticator
                  id: authenticator
                - displayName: SecurityQuestion
                  id: securityquestion
                - displayName: BackupCode
                  id: backupcode
                - displayName: 'False'
                  id: 'false'
              position:
                x: '28.222649657516513'
                'y': '-239.82180479922073'
              positionAbsolute:
                x: '28.222649657516513'
                'y': '-239.82180479922073'
              selected: 'false'
              type: mfastate
              width: '164'
            initialNode:
              data:
                label: initial node
              dragging: 'false'
              height: '40'
              id: initialNode
              nodes: null
              position:
                x: '-640.0257070587011'
                'y': '-185.85618992280232'
              positionAbsolute:
                x: '-640.0257070587011'
                'y': '-185.85618992280232'
              selected: 'false'
              type: initial
              width: '40'
          policies:
            email:
              - elementType: shouldrestrict
                id: '1'
                label: Should Restrict
                type: checkbox
                value: 'false'
              - elementType: blacklistwhitelist
                id: '2'
                label: Blacklist/Whitelist
                options:
                  - text: Blacklist
                    value: Blacklist
                  - text: Whitelist
                    value: Whitelist
                type: select
                value: ''
              - elementType: emaildomain
                id: '3'
                label: Email/Domain
                type: multivalue
                value: ''
            password:
              - elementType: rules
                id: '4'
                label: Password Validation
                tooltipMessage: Validate password property must be enabled
                type: text
                value: min_length[6]|max_length[32]|required
              - elementType: passwordexpiration
                id: '5'
                label: Password Expiration
                options:
                  - text: Days
                    value: Days
                  - text: Month
                    value: Month
                  - text: Year
                    value: Year
                type: selectinput
                value: ''
              - elementType: passwordhistory
                id: '6'
                label: Password History
                type: text
                value: ''
              - elementType: confirmpasswordprotection
                id: '7'
                label: Common Password Protection
                type: checkbox
                value: 'false'
              - elementType: dictionarypasswordprevention
                id: '8'
                label: Dictionary Password Prevention
                type: checkbox
                value: 'false'
              - elementType: profilefieldpasswordprevention
                id: '9'
                label: Profile Field Password Prevention
                type: checkbox
                value: 'false'
            phone:
              - elementType: isprimary
                id: '14'
                label: Is Primary
                type: checkbox
                value: 'false'
              - elementType: countrycode
                id: '15'
                label: Country Code
                type: checkbox
                value: 'false'
              - elementType: setdefaultcountrycode
                id: '16'
                isSearchEnabled: 'true'
                label: Set Default Country Code
                options: optionsofsetcountrycode
                primaryParentId: '15'
                type: select
                value: ''
              - elementType: allowparticularcountrycode
                id: '17'
                isSearchEnabled: 'true'
                label: Allow particular country code
                options: optionsofallowcountrycode
                primaryParentId: '15'
                type: multiselect
                value: null
            pininput:
              - elementType: rules
                id: '13'
                label: Pin Validation
                type: text
                value: ''
            username:
              - elementType: isprimary
                id: '10'
                label: Is Primary
                type: checkbox
                value: 'false'
              - elementType: duplicateemail
                id: '11'
                label: Duplicate Email
                primaryParentId: '10'
                type: checkbox
                value: 'false'
              - elementType: casesensitiveusername
                id: '12'
                label: Case sensitive Username
                type: checkbox
                value: 'false'
          tree:
            entryNodeId: dd8723a2-afc1-4529-a0a6-2c0712af3e65
            nodes:
              1eb72cc9-7a2c-44f7-817d-00a94a9c1a24:
                connections:
                  - emailotp: ''
                  - smsotp: ''
                  - authenticator: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
                  - securityquestion: ''
                  - skip: ''
                  - 'false': ''
                id: 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
                type: configuremfa
              4fd9fc82-5cc5-4410-94c7-cc8ac301a31e:
                connections:
                  - output: 6799ebff-ab72-4ebd-869b-65672bd0a799
                id: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
                type: webpage
              6799ebff-ab72-4ebd-869b-65672bd0a799:
                connections:
                  - 'true': SuccessFinalNode
                  - 'false': FailureFinalNode
                id: 6799ebff-ab72-4ebd-869b-65672bd0a799
                type: verifyauthenticatortotp
              ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b:
                connections:
                  - 'true': 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
                  - 'false': FailureFinalNode
                id: ac8ae2f4-48b9-4c35-bd68-4cbf11730b8b
                type: configureauthenticator
              b92fb05a-578a-4097-aec0-2df33b4c27a0:
                connections:
                  - 'true': e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
                  - 'false': FailureFinalNode
                  - accountlocked: ''
                  - passwordexpired: ''
                  - emailunverified: ''
                  - phoneunverified: ''
                id: b92fb05a-578a-4097-aec0-2df33b4c27a0
                type: auth
              dd8723a2-afc1-4529-a0a6-2c0712af3e65:
                connections:
                  - output: b92fb05a-578a-4097-aec0-2df33b4c27a0
                id: dd8723a2-afc1-4529-a0a6-2c0712af3e65
                type: webpage
              e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913:
                connections:
                  - emailotp: ''
                  - smsotp: ''
                  - authenticator: 4fd9fc82-5cc5-4410-94c7-cc8ac301a31e
                  - securityquestion: ''
                  - backupcode: ''
                  - 'false': 1eb72cc9-7a2c-44f7-817d-00a94a9c1a24
                id: e0e82eb2-ee65-4a6b-ab25-3e6c6dcb2913
                type: mfastate
            staticNodes:
              failureFinalNode:
                position:
                  x: '400'
                  'y': '300'
              initialNode:
                position:
                  x: '-640.0257070587011'
                  'y': '-185.85618992280232'
              successFinalNode:
                position:
                  x: '100'
                  'y': '300'
          viewport:
            x: '647.0394243743131'
            'y': '464.4454913683603'
            zoom: '0.8972987530157684'
        Description: description
        State: ACTIVE
    WORKFLOW_STATE_IS_INVALID:
      value:
        ErrorCode: 8031
        Message: Workflow configuration is invalid.
        Description: The provided workflow state is invalid. Please enter the valid workflow state.
    INVALID_WORKFLOW_NAME:
      summary: INVALID_WORKFLOW_NAME
      value:
        ErrorCode: 8031
        Message: Workflow configuration is invalid.
        Description: Invalid Name. It must be alphanumeric, hyphens (-), underscores (_), colon(:) not start/end with hyphen/underscore/colon, and max length 60.
    WORKFLOW_CONFIG_EXISTS_WITH_SAME_NAME:
      value:
        ErrorCode: 8032
        Message: Workflow configuration already exist with same name.
        Description: Workflow configuration already exists with same name, Please use another name to update the workflow name.
    INVALID_WORKFLOW_ID:
      summary: INVALID_WORKFLOW_ID
      value:
        ErrorCode: 8191
        Message: Invalid workflow id
        Description: Invalid workflow id, Please provide valid workflow id.
    FAILED_TO_RESTORE_WORKFLOW_VERSION:
      summary: FAILED_TO_RESTORE_WORKFLOW_VERSION
      value:
        ErrorCode: 8023
        Message: Failed to restore workflow version
        Description: Failed to restore the workflow version. Please try again.
    WORKFLOW_VERSION_NOT_FOUND:
      summary: WORKFLOW_VERSION_NOT_FOUND
      value:
        ErrorCode: 7972
        Message: Workflow version not found
        Description: Workflow version not found or the resource does not exist.
    WEBHOOK_FEATURE_NOT_ENABLED:
      summary: WEBHOOK_FEATURE_NOT_ENABLED
      value:
        Message: Site is not configured for WebHook management
        Description: Request couldn't be processed, WebHook management feature is not enabled for this site.
        ErrorCode: 7984
    WEBHOOK_CONFIG_NOT_FOUND:
      value:
        Message: WebHook configuration not found
        Description: WebHook configuration not found or the resource does not exist.
        ErrorCode: 7986
    INVALID_WEBHOOK_EVENT_TYPE:
      summary: INVALID_WEBHOOK_EVENT_TYPE
      value:
        Message: Invalid WebHook Event type
        Description: Request couldn't be processed due to invalid WebHook Event type.
        ErrorCode: 7985
    WEB_HOOK_TARGET_URL_IS_NOT_VALID:
      value:
        Message: Webhook target URL is invalid
        Description: The provided Webhook target URL is invalid, please enter a valid web URL.
        ErrorCode: 7987
    WEB_HOOK_TARGET_URL_IS_NOT_REACHABLE:
      value:
        Message: Webhook target URL is not reachable
        Description: Please check the provided Webhook target URL, we couldn't reach the server at the provided URL.
        ErrorCode: 8106
    WEB_HOOK_TARGET_URL_IS_ALREADY_SUBSCRIBE:
      value:
        Message: Webhook target URL is already subscribed
        Description: The provided Webhook target URL is already subscribed, please enter a unique web URL.
        ErrorCode: 7989
    WEB_HOOK_NOT_ALLOWED_MORE_THAN_MAX_LIMIT:
      value:
        Message: Number of Webhook subscriptions exceeded the limit
        Description: Number of Webhook subscriptions must be less than or equal to 5, unsubscribe at least one and try again.
        ErrorCode: 7988
    INVALID_WEBHOOK_ID:
      value:
        Message: A parameter is not formatted correctly (Parameter name in Response)
        Description: The webhook subscription id is not valid.
        ErrorCode: 7900
    CANNOT_UPDATE_WEBHOOK:
      value:
        Message: WebHook configuration not found
        Description: WebHook configuration not found or the resource does not exist.
        ErrorCode: 8016
    WEBHOOK_EVENTS:
      value: Login
    INVALID_SMS_TYPE:
      value:
        Message: Invalid SMS Template type
        Description: Request couldn't be processed due to invalid SMS type.
        ErrorCode: 7959
    SMS_TEMPLATE_ALREADY_EXISTS:
      value:
        Message: SMS template already exist.
        Description: SMS template with the same name already exists, please use a unique name in order to process the request.
        ErrorCode: 7955
    SMS_TEMPLATE_NOT_FOUND:
      value:
        Message: SMS template is not configured or the resource does not exist
        Description: You don't have any SMS template configured for the LoginRadius site.
        ErrorCode: 7954
    SMS_TEMPLATE_NOT_EXISTS:
      value:
        Message: SMS template does not exist.
        Description: Provided SMS template does not exist, Please use a valid SMS template in order to process this request.
        ErrorCode: 7956
    JSON_DELETE_BODY_REQUIRED:
      value:
        ErrorCode: 7935
        Message: Delete body is invalid or empty
        Description: Please use a valid delete body in JSON format in order to process this request.
    PASSKEY_FEATURE_NOT_ENABLED:
      value:
        ErrorCode: 8069
        Message: Site is not configured for passkeys
        Description: Passkeys is not configured for this site, Please contact LoginRadius support for more information.
    PASSKEY_NOT_FOUND:
      value:
        ErrorCode: 8054
        Message: PassKey configuration not found or does not exist.
        Description: There is no PassKey configuration available.
    INVALID_PASSKEY_SELECTION:
      value:
        ErrorCode: 7991
        Message: Invalid passkey configuration
        Description: The value can be 'AutoFill', 'Button', or 'Both'.
    INVALID_PASSKEY_ATTESTATION:
      value:
        ErrorCode: 7991
        Message: Invalid passkey configuration
        Description: The value of attestation can be “none”,“indirect” or “direct”.
    INVALID_RP_ORIGIN_URL:
      value:
        ErrorCode: 7991
        Message: Invalid passkey configuration
        Description: The RPOrigin URL is invalid. Please enter a valid RPOrigin URL.
    RP_ORIGIN_RPID_MISMATCH:
      value:
        ErrorCode: 7991
        Message: Invalid passkey configuration
        Description: The RPOrigin URL does not match the RPID. Please ensure that the RPOrigin URL ends with the RPID value.
    PUSH_AUTHENTICATOR_EXAMPLE:
      value:
        IsEnabled: true
        NotificationService: AWS
        CustomAppName: MyCustomApp
        QRCodeWidth: 200
        Message: Please approve the login request
        AWSsettings:
          AccessKeyId: your-access-key-id
          SecretAccessKey: your-secret-access-key
          Region: us-west-2
        AndroidSettings:
          Enabled: true
          PlatformARN: arn:aws:sns:us-west-2:123456789012:app/GCM/MyAndroidApp
          PlaystoreUrl: https://play.google.com/store/apps/details?id=com.example.myapp
          ServiceJson: '{"project_id":"my-project-id","api_key":"my-api-key"}'
        IOSsettings:
          Enabled: true
          AppstoreUrl: https://apps.apple.com/us/app/myapp/id1234567890
          PlatformARN: arn:aws:sns:us-west-2:123456789012:app/APNS/MyiOSApp
          BundleId: com.example.myapp
          ApnsCertificate: base64-encoded-cert
          Environment: Production
    SECOND_FACTOR_AUTHENTICATION_NOT_ENABLED:
      value:
        ErrorCode: 7953
        Message: Site is not configured for second factor authentication.
        Description: Request couldn't be processed, second factor authentication feature is not enabled for this site.
    PUSH_NOTIFICATIONS_NOT_ENABLED:
      value:
        ErrorCode: 8052
        Message: Site is not configured for Push Notifications MFA.
        Description: Request couldn't be processed,Push Notifications MFA feature is not enabled for this site.
    PUSH_SETTINGS_NOT_FOUND:
      value:
        ErrorCode: 8050
        Message: Push Notification settings not found or does not exist
        Description: There is no Push Notification settings/configuration available.
    ATLEAST_ANDORID_OR_IOS_ENABLED:
      value:
        ErrorCode: 8047
        Message: Push notification authenticator configuration is invalid.
        Description: Atleast one of the Android or iOS settings must be enabled for the Custom Notification App.
    INVALID_NOTIFICATION_SERVICE:
      value:
        ErrorCode: 8047
        Message: Push notification authenticator configuration is invalid.
        Description: The value can be “AWS” or “Native”.
    INVALID_IOS_ENVIRONMENT:
      value:
        ErrorCode: 8047
        Message: Push notification authenticator configuration is invalid.
        Description: The value can be “Production” or “Sandbox”.
    INVALID_NOTIFICATION_SERVICE_CUSTOM:
      value:
        ErrorCode: 8047
        Message: Push notification authenticator configuration is invalid.
        Description: Please provide a value for the Notification Service field when the Notification App is set to Custom.
    SECURITY_QUESTION_NOT_ENABLED:
      value:
        ErrorCode: 7951
        Message: Site is not configured for security question
        Description: Request couldn't be processed, security question feature is not enabled for this site.
    SECURITY_QUESTION_ALREADY_ADDED:
      value:
        ErrorCode: 7948
        Message: Security question already exists
        Description: A similar security question has already been configured.
    INVALID_QUESTION_ID:
      value:
        ErrorCode: 7949
        Message: Security question not found or does not exist
        Description: The requested security question id is invalid or does not exist.
    SECURITY_QUESTION_CONFIG_NOT_FOUND:
      value:
        ErrorCode: 7947
        Message: Security question configuration not found
        Description: Security question settings are not configured or the resource does not exist.
    SECURITY_QUESTION_RENDER_COUNT_ERROR:
      value:
        ErrorCode: 8010
        Message: Can not update security question configuration's number of security question to appear count.
        Description: The number of security questions to appear count of security question configuration should be greater than or equal to the number of security question to appear count of two factor security question authenticator.
    DOMAIN_WHITE_LISTING_NOT_ENABLED:
      value:
        Message: Site is not configured for Domain White Listing.
        Description: Request couldn't be processed, Domain White Listing feature is not enabled for this site.
        ErrorCode: 8110
    DOMAIN_RESTRICTION_CONFIG_NOT_FOUND:
      value:
        Message: Domain access restriction configuration not found.
        Description: Domain access restriction configuration is not configured or the resource does not exist.
        ErrorCode: 8111
    SAME_DOMAIN_OR_EMAIL_CANNOT_EXIST_IN_BOTH_LIST:
      summary: SAME_DOMAIN_OR_EMAIL_CANNOT_EXIST_IN_BOTH_LIST
      value:
        ErrorCode: 8190
        Message: Same domain or email cannot exist in both list.
        Description: Same domain or email cannot exist in both list. Please add it to the appropriate list.
    EMAIL_TEMPLATE_NOT_CREATED:
      value:
        ErrorCode: 7922
        Message: Email template is not configured.
        Description: You have not added any email templates for this site, Please add at least one email template.
    PARAMETER_NOT_WELL_FORMATTED_ALPHANUMERIC:
      value:
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
        Description: The value of '%s' property should be a valid alphanumeric format.
    PARAMETER_NOT_WELL_FORMATTED_EMAIL:
      value:
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
        Description: The value of '%s' property should be a valid email format.
    INVALID_FROM_EMAIL_OR_NAME:
      value:
        ErrorCode: 8099
        Message: Invalid email templates configuration
        Description: '''FromName'' and ''FromEmail'' must be both valid or both empty.'
    INVALID_EMAIL_TYPE:
      value:
        ErrorCode: 8099
        Message: Invalid email templates configuration
        Description: The email type is invalid. Please provide a valid email type.
    INVALID_EMAIL_TEMPLATES_INVALID_EMAIL_TYPE:
      summary: INVALID_EMAIL_TEMPLATES_INVALID_EMAIL_TYPE
      value:
        ErrorCode: 8099
        Message: Invalid email templates configuration
        Description: The verification token type can't be updated for this email type. Please provide a valid email type.
    INVALID_EMAIL_TEMPLATES_INVALID_TOKEN_TYPE:
      summary: INVALID_EMAIL_TEMPLATES_INVALID_TOKEN_TYPE
      value:
        ErrorCode: 8099
        Message: Invalid email templates configuration
        Description: The email verification token type is invalid. Please provide a valid email verification token type.
    EMAIL_TEMPLATE_EXISTS:
      value:
        ErrorCode: 7930
        Message: Email template already exist.
        Description: The email template is already exist, Please use a different or unique name for the new email template.
    EMAIL_TEMPLATE_NOT_EXISTS:
      value:
        ErrorCode: 7923
        Message: Email template does not exist
        Description: The email template does not exist, Please use a valid email template.
    PROVIDER_NOT_CONFIGURED_PARTNER:
      summary: PROVIDER_NOT_CONFIGURED_PARTNER
      value:
        Message: Provider not configured
        Description: Provider not configured, Please provide valid provider name.
        ErrorCode: 8147
    PROVIDER_NOT_ACTIVE:
      value:
        Message: Provider is not active
        Description: Provider is not active, Please provide valid provider name.
        ErrorCode: 8041
    PROVIDER_IS_NOT_SUPPORT_CONFIGURATION_SETTINGS:
      value:
        Message: Your selected configuration setting is not supported by the ID provider
        Description: This provider does not support your current configuration settings, Please change the provider configuration.
        ErrorCode: 7910
    PROVIDER_IS_NOT_VALID:
      value:
        Message: Provider name is invalid
        Description: The provider name used in the request is incorrect or does not exist, Please use a valid provider name
        ErrorCode: 7911
    ATLEAST_ONE_MFA:
      value:
        ErrorCode: 8020
        Message: At least one MFA method must be enabled.
        Description: At least one MFA method must be enabled. Enable another MFA option before disabling this one
    DUO_AUTH_NOT_ENABLED_PARTNER:
      summary: DUO_AUTH_NOT_ENABLED_PARTNER
      value:
        ErrorCode: 8072
        Message: Site is not configured for Duo Security Authenticator MFA.
        Description: Request couldn't be processed,Duo Security Authenticator MFA feature is not enabled for this site.
    GOOGLE_AUTHENTICATOR_CONFIG_NOT_FOUND:
      value:
        ErrorCode: 7952
        Message: Google Authenticator settings not found or does not exist
        Description: There is no google authenticator settings/configuration available.
    DUO_AUTH_SETTINGS_NOT_FOUND:
      value:
        ErrorCode: 8073
        Message: Duo Security Authenticator settings not found or does not exist
        Description: There is no Duo Security Authenticator settings/configuration available.
    PARAMETER_NOT_WELL_FORMATTED_INVALID:
      value:
        ErrorCode: 7900
        Message: A parameter is not formatted correctly.
        Description: The value of '%s' property is invalid.
    CAPTCHA_CONFIG_VALUE_NOT_VALID:
      value:
        Message: Captcha config is invalid
        Description: One or more captcha configuration value is missing (key, secret or threshold). Please provide all the necessary captcha fields.
        ErrorCode: 8021
    CAPTCHA_THRESHOLD_INVALID:
      value:
        Message: Captcha config is invalid
        Description: Threshold value must be between 0 and 1. Please provide a valid threshold and try again.
        ErrorCode: 8021
    IP_AUTHORIZATION_DISABLED:
      value:
        ErrorCode: 7973
        Message: Site is not configured for IP Restrictions.
        Description: Request couldn't be processed,IP Restrictions feature is not enabled for this site.
    SPECIAL_CHARACTERS_NOT_ALLOWED:
      value:
        ErrorCode: 8019
        Message: Only hyphen (-) is allowed between the start IP and end IP
        Description: Only hyphen (-) is allowed between the start IP and end IP. Please try again.
    INVALID_IP_ADDRESS:
      value:
        ErrorCode: 8018
        Message: Invalid IP configuration
        Description: Request couldn't be processed, IP address is invalid or not well formatted.
    SAME_START_AND_END:
      value:
        ErrorCode: 7975
        Message: Start IP and End IP cannot be the same
        Description: Start IP and End IP cannot be the same. Please try again.
    INVALID_IP_ADDRESS_RANGE:
      value:
        ErrorCode: 8018
        Message: Invalid IP configuration
        Description: Start IP should be lower than the end IP and both IP addresses must be valid. Ensure that the provided range is valid.
    JWT_CONFIG_NOT_FOUND:
      value:
        Description: JWT configuration not found or the resource does not exist.
        ErrorCode: 7958
        Message: JWT configuration not found
    SSO_APPNAME_REQUIRED:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The AppName is required. Please use a valid AppName.
    SSO_APPNAME_LENGTH_EXCEEDED:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The AppName length exceeded the maximum limit of 60 characters. Please enter a valid AppName.
    SSO_APPNAME_INVALID:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The AppName provided is invalid. It must contain only alphanumeric characters, hyphens (-), and underscores (_), and must not start or end with a hyphen or underscore. Please use a valid AppName.
    JWT_ALOGITHM_REQUIRED:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The Algo is required. Please use a valid Algo.
    JWT_ALOGRITHM_INVALID:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The Algo provided is invalid. Please use a valid Algo.
    JWT_RESPONSE_MODE_INVALID:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The ResponseMode provided is invalid. Please use a valid ResponseMode.
    JWT_QUERY_STRING_PARAMETER_INVALID:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The QueryStringParameter provided is invalid. It must contain only alphanumeric characters, hyphens (-), and underscores (_),Please enter a valid QueryStringParameter.
    JWT_LOGIN_URL_INVALID:
      value:
        Message: Jwt configuration not valid
        Description: The LoginUrl provided is invalid. Please use a valid LoginUrl.
        ErrorCode: 8087
    JWT_EXPIRY_TIME_INVALID:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The NotAfterDifference provided is invalid. Please use a valid NotAfterDifference.
    JWT_NOT_BEFORE_INVALID:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The NotBeforeDifference provided is invalid. Please use a valid NotBeforeDifference.
    JWT_NOT_BEFORE_LESS_THAN_EXPIRY:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The NotBeforeDifference must be less than NotAfterDifference. Please use a valid NotBeforeDifference.
    JWT_SECRET_REQUIRED:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The Secret is required. Please use a valid Secret.
    JWT_SECRET_INVALID:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The Secret is not compatible with the %s Algo. Please use a valid Secret.
    JWT_MAPPING_REQUIRED:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The Mapping is required. Please use a valid Mapping.
    JWT_MAPPING_INVALID:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The Mapping provided is invalid. Please use a valid Mapping.
    JWT_CONFIG_ALREADY_EXIST:
      value:
        Description: Request couldn't be processed due duplicated app name of JWT configuration, Please use a unique name in order to process this request.
        ErrorCode: 7960
        Message: A JWT config already exist
    RAAS_UPDATE_FIELDS_INVALID:
      value:
        Message: Jwt configuration not valid
        Description: The UpdateFields provided is invalid. Please enter a valid UpdateFields.
        ErrorCode: 8087
    SSO_MAPPING_INVALID_JWT_SP:
      value:
        Message: Jwt configuration not valid
        Description: The Mapping provided is invalid. Please enter a valid Mapping.
        ErrorCode: 8087
    ID_MAPPING_REQUIRED:
      value:
        Message: Jwt configuration not valid
        Description: The ID Mapping is required. Please enter a valid ID Mapping.
        ErrorCode: 8087
    SSO_MAPPING_REQUIRED_JWT_SP:
      value:
        Message: Jwt configuration not valid
        Description: The Mapping is required. Please enter a valid Mapping.
        ErrorCode: 8087
    JWT_CLOCK_SKEW_INVALID:
      value:
        Message: Jwt configuration not valid
        Description: The ClockSkew provided is invalid. Please enter a valid ClockSkew.
        ErrorCode: 8087
    JWT_AUDIENCE_REQUIRED:
      value:
        Message: Jwt configuration not valid
        Description: The Audience is required. Please enter a valid Audience.
        ErrorCode: 8087
    JWT_ISSUER_REQUIRED:
      value:
        Message: Jwt configuration not valid
        Description: The Issuer is required. Please enter a valid Issuer.
        ErrorCode: 8087
    AUTO_LOOKUP_DOMAIN_INVALID:
      value:
        Message: Jwt configuration not valid
        Description: The Domain provided is invalid. Please enter a valid email Domain.
        ErrorCode: 8087
    DOMAIN_NAME_IS_REQUIRED_JWT_SP:
      value:
        Message: Jwt configuration not valid
        Description: You have chosen EnableAutoLookUp as true. Please enter a valid domain name.
        ErrorCode: 8087
    JWT_JWKSURL_INVALID:
      value:
        Message: Jwt configuration not valid
        Description: The JWKSURL provided is invalid. Please enter a valid JWKSURL.
        ErrorCode: 8087
    JWT_KEY_INVALID:
      value:
        Message: Jwt configuration not valid
        Description: The Key provided is invalid. Please enter a valid Key.
        ErrorCode: 8087
    JWT_LOGIN_URL_INVALID_JWT_SP:
      value:
        ErrorCode: 8087
        Message: Jwt configuration not valid
        Description: The LoginUrl provided is invalid. Please use a valid LoginUrl.
    JWT_ALGORITHM_REQUIRED:
      value:
        Message: Jwt configuration not valid
        Description: The Algo is required. Please enter a valid Algo.
        ErrorCode: 8087
    SSO_APPNAME_INVALID_JWT_SP:
      value:
        Message: Jwt configuration not valid
        Description: The AppName provided is invalid. It must contain only alphanumeric characters, hyphens (-), and underscores (_), and must not start or end with a hyphen or underscore. Please use a valid AppName.
        ErrorCode: 8087
    SSO_APPNAME_REQUIRED_JWT_SP:
      value:
        Message: Jwt configuration not valid
        Description: The AppName is required. Please use a valid AppName.
        ErrorCode: 8087
    SSO_APPNAME_LENGTH_EXCEEDED_JWT_SP:
      value:
        Message: Jwt configuration not valid
        Description: The AppName length exceeded the maximum limit of 60 characters. Please enter a valid AppName.
        ErrorCode: 8087
    MISSING_JWKSURL:
      value:
        Message: Jwt configuration not valid
        Description: Atleast one of the Key or JWKS URL fields with a valid input is required for an ES or RS algorithm.
        ErrorCode: 8087
    MISSING_JWT_KEY:
      value:
        Message: Jwt configuration not valid
        Description: A valid JWT key is required in the `key` field for an HS algorithm.
        ErrorCode: 8087
    DOMAIN_NAME_ALREADY_EXISTS:
      value:
        Message: Domain name already exists
        Description: The entered domain name is already associated with a configuration. Please input a different domain name.
        ErrorCode: 8038
    SAML_CONFIG_NOT_FOUND:
      value:
        Description: Security Assertion Markup Language (SAML) configuration is not configured or the resource does not exist.
        ErrorCode: 7938
        Message: SAML configuration not found
    SSO_APPNAME_REQUIRED_SAML:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AppName is required. Please use a valid AppName.
    SSO_APPNAME_LENGTH_EXCEEDED_SAML:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AppName length exceeded the maximum limit of 60 characters. Please enter a valid AppName.
    SSO_APPNAME_INVALID_SAML:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AppName provided is invalid. It must contain only alphanumeric characters, hyphens (-), and underscores (_), and must not start or end with a hyphen or underscore. Please use a valid AppName.
    SAML_IDP_LOCATION_BINDING_REQUIRED:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AssertionConsumerService Location and Binding is required. Please enter a valid AssertionConsumerService Location and Binding.
    SAML_IDP_BINDING_INVALID:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AssertionConsumerService Binding is invalid. Please enter a valid AssertionConsumerService Binding.
    SAML_IDP_LOCATION_REQUIRED:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AssertionConsumerService Location is required. Please enter a valid AssertionConsumerService Location.
    SAML_IDP_LOCATION_INVALID:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AssertionConsumerService Location is invalid. Please enter a valid AssertionConsumerService Location.
    SAML_SP_LOGOUT_URI_REQUIRED_IDP:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The SpLogoutUrl is required. Please enter a valid SpLogoutURI.
    SAML_SP_LOGOUT_INVALID_IDP:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The SpLogoutUrl is invalid. Please enter a valid SpLogoutUrl.
    SAML_LOGIN_URI_REQUIRED:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The LoginUrl is required. Please enter a valid LoginURI.
    SAML_LOGIN_URI_INVALID:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The LoginUrl is invalid. Please enter a valid LoginURI.
    SAML_AFTER_LOGOUT_URI_REQUIRED:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AfterLogoutUrl is required. Please enter a valid AfterLogoutURI.
    SAML_AFTER_LOGOUT_URI_INVALID:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The AfterLogoutUrl is invalid. Please enter a valid AfterLogoutURI.
    SAML_SP_CERTIFICATE_INVALID:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The SpCertificate is invalid. Please enter a valid SpCertificate.
    SAML_SP_CERTIFICATE_REQUIRED:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The SpCertificate is required. Please enter a valid SpCertificate.
    SAML_ATTRIBUTE_FORMAT_REQUIRED:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The Attribute Format is required. Please enter a valid AttributeFormat.
    SAML_AUDIENCE_REQUIRED:
      value:
        ErrorCode: 8097
        Message: SAML IDP config is invalid
        Description: The Audiences is required. Please enter a valid Audiences.
    SAML_CONFIG_ALREADY_ADDED:
      value:
        Description: Security Assertion Markup Language (SAML) configuration for the provided ProviderName has already been added to your LoginRadius site.
        ErrorCode: 7939
        Message: SAML configuration already exist
    SAML_PROVIDR_NAME_INVALID:
      value:
        Message: SAML SP config is invalid
        Description: The Provider is invalid. It must contain only alphanumeric characters, hyphens (-), and underscores (_), and cannot start or end with a hyphen or underscore. Please enter a valid Provider name.
        ErrorCode: 8089
    SAML_PROVIDR_NAME_LENGTH_EXCEEDED:
      value:
        Message: SAML SP config is invalid
        Description: The Provider name length exceeded the maximum limit of 60 characters. Please enter a valid Provider name.
        ErrorCode: 8089
    SSO_FRIENDLY_PROVIDER_NAME_INVALID:
      value:
        Message: SAML SP config is invalid
        Description: The FriendlyProviderName is invalid. Please enter a valid FriendlyProviderName with a maximum length of 60 characters.
        ErrorCode: 8089
    SAML_IDP_CERTIFICATE_IS_REQUIRED:
      value:
        Message: SAML SP config is invalid
        Description: The IdpCertificate is required. Please enter a valid IdpCertificate.
        ErrorCode: 8089
    SAML_IDP_CERTIFICATE_INVALID:
      value:
        Message: SAML SP config is invalid
        Description: The IdpCertificate is invalid. Please enter a valid IdpCertificate.
        ErrorCode: 8089
    SSO_MAPPING_INVALID:
      value:
        Message: SAML SP config is invalid
        Description: The Mapping provided is invalid. Please enter a valid Mapping.
        ErrorCode: 8089
    SSO_MAPPING_REQUIRED:
      value:
        Message: SAML SP config is invalid
        Description: The Mapping is required. Please enter a valid Mapping.
        ErrorCode: 8089
    INVALID_DOMAIN_NAME_SP:
      value:
        Message: SAML SP config is invalid
        Description: The provided domain name is invalid. Please enter a valid domain name.
        ErrorCode: 8089
    DOMAIN_NAME_IS_REQUIRED_SP:
      value:
        Message: SAML SP config is invalid
        Description: You have chosen EnableAutoLookUp as true. Please enter a valid domain name.
        ErrorCode: 8089
    SAML_SP_LOGOUT_INVALID:
      value:
        Message: SAML SP config is invalid
        Description: The IdentityProvider Logout is invalid. Please enter a valid IdentityProvider Logout.
        ErrorCode: 8089
    SAML_SP_LOCATION_INVALID:
      value:
        Message: SAML SP config is invalid
        Description: The IdentityProvider Location is invalid. Please enter a valid IdentityProvider Location.
        ErrorCode: 8089
    SAML_SP_LOGOUT_REQUIRED:
      value:
        Message: SAML SP config is invalid
        Description: The IdentityProvider Logout is required. Please enter a valid IdentityProvider Logout.
        ErrorCode: 8089
    SAML_SP_LOCATION_REQUIRED:
      value:
        Message: SAML SP config is invalid
        Description: The IdentityProvider Location is required. Please enter a valid IdentityProvider Location.
        ErrorCode: 8089
    SAML_SP_BINDING_INVALID:
      value:
        Message: SAML SP config is invalid
        Description: The IdentityProvider Binding is invalid. Please enter a valid IdentityProvider Binding.
        ErrorCode: 8089
    SAML_SP_LOCATION_LOGOUT_BINDING_REQUIRED:
      value:
        Message: SAML SP config is invalid
        Description: The IdentityProvider Location, Logout and Binding is required. Please enter a valid IdentityProvider Location, Logout and Binding.
        ErrorCode: 8089
    SAML_PROVIDR_NAME_REQUIRED:
      value:
        Message: SAML SP config is invalid
        Description: The Provider is required. Please enter a Provider name.
        ErrorCode: 8089
    CUSTOM_FIELD_LIMIT_EXCEEDED:
      value:
        Message: Custom field limit exceeded
        Description: The maximum number of custom fields allowed is 15. Please remove some custom fields to add new ones.
        ErrorCode: 8042
    CUSTOM_FIELD_NOT_FOUND:
      value:
        Message: Custom field does not exist
        Description: The Custom field is not configured, Please configure the custom fields before proceeding.
        ErrorCode: 7929
    CUSTOM_FIELD_ALLREADY_EXISTS:
      value:
        Message: Custom field is already created
        Description: This custom field is already created for this site, Please use the existing field.
        ErrorCode: 7919
    CUSTOMER_REGISTRATION_CUSTOM_DATA_NOT_EXISTS:
      value:
        Message: Custom data is not configured for this site
        Description: The Custom data is not configured for this site, Please configure the custom data.
        ErrorCode: 7928
    SSO_APPNAME_REQUIRED_OAUTH:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The AppName is required. Please use a valid AppName.
    SSO_APPNAME_LENGTH_EXCEEDED_OAUTH:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The AppName length exceeded the maximum limit of 60 characters. Please enter a valid AppName.
    SSO_APPNAME_INVALID_OAUTH:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The AppName provided is invalid. It must contain only alphanumeric characters, hyphens (-), and underscores (_), and must not start or end with a hyphen or underscore. Please use a valid AppName.
    OAUTH_AUDIENCE_SCOPES_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The AudienceScopes provided is invalid, Please enter a valid AudienceScopes.
    OAUTH_APPLICATION_TYPE_REQUIRED:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The ApplicationType is required, Please enter a valid ApplicationType.
    OAUTH_APPLICATION_TYPE_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The ApplicationType provided are invalid, Please enter a valid ApplicationType.
    OAUTH_PROTOCOL_REQUIRED:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The Protocol is required, Please enter a valid Protocol.
    OAUTH_PROTOCOL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The Protocol provided is invalid, Please enter a valid Protocol.
    OAUTH_GRANT_TYPE_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The GrantTypes provided are invalid, Please enter a valid GrantType.
    OAUTH_SERVICE_GRANT_TYPE_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The GrantTypes provided are invalid, With ApplicationType service, only client_credentials GrantTypes is allowed.
    OAUTH_NON_SERVICE_GRANT_TYPE_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The GrantTypes provided are invalid, With ApplicationType web, spa or native, client_credentials GrantTypes is not allowed.
    OAUTH_SCOPE_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The AllowedScopes provided are invalid, Please enter a valid scope.
    OAUTH_TOKEN_AUTH_METHOD_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The TokenAuthMethod provided is invalid, Please enter a valid TokenAuthMethod.
    OAUTH_JWTCONFIG_TOKEN_TTL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The JwtTokenConfig IdTokenTTL provided is invalid, Please enter a valid JwtTokenConfig IdTokenTTL.
    OAUTH_REFRESH_TOKEN_TTL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The RefreshTokenTTL provided is invalid, Please enter a valid RefreshTokenTTL
    OAUTH_REFRESH_TOKEN_TTL_MUST_GT_TOKEN_TTL:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The RefreshTokenTTL provided must be greater than JwtTokenConfig TokenTTL, if JwtTokenConfig TokenTTL not provided then RefreshTokenTTL must be greater than 3600.
    OAUTH_LOGIN_REDIRECT_URL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The LoginRedirectURL provided is invalid, Please enter a valid LoginRedirectURL
    OAUTH_CORS_ORIGIN_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The AllowedCorsOrigin provided is invalid, Please enter a valid AllowedCorsOrigin URLs
    OAUTH_DEVICE_CODE_BOTH_VERIFICATION_URL_REQUIRED:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The DeviceCodeConfig VerificationURL and AfterVerificationURL are required.
    OAUTH_DEVICE_CODE_VERIFICATION_URL_REQUIRED:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The DeviceCodeConfig VerificationURL is required.
    OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_REQUIRED:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The DeviceCodeConfig AfterVerificationURL is required.
    OAUTH_DEVICE_CODE_EXPIRE_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The DeviceCodeExpire provided is invalid, Please enter a valid DeviceCodeExpire
    OAUTH_DEVICE_CODE_POLLING_INTERVAL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The PollingInterval provided is invalid, Please enter a valid PollingInterval
    OAUTH_DEVICE_CODE_USER_CHAR_SET_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The DeviceCodeConfig UserCodeCharacterSet provided is invalid, Please enter a valid UserCodeCharacterSet
    OAUTH_DEVICE_CODE_USER_CODE_MASK_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The DeviceCodeConfig UserCodeMask provided is invalid, Please enter a valid UserCodeMask
    OAUTH_DEVICE_CODE_VERIFICATION_URL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The DeviceCodeConfig VerificationURL provided is invalid, Please enter a valid VerificationURL
    OAUTH_DEVICE_CODE_AFTER_VERIFICATION_URL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The DeviceCodeConfig AfterVerificationURL provided is invalid, Please enter a valid AfterVerificationURL
    OAUTH_LOGOUT_REDIRECT_URL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The LogoutRedirectURL provided is invalid, Please enter a valid LogoutRedirectURL
    OAUTH_CIBA_TOKEN_TTL_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The BackChannelLogout LogoutTokenTTL provided is invalid, Please enter a valid LogoutTokenTTL.
    OAUTH_CIBA_LOGOUT_URI_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The BackChannelLogout LogoutURI provided is invalid, Please enter a valid BackChannelLogout LogoutURI
    OAUTH_CIBA_LOGOUT_URI_REQUIRED:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The BackChannelLogout LogoutURI is required.
    OAUTH_SECRET_FORMAT_INVALID:
      value:
        ErrorCode: 8088
        Message: OAuth configuration not valid
        Description: The Secret provided is not formatted or invalid, Please enter a valid Secret.
    OAUTH_CONFIG_ALREADY_EXIST:
      value:
        Description: OAuth configuration already exist for this site, Please use a unique name in order to process this request.
        ErrorCode: 7982
        Message: A OAuth config already exist
    OAUTH_CONFIG_NOT_FOUND:
      value:
        Description: OAuth configuration not found or the resource does not exist.
        ErrorCode: 7981
        Message: OAuth configuration not found
    OAUTH_CONFIG_CREDENTIALS_RESET_FAILED:
      value:
        Description: Global client is enabled for the oauth config. Please disable the global client first.
        ErrorCode: 8014
        Message: Oauth config client credentials reset failed.
    ERROR_UNMARSHALLING_DATA:
      value:
        Message: Error unmarshalling data
        Description: Error unmarshalling data, Please provide valid data.
        ErrorCode: 8081
    CUSTOM_OAUTH_CONFIG_NOT_FOUND:
      value:
        Message: Custom OAuth configuration not found
        Description: Custom OAuth provider is not configured or the resource does not exist.
        ErrorCode: 7936
    INVALID_DOMAIN_NAME:
      value:
        Message: Invalid custom provider config
        Description: The provided domain name is invalid. Please enter a valid domain name.
        ErrorCode: 8007
    DOMAIN_NAME_IS_REQUIRED:
      value:
        Message: Invalid domain name
        Description: You have chosen EnableAutoLookUp as true. Please enter a valid domain name.
        ErrorCode: 8039
    CUSTOM_OAUTH_PROVIDER_ALREADY_ADDED:
      value:
        Message: Custom OAuth provider already exist
        Description: A custom OAuth provider is already configured on your site.
        ErrorCode: 7937
    ERROR_RAAS_CONFIG_EMPTY:
      value:
        Message: Raas config is empty
        Description: Raas config is empty, Please provide valid data.
        ErrorCode: 8083
    INVALID_EXPIRATION_FREQUENCY_TYPE:
      value:
        Message: Invalid password policy configuration
        Description: Invalid expiration frequency type, Please provide valid type.
        ErrorCode: 7983
    INVALID_EXPIRATION_FREQUENCY:
      value:
        Message: Invalid password policy configuration
        Description: Invalid expiration frequency, Please provide valid frequency.
        ErrorCode: 7983
    INVALID_MAX_PASSWORD_HISTORY:
      value:
        Message: Invalid password policy configuration
        Description: The maximum password history value is invalid. Please provide a valid value between 1 and 100.
        ErrorCode: 7983
    CUSTOMER_REGISTRATION_CONFIG_NOT_FOUND:
      value:
        Message: User registration configuration not found
        Description: The user registration configuration does not exist for this site. Please setup the configuration for user registration.
        ErrorCode: 7933
    ApiKeySecretMissing:
      summary: ApiKeySecretMissing
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly in the request, please check all the parameters in the API call.
        Description: The apikey is a required parameter,The apisecret is a required parameter.
    ApiKeyMissing:
      summary: ApiKeyMissing
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly in the request, please check all the parameters in the API call.
        Description: The apikey is a required parameter.
    ApiSecretMissing:
      summary: ApiSecretMissing
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly in the request, please check all the parameters in the API call.
        Description: The apisecret is a required parameter.
    ApiKeyInvalid:
      summary: ApiKeyInvalid
      value:
        ErrorCode: 920
        Message: API key is invalid
        Description: The provided LoginRadius API key is invalid, please use a valid API key of your LoginRadius account.
    ApiSecretInvalid:
      summary: ApiSecretInvalid
      value:
        ErrorCode: 921
        Message: API secret is invalid
        Description: The provided LoginRadius API secret is invalid, please use a valid API secret of your LoginRadius account.
    NextParamInvalid:
      summary: NextParamInvalid
      value:
        ErrorCode: 1042
        Message: Pass a valid next param
        Description: The next param is either expired or invalid. Please start with a POST request again.
    NextParamNotValid:
      summary: NextParamNotValid
      value:
        ErrorCode: 1046
        Message: Pass a valid next param
        Description: The next param is not valid.
    AccessRestriction:
      summary: AccessRestriction
      value:
        ErrorCode: 909
        Message: Your LoginRadius site does not have permission to access this endpoint
        Description: Your LoginRadius site does not have permission to access this endpoint, please contact LoginRadius support for more information.
    NextParamMissing:
      summary: NextParamMissing
      value:
        ErrorCode: 1043
        Message: Pass a valid next param
        Description: The next param is missing. Please start with a POST request to get next value.
    ApiKeyUnauthorized:
      summary: ApiKeyUnauthorized
      value:
        ErrorCode: 901
        Message: The API key is unauthorized
        Description: The provided LoginRadius API key is invalid or is not authorized, please use a valid or authorized LoginRadius API key or check the API key for your LoginRadius account.
    ApiSecretUnauthorized:
      summary: ApiSecretUnauthorized
      value:
        ErrorCode: 902
        Message: The API Secret is unauthorized
        Description: The provided LoginRadius API secret is invalid or is not authorized, please use a valid LoginRadius API secret or check the API secret for your LoginRadius account.
    PostBodyInvalid:
      summary: PostBodyInvalid
      value:
        ErrorCode: 965
        Message: The post body is invalid.
        Description: Please use a valid post body and make sure that it is in a valid JSON format.
    ParameterBadFormat:
      summary: ParameterBadFormat
      value:
        ErrorCode: 908
        Message: A parameter is not formatted correctly in the request, please check all the parameters in the API call.
        Description: Verify that the datatypes for all of the parameters and parameters are correct when making the API call.
    DateRangeMissing:
      summary: DateRangeMissing
      value:
        ErrorCode: 928
        Message: The date range is missing
        Description: From & To dates are required parameters. please pass correct From & To dates.
    DateRangeFromInvalidFormat:
      summary: DateRangeFromInvalidFormat
      value:
        ErrorCode: 925
        Message: The date range has an invalid format
        Description: The From date has an invalid format, please use a valid ISO_8601 date format.
    DateRangeToInvalidFormat:
      summary: DateRangeToInvalidFormat
      value:
        ErrorCode: 926
        Message: The date range has an invalid format
        Description: The To date has an invalid format, please use a valid ISO_8601 date format.
    DateRangeInvalid:
      summary: DateRangeInvalid
      value:
        ErrorCode: 927
        Message: The date range is invalid
        Description: The From data is greater than or equal to the To date, please pass correct From & To dates.
    QueryFormatInvalid:
      summary: QueryFormatInvalid
      value:
        ErrorCode: 919
        Message: The query format is not valid
        Description: The format of the query is not valid, query should be an object.
    QueryInvalid:
      summary: QueryInvalid
      value:
        ErrorCode: 918
        Message: The query is invalid
        Description: The query is not correct, please review the query and send the correct parameters.
    CustomObjectNameInvalid:
      summary: CustomObjectNameInvalid
      value:
        ErrorCode: 1064
        Message: Custom object name is invalid
        Description: The custom object name used in this request is incorrect or does not exist.
    CustomObjectNotAvailable:
      summary: CustomObjectNotAvailable
      value:
        ErrorCode: 1064
        Message: Custom objects are not available
        Description: The custom objects are not available for this App. Please contact LoginRadius support for more information
    CustomObjectNameMissing:
      summary: CustomObjectNameMissing
      value:
        ErrorCode: 1036
        Message: The Custom Object name is required
        Description: The Custom Object name is required, please pass a Custom Object name.
    CustomObjectSchemaNotSet:
      summary: CustomObjectSchemaNotSet
      value:
        ErrorCode: 1003
        Message: Schema is not set for the passed Custom Object
        Description: The Custom Object schema is not set in dashboard. Schema should be set to query Custom Object. Please contact LoginRadius Support.
    DANGEROUS_REQUEST_SSO:
      value:
        Description: A potentially dangerous request value was detected.
        ErrorCode: 1214
        Message: Dangerous request
    EMAIL_PAYLOAD_REQUIRED:
      value:
        Description: The email is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    EMAILID_ID_FORMAT_NOT_VALID_SSO:
      value:
        Description: The provided email ID is invalid or not well-formatted, a valid email ID is required in order to process this request.
        ErrorCode: 1038
        Message: Valid email ID is required
    INVALID_HOST:
      value:
        Description: Your request is coming from an invalid host and this host is not configured on LoginRadius. <br />Please follow <a href='https://docs.loginradius.com/api/v2/troubleshooting/invalid-request-uri-error/'target='_blank'>these instructions</a> to get the social login working on your website.
        ErrorCode: 1309
        Message: Invalid Requested Host
    INVALID_PHONE_NUMBER_SSO:
      value:
        Description: The provided phone number is not valid or not well-formatted, please review the phone number in order to process this request.
        ErrorCode: 1096
        Message: Invalid phone number.
    INVALID_POST_BODY:
      value:
        Description: Please use a valid post body and make sure that it is in a valid JSON format
        ErrorCode: 2007
        Message: invalid_request
    JWT_APP_NAME_REQUIRED:
      value:
        Description: The JwtApp is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    JWT_APP_NOT_MATCHED:
      value:
        Description: The jwtapp query parameter did not match the value in the request path.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    PASSWORD_EMAIL_PAYLOAD_REQUIRED:
      value:
        Description: The password is a required parameter, The email is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    PASSWORD_PAYLOAD_REQUIRED:
      value:
        Description: The password is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    PASSWORD_PHONE_PAYLOAD_REQUIRED:
      value:
        Description: The password is a required parameter, The phone is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    PASSWORD_USERNAME_PAYLOAD_REQUIRED:
      value:
        Description: The password is a required parameter, The username is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    PHONE_OR_EMAIL_OR_USER_REQUIRED_PARAM_SSO:
      value:
        Description: The email/username/phone is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    PHONE_PAYLOAD_REQUIRED_SSO:
      value:
        Description: The phone is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    POST_BODY_INVALID_SSO:
      value:
        Description: Please use a valid post body and make sure that it is in a valid JSON format.
        ErrorCode: 965
        Message: The post body is invalid
    USERNAME_PAYLOAD_REQUIRED:
      value:
        Description: The username is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    JWT_CONFIG_NOT_FOUND_SSO:
      value:
        Description: The JWT configuration not found or the resource does not exist.
        ErrorCode: 1180
        Message: JWT configuration not found.
    JWT_CONFIG_NOT_VALID:
      value:
        Description: The JWT configuration is not valid, please check the JWT configuration for your LoginRadius account.
        ErrorCode: 1189
        Message: JWT configuration not valid.
    USERNAME_OR_PASSWORD_WRONG_SSO:
      value:
        Description: Please use a valid user ID and password combination.
        ErrorCode: 966
        Message: Invalid user ID and/or password
    GENERIC_AUTH_ERROR_SSO:
      summary: GENERIC_AUTH_ERROR
      value:
        Description: The credentials provided could not be authenticated.
        ErrorCode: 1409
        Message: Authentication failed
    ACCOUNT_NOT_ALLOWED_TO_LOGIN_SSO:
      value:
        Description: The provided account is not allowed to login, please reach out to LoginRadius support for more information.
        ErrorCode: 1220
        Message: Account is not allowed to login
    ACTIVE_SESSIONS_EXCEEDED_SSO:
      value:
        Description: You have exceeded the maximum number of allowed active login sessions. Please log out of any other active session before attempting to log in again. If you need further assistance, contact support.
        ErrorCode: 1338
        Message: Exceeded active login session limit
    API_KEY_NOT_VALID_SSO:
      value:
        Description: The provided LoginRadius API key is invalid or is not authorized, please use a valid or authorized LoginRadius API key or check the API key for your LoginRadius account.
        ErrorCode: 901
        Message: The API key is unauthorized
    APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT_SSO:
      value:
        Description: Your LoginRadius site does not have permission to access this endpoint, please contact LoginRadius support for more information.
        ErrorCode: 909
        Message: Your LoginRadius site does not have permission to access this endpoint
    BREACHED_PASSWORD_LOGIN_SSO:
      value:
        Description: Your password is found in a data breach unrelated to this app/service. Please reset your password using the email we sent you.
        ErrorCode: 1316
        Message: Your password is exposed in an external data breach.
    CAPTCHA_NOT_VALID_SSO:
      value:
        Description: CAPTCHA is invalid, please enter the correct CAPTCHA value.
        ErrorCode: 982
        Message: CAPTCHA is invalid
    CHANGE_BREACHED_PASSWORD:
      value:
        Description: Your password is exposed in an external data breach. As a caution, we’ve already sent you an email with steps to reset your password. Please try to login after resetting your password.
        ErrorCode: 1317
        Message: Please reset your password via the email we sent you.
    CONSENT_FORM_NOT_SUBMITTED_SSO:
      value:
        Description: Consent form not submitted, please accept the consent form.
        ErrorCode: 1226
        Message: Consent form not submitted.
    EMAIL_NOT_VERIFIED_SSO:
      value:
        Description: This email has not yet been verified, please click the link in your email to confirm your email address.
        ErrorCode: 970
        Message: Email is not verified
    EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED:
      value:
        Description: The email or phone number is not verified, please verify email or phone number for login.
        ErrorCode: 1287
        Message: Email or phone number is not verified
    LOGIN_DISABLED_SSO:
      value:
        Description: Login services have been disabled for your account, please contact the admin or site owner.
        ErrorCode: 1130
        Message: Login services have been disabled for your account
    LOGIN_IS_LOCKED_FOR_RECAPTCHA_SSO:
      value:
        Description: Your account has been locked, please login with a valid reCAPTCHA in order to continue.
        ErrorCode: 1132
        Message: Your account has been locked
    LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION_SSO:
      value:
        Description: Your account has been locked, please login with an answer to the security question in order to continue.
        ErrorCode: 1148
        Message: Your account has been locked
    LOGIN_WITH_PASSWORD_NOT_ENABLED_SSO:
      value:
        Description: Password-based login is disabled for your site. Please enable the Login with Password feature.
        ErrorCode: 1286
        Message: You cannot log in with a password
    OPERATION_FAILED_SSO:
      value:
        Description: An unknown error has occurred, please try again in a few minutes or contact your system admin.
        ErrorCode: 950
        Message: Operation failed due to an unknown error
    OTP_SEND_FAILED_SSO:
      value:
        Description: The Verification OTP Code sending failed, please try again.
        ErrorCode: 1072
        Message: The Verification code (OTP) send failed
    PHONE_NO_LOGIN_NOT_ENABLED_SSO:
      value:
        Description: Phone number login is not enabled on your site.
        ErrorCode: 1074
        Message: Phone number login is not enabled
    PHONE_NOT_VERIFIED_SSO:
      value:
        Description: The provided phone number is not verified, please use a verified phone number for login.
        ErrorCode: 1066
        Message: Phone number is not verified
    PIN_IS_REQUIRED_SSO:
      value:
        Description: The PIN is required and needs to be set, please set PIN in the profile for login.
        ErrorCode: 1243
        Message: PIN is required
    PRIVACY_POLICY_MISMATCHED_SSO:
      value:
        Description: You have not accepted the current Privacy Policy.
        ErrorCode: 1194
        Message: Privacy Policy does not match
    RBA_ACCOUNT_IS_BLOCKED:
      value:
        Description: Your account has been blocked by the system admin, please contact the admin for more information.
        ErrorCode: 1164
        Message: Your account has been blocked due to suspicious activity
    RBA_EMAIL_VERIFICATION:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your email to secure your account.
        ErrorCode: 1166
        Message: A verification code has been sent to your email
    RBA_SECURITY_ANSWER_VERIFICATION:
      value:
        Description: We have identified a suspicious activity with your account, please answer the security question's to secure your account.
        ErrorCode: 1165
        Message: Please answer the security question's to secure your account
    RBA_SMS_VERIFICATION:
      value:
        Description: We have identified a suspicious activity with your account, a verification code has been sent to your phone to secure your account.
        ErrorCode: 1167
        Message: A verification code has been sent to you phone
    SMS_CONFIGURATION_NOT_EXISTS_SSO:
      value:
        Description: The SMS configuration does not exist, please configure SMS settings.
        ErrorCode: 1071
        Message: The SMS configuration does not exist
    SMS_SEND_LIMIT_REACHED_SSO:
      value:
        Description: The account limit for SMS requests for this resource has been reached for this time due to too many request.
        ErrorCode: 1123
        Message: You have reached a limit for sending SMS
    TRIAL_PLAN_EXPIRED_SSO:
      value:
        Description: The trial plan has expired. To continue using the service, please contact support.
        ErrorCode: 6003
        Message: Trial plan expired
    USER_ID_BLOCKED_SSO:
      value:
        Description: Your account has been blocked by the system admin, please contact the admin for more information.
        ErrorCode: 991
        Message: Your account is blocked
    USER_ID_LOCKED_SSO:
      value:
        Description: Your account has been locked, please try again after sometime.
        ErrorCode: 1198
        Message: Your account has been locked
    USER_ID_LOCKED_WITH_TIMEOUT_SSO:
      value:
        Description: Your account has been locked, please try again after sometime.
        ErrorCode: 1198
        Message: Your account has been locked
    USER_NAME_AUTHENTICATION_ENABLED_SSO:
      value:
        Description: You can't login from email/phone, please use username for login.
        ErrorCode: 1183
        Message: UserName authentication is enabled
    USER_NOT_EXISTS_SSO:
      value:
        Description: The user's account does not exist, please use a valid user or create the user before processing this request.
        ErrorCode: 938
        Message: User does not exist
    INVALID_PROVIDER_IN_ORGANIZATION_SSO:
      value:
        Description: The specified provider is not valid or not configured for this organization. Please check your configuration.
        ErrorCode: 1269
        Message: Invalid provider in organization
    JWT_ACCESS_TOKEN_REQUIRED:
      value:
        Description: The access_token is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    OAUTH_TOKEN_CONFIG_NOT_FOUND_SSO:
      value:
        Description: Unable to retrieve token configuration for the specified app.
        ErrorCode: 2017
        Message: Request is invalid
    ORGANIZATION_NOT_FOUND_SSO:
      value:
        Description: The entered organization or its configuration does not exist.
        ErrorCode: 1273
        Message: Organization not found
    ACCESS_TOKEN_EXPIRED_SSO:
      value:
        Description: The LoginRadius access token has expired, please request a new token from LoginRadius API.
        ErrorCode: 906
        Message: Access token has expired
    ACCESS_TOKEN_NOT_VALID_SSO:
      value:
        Description: The LoginRadius access token is invalid, please use the correct or valid access token in order to process this request.
        ErrorCode: 905
        Message: Access token is invalid
    AGE_UNDERAGE_SSO:
      value:
        Description: You are not eligible for registration, your age must be above specified by admin of this site.
        ErrorCode: 1163
        Message: You are not eligible for registration
    EMAIL_DOMAIN_NOT_ALLOWED_IN_ORGANIZATION_SSO:
      value:
        Description: The email domain used is not allowed for this organization connection. Please use an valid domain.
        ErrorCode: 2065
        Message: Email domain not allowed in organization connection
    EMAIL_DOMAIN_NOT_ALLOWED_TO_REGISTER_SSO:
      value:
        Description: The provided Email id domain is not allowed to register, please reach out to LoginRadius support for more information.
        ErrorCode: 1247
        Message: Email id domain is not allowed to register
    EMAILID_ALREADY_REGISTERED_SSO:
      value:
        Description: The email address has to be unique for your LoginRadius site, please use a different email address.
        ErrorCode: 936
        Message: Email address is already registered with your LoginRadius site
    JWT_SP_TOKEN_INVALID_SSO:
      value:
        Description: JWT service provider token is invalid or expired, please use a valid token to process this request.
        ErrorCode: 1283
        Message: Invalid or expired JWT token
    ORGANIZATION_NOT_ACTIVE_SSO:
      value:
        Description: Organization is not active, Please provide valid organization id.
        ErrorCode: 8180
        Message: Organization is not active
    PHONE_NO_ALREADY_REGISTERED_SSO:
      value:
        Description: The phone number has to be unique for your LoginRadius site, please use a different phone number.
        ErrorCode: 1058
        Message: Phone number is already registered with your LoginRadius site
    PROVIDER_ID_MISSING_SSO:
      value:
        Description: provider ID is missing in social data.
        ErrorCode: 1302
        Message: provider ID is missing in social data
    PROVIDER_NOT_CONFIGURED_SSO:
      value:
        Description: This social provider has not been configured for the site.
        ErrorCode: 1223
        Message: Social provider has not been configured for the site.
    PROVIDER_NOT_SUPPORTED_SSO:
      value:
        Description: Oops, this ID Provider is not supported in your LoginRadius account.
        ErrorCode: 1232
        Message: Provider is not supported.
    PROVIDER_NOT_VALID_SSO:
      value:
        Description: The provider name or provider ID is invalid, please use a valid provider name or provider ID.
        ErrorCode: 1065
        Message: Provider name or Provider Id is invalid
    PROVIDER_SIDE_ERROR_SSO:
      value:
        Description: An error has occurred at the social identity provider’s end, please check the ‘providerErrorResponse’ for more details.
        ErrorCode: 1000
        Message: An error has occurred at the social identity provider’s end.
    ROLE_DOES_NOT_EXISTS_SSO:
      value:
        Description: The provided Role for the user does not exist, please use a valid Role in order to process this request.
        ErrorCode: 1047
        Message: Role does not exist
    SOMETHING_GOING_WRONG_SSO:
      value:
        Description: Oops, something went wrong, please try again.
        ErrorCode: 2030
        Message: Oops, something went wrong, please try again.
    THIS_EMAIL_ID_IS_NOT_ALLOWED_TO_REGISTER_SSO:
      value:
        Description: The provided Email is not allowed to register, please reach out to LoginRadius support for more information.
        ErrorCode: 1056
        Message: Email is not allowed to register
    TRIAL_PLAN_USER_LIMIT_REACHED_SSO:
      value:
        Description: The trial plan user creation limit has been reached. Upgrade your plan to add more users.
        ErrorCode: 6004
        Message: User creation limit reached for the trial plan
    UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_SSO:
      value:
        Description: Please verify your email address first to log in with this social provider.
        ErrorCode: 1026
        Message: Cannot login with this social provider as email address is not yet verified
    UNVERIFIED_EXISTING_ACCOUNT_WITH_SAME_EMAIL_ID_IN_EMAIL_VERIFCATION_DISABLED_SSO:
      value:
        Description: please login with your existing account. If you’ve forgotten which provider you have previously registered under, please use the Forgot User ID or Social Provider link.
        ErrorCode: 1033
        Message: Cannot login with this social provider as the same email address is already being used with another account
    CLIENT_ID_REQUIRED:
      value:
        error: invalid_request
        error_description: The client_id is a required parameter.
    CONTENT_TYPE_NOT_SUPPORTED:
      value:
        error: This content type header is not supported
        error_description: Please use a valid content type header as application/json.
    OAUTH_APP_RESTRICTED:
      value:
        error: invalid_request
        error_description: Your LoginRadius site does not have permission to access this endpoint, please contact LoginRadius support for more information.
    OAUTH_DANGEROUS_REQUEST:
      value:
        error: Dangerous request
        error_description: A potentially dangerous request value was detected.
    OAUTH_HOST_NOT_WHITELISTED:
      value:
        error: invalid_request
        error_description: Your request is coming from an invalid host and this host is not configured on LoginRadius. <br />Please follow <a href='https://docs.loginradius.com/api/v2/troubleshooting/invalid-request-uri-error/'target='_blank'>these instructions</a> to get the social login working on your website.
    OAUTH_POST_BODY_INVALID:
      value:
        error: invalid_request
        error_description: Please use a valid post body and make sure that it is in a valid JSON format
    OAUTH_TRIAL_PLAN_EXPIRED:
      value:
        error: invalid_request
        error_description: The trial plan has expired. To continue using the service, please contact support.
    SCOPE_INVALID:
      value:
        error: invalid_request
        error_description: The scope parameter contained an invalid value, check your scope again.
    CLIENT_ID_INVALID:
      value:
        error: invalid_client
        error_description: The client_id is not valid, check your client_id again.
    OAUTH_CONF_NOT_EXIST:
      value:
        error: unauthorized_client
        error_description: The OAuth configuration not found.
    TOKEN_CONF_INVALID:
      value:
        error: unauthorized_client
        error_description: The Token configuration is not valid.
    TOKEN_CONF_NOT_EXIST:
      value:
        error: unauthorized_client
        error_description: The Token configuration not found.
    CLIENT_SECRET_BASIC_REQUIRED:
      value:
        error: invalid_request
        error_description: The client_secret is required to be part of an authorization header.
    CLIENT_SECRET_POST_REQUIRED:
      value:
        error: invalid_request
        error_description: The client_secret is required to be in your request body.
    CLIENT_SECRET_REQUIRED:
      value:
        error: invalid_request
        error_description: The client_secret is a required parameter.
    TOKEN_REQUIRED_SSO:
      value:
        error: invalid_request
        error_description: The token is a required parameter.
    CLIENT_SECRET_INVALID:
      value:
        error: unauthorized_client
        error_description: The client_secret is not valid, check your client_secret again.
    REFRESH_TOKEN_INVALID_SSO:
      value:
        error: invalid_grant
        error_description: The refresh_token is not valid.
    ACCESS_TOKEN_INVALID_SSO:
      value:
        error: invalid_grant
        error_description: The access_token is not valid.
    ACCESS_TOKEN_INVALID_OR_EXPIRED_SSO:
      value:
        error: invalid_request
        error_description: The access_token is invalid or expired.
    CODE_EXPIRED:
      value:
        error: invalid_grant
        error_description: The code has been expired.
    CODE_INVALID:
      value:
        error: invalid_grant
        error_description: The code is not valid.
    CODE_INVALID_OR_EXPIRED:
      value:
        error: invalid_request
        error_description: The code is invalid or expired.
    CODE_IS_ALREADY_USED:
      value:
        error: invalid_grant
        error_description: The code is already used.
    CODE_REQUIRED:
      value:
        error: invalid_request
        error_description: The code is a required parameter.
    CODE_VERIFIER_INVALID:
      value:
        error: invalid_grant
        error_description: The Code Verifier is invalid.
    CODE_VERIFIER_REQUIRED:
      value:
        error: invalid_request
        error_description: The Code Verifier is required.
    DEVICE_AUTHORIZATION_PENDING:
      value:
        error: authorization_pending
        error_description: The authorization is pending
    DEVICE_CODE_INVALID:
      value:
        error: invalid_request
        error_description: The device_code is invalid or expired.
    DEVICE_CODE_REQUIRED:
      value:
        error: invalid_request
        error_description: The device_code is a required parameter.
    DEVICE_SLOW_DOWN:
      value:
        error: slow_down
        error_description: Slow down the request polling
    GRANT_TYPE_INVALID:
      value:
        error: unsupported_grant_type
        error_description: The grant_type is not valid, check grant_type parameter again.
    GRANT_TYPE_REQUIRED:
      value:
        error: invalid_request
        error_description: The grant_type is a required parameter.
    OAUTH_ACCESS_DENIED:
      value:
        error: invalid_request
        error_description: Access denied. The specified grant_type has not been allowed.
    OAUTH_ACCESS_TOKEN_EXPIRED:
      value:
        error: invalid_grant
        error_description: The access_token has been expired.
    OAUTH_ACCOUNT_NOT_ALLOWED_TO_LOGIN:
      value:
        error: invalid_grant
        error_description: The provided account is not allowed to login, please reach out to LoginRadius support for more information.
    OAUTH_ACTIVE_SESSIONS_EXCEEDED:
      value:
        error: invalid_grant
        error_description: You have exceeded the maximum number of allowed active login sessions. Please log out of any other active session before attempting to log in again. If you need further assistance, contact support.
    OAUTH_APP_NOT_EXISTS:
      value:
        error: invalid_grant
        error_description: The provided site does not exist, please use a valid LoginRadius site in order to process this request.
    OAUTH_BREACHED_PASSWORD_LOGIN:
      value:
        error: invalid_grant
        error_description: Your password is found in a data breach unrelated to this app/service. Please reset your password using the email we sent you.
    OAUTH_CAPTCHA_NOT_VALID:
      value:
        error: invalid_grant
        error_description: CAPTCHA is invalid, please enter the correct CAPTCHA value.
    OAUTH_CHANGE_BREACHED_PASSWORD:
      value:
        error: invalid_grant
        error_description: Your password is exposed in an external data breach. As a caution, we’ve already sent you an email with steps to reset your password. Please try to login after resetting your password.
    OAUTH_CONSENT_FORM_NOT_SUBMITTED:
      value:
        error: invalid_grant
        error_description: Consent form not submitted, please accept the consent form.
    OAUTH_CONSENT_FORM_VALIDATION_FAILED:
      value:
        error: invalid_grant
        error_description: Consent form validation failed.
    OAUTH_EMAIL_NOT_VERIFIED:
      value:
        error: invalid_grant
        error_description: This email has not yet been verified, please click the link in your email to confirm your email address.
    OAUTH_EMAIL_SEND_LIMIT_REACHED:
      value:
        error: invalid_grant
        error_description: The account limit for email requests for this resource has been reached for this time due to too many request.
    OAUTH_EMAILID_ID_FORMAT_NOT_VALID:
      value:
        error: invalid_grant
        error_description: The provided email ID is invalid or not well-formatted, a valid email ID is required in order to process this request.
    OAUTH_EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED:
      value:
        error: invalid_grant
        error_description: The email or phone number is not verified, please verify email or phone number for login.
    OAUTH_INVALID_PHONE_NUMBER:
      value:
        error: invalid_grant
        error_description: The provided phone number is not valid or not well-formatted, please review the phone number in order to process this request.
    OAUTH_LOGIN_DISABLED:
      value:
        error: invalid_grant
        error_description: Login services have been disabled for your account, please contact the admin or site owner.
    OAUTH_LOGIN_IS_LOCKED_FOR_RECAPTCHA:
      value:
        error: invalid_grant
        error_description: Your account has been locked, please login with a valid reCAPTCHA in order to continue.
    OAUTH_LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION:
      value:
        error: invalid_grant
        error_description: Your account has been locked, please login with an answer to the security question in order to continue.
    OAUTH_LOGIN_WITH_PASSWORD_NOT_ENABLED:
      value:
        error: invalid_grant
        error_description: Password-based login is disabled for your site. Please enable the Login with Password feature.
    OAUTH_OPERATION_FAILED:
      value:
        error: invalid_grant
        error_description: An unknown error has occurred, please try again in a few minutes or contact your system admin.
    OAUTH_OTP_SEND_FAILED:
      value:
        error: invalid_grant
        error_description: The Verification OTP Code sending failed, please try again.
    OAUTH_PHONE_NO_LOGIN_NOT_ENABLED:
      value:
        error: invalid_grant
        error_description: Phone number login is not enabled on your site.
    OAUTH_PHONE_NOT_VERIFIED:
      value:
        error: invalid_grant
        error_description: The provided phone number is not verified, please use a verified phone number for login.
    OAUTH_PIN_IS_REQUIRED:
      value:
        error: invalid_grant
        error_description: The PIN is required and needs to be set, please set PIN in the profile for login.
    OAUTH_PRIVACY_POLICY_MISMATCHED:
      value:
        error: invalid_grant
        error_description: You have not accepted the current Privacy Policy.
    OAUTH_RBA_ACCOUNT_IS_BLOCKED:
      value:
        error: invalid_grant
        error_description: Your account has been blocked by the system admin, please contact the admin for more information.
    OAUTH_RBA_EMAIL_VERIFICATION:
      value:
        error: invalid_grant
        error_description: We have identified a suspicious activity with your account, a verification code has been sent to your email to secure your account.
    OAUTH_RBA_SECURITY_ANSWER_VERIFICATION:
      value:
        error: invalid_grant
        error_description: We have identified a suspicious activity with your account, please answer the security question's to secure your account.
    OAUTH_RBA_SMS_VERIFICATION:
      value:
        error: invalid_grant
        error_description: We have identified a suspicious activity with your account, a verification code has been sent to your phone to secure your account.
    OAUTH_SMS_CONFIGURATION_NOT_EXISTS:
      value:
        error: invalid_grant
        error_description: The SMS configuration does not exist, please configure SMS settings.
    OAUTH_SMS_SEND_LIMIT_REACHED:
      value:
        error: invalid_grant
        error_description: The account limit for SMS requests for this resource has been reached for this time due to too many request.
    OAUTH_USER_ID_BLOCKED:
      value:
        error: invalid_grant
        error_description: Your account has been blocked by the system admin, please contact the admin for more information.
    OAUTH_USER_ID_LOCKED:
      value:
        error: invalid_grant
        error_description: Your account has been locked, please try again after sometime.
    OAUTH_USER_NAME_AUTHENTICATION_ENABLED:
      value:
        error: invalid_grant
        error_description: You can't login from email/phone, please use username for login.
    OAUTH_USER_NOT_EXISTS:
      value:
        error: invalid_grant
        error_description: The user's account does not exist, please use a valid user or create the user before processing this request.
    OAUTH_USERNAME_OR_PASSWORD_WRONG:
      value:
        error: invalid_grant
        error_description: Please use a valid user ID and password combination.
    OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT:
      value:
        error: invalid_grant
        error_description: You have {count} tries left before your account gets suspended.
    OAUTH_USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT:
      value:
        error: invalid_grant
        error_description: You have {count} tries left before your account gets blocked.
    PASSWORD_REQUIRED_SSO:
      value:
        error: invalid_request
        error_description: The password is a required parameter.
    REDIRECT_URI_INVALID:
      value:
        error: invalid_request
        error_description: The redirect_uri is not valid, check redirect_uri parameter again.
    REDIRECT_URI_REQUIRED:
      value:
        error: invalid_request
        error_description: The redirect_uri is a required parameter.
    REFRESH_TOKEN_REQUIRED_SSO:
      value:
        error: invalid_request
        error_description: The refresh_token is a required parameter.
    RESPONSE_TYPE_INVALID:
      value:
        error: invalid_request
        error_description: The response_type must contain a valid value.
    USERNAME_REQUIRED_SSO:
      value:
        error: invalid_request
        error_description: The username is a required parameter.
    RESOURCE_PERMISSION_NOT_FOUND:
      value:
        error: invalid_request
        error_description: The resource does not contain any permissions.
    USER_PERMISSION_NOT_FOUND:
      value:
        error: invalid_request
        error_description: The user does not have permission to access the resource.
    DEVICE_ACCESS_TOKEN_EXPIRED:
      value:
        error: expired_token
        error_description: The access token is expired
    OAUTH_REDIRECT_URI_MISMATCH:
      value:
        error: redirect_uri_mismatch
        error_description: Parameter redirect_uri does not match as provided in the authorization
    OPENID_CONF_NOT_EXIST:
      value:
        error: unauthorized_client
        error_description: The Openid configuration not found.
    TOKEN_TYPE_HINT_INVALID:
      value:
        error: invalid_request
        error_description: The token_type_hint is not valid, check token_type_hint parameter again.
    TOKEN_TYPE_HINT_REQUIRED:
      value:
        error: invalid_request
        error_description: The token_type_hint is a required parameter.
    M2M_CONF_NOT_EXIST:
      value:
        error: unauthorized_client
        error_description: The Machine to Machine configuration not found.
    TOKEN_EXPIRED:
      value:
        error: invalid_grant
        error_description: The token has been expired.
    TOKEN_INVALID:
      value:
        error: invalid_grant
        error_description: The token is not valid.
    AUDIENCE_REQUIRED:
      value:
        error: invalid_request
        error_description: The audience is a required parameter.
    ACCESS_TOKEN_REQUIRED_SSO:
      value:
        error: invalid_request
        error_description: The access_token is a required parameter.
    OPENID_CONF_INVALID:
      value:
        error: unauthorized_client
        error_description: The Openid configuration is not valid.
    SAML_APP_NAME_REQUIRED:
      value:
        Description: The appName is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    SP_SAML_CONFIG_NOT_FOUND:
      value:
        Description: SAML configuration not found.
        ErrorCode: 3001
        Message: SAML configuration not found.
    SP_SAML_CONFIG_NOT_VALID:
      value:
        Description: Failed to retrieve issuer URL, check for errors in config issuer URL or login URL.
        ErrorCode: 3002
        Message: SAML configuration not valid.
    SAML_METADATA_RESPONSE_INVALID:
      value:
        Description: Failed to convert metadata to xml response.
        ErrorCode: 2030
        Message: Oops, something went wrong, please try again.
    API_KEY_NOT_WELL_FORMATTED_SSO:
      value:
        Description: The provided LoginRadius API key is invalid, please use a valid API key of your LoginRadius account.
        ErrorCode: 920
        Message: API key is invalid
    API_KEY_REQUIRED_SSO:
      value:
        Description: The request is missing the API key, please use the valid API key parameter in order to process this request.
        ErrorCode: 922
        Message: API key is missing
    EXPIRE_IN_INVALID_FORMAT_SSO:
      value:
        Description: Please provide expiry time in number format only.
        ErrorCode: 1307
        Message: The expires_in has invalid format
    MOBILE_EXPIRY_PARAM_INVALID:
      value:
        Description: The expiry is not valid.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    MOBILE_ACCESS_TOKEN_INVALID_OR_EXPIRED:
      value:
        Description: The access_token is invalid or expired.
        ErrorCode: 2010
        Message: invalid_grant
    MOBILE_CODE_NOT_VALID_OR_EXPIRED:
      value:
        Description: The code is not valid or expired.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    MOBILE_CODE_REQUIRED:
      value:
        Description: The code is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    CODE_AND_TOKEN_REQUIRED:
      value:
        Description: The access_token is a required parameter, The code is a required parameter.
        ErrorCode: 908
        Message: A parameter is not formatted correctly
    b2cBatchUplaod:
      summary: Batch Upload B2C
      value:
        Profiles:
          - FirstName: Ajay
            LastName: Sharma
            Email:
              - Type: Primary
                Value: ajaysharma@yopmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$VAh9OF7J0c2p2kpx4ozwDg==$6cwqAkcvs6+zadhoH9kiuWhjNuC84PhrUbMew0fBO6k=:BA4zsWmfF
          - FirstName: Priya
            LastName: Patel
            Email:
              - Type: Primary
                Value: priya.patel@tempmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$XBk2PG8K1d3q3lry5paxEh==$7dxrBlcws7+zbeipiI0ljvXikOvD95QisVcNfx1gCP7l=:CB5atXngG
          - FirstName: Rajesh
            LastName: Kumar
            Email:
              - Type: Primary
                Value: rajesh.kumar@mailbox.org
            PasswordHash: Rfc2898DeriveBytes$1000$YCl3QH9L2e4r4msz6qbyFi==$8eysCmd xt8+acrjqjJ1mkwYjlPwE06RjtWdOgy2hDQ8m=:DC6buYohH
          - FirstName: Sneha
            LastName: Gupta
            Email:
              - Type: Primary
                Value: sneha.gupta@guerrillamail.com
            PasswordHash: Rfc2898DeriveBytes$1000$ZDm4RI0M3f5s5nta7rcxGj==$9fztDney5u9+bdsksKk2nlxZkmQxF17SjuXePhz3hEQ9n=:ED7cvZpiI
    b2cBatchUplaodWithPasswordConfig:
      summary: Batch Upload B2C with password Config
      value:
        PasswordEncryption:
          Type: PBKDF2
          IsPerPasswordSalt: true
          NumberOfIteration: 1000
          SaltAttachType: Prepend
          PasswordHasherVersion: V1
        Profiles:
          - FirstName: Ajay
            LastName: Sharma
            Email:
              - Type: Primary
                Value: ajaysharma@yopmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$VAh9OF7J0c2p2kpx4ozwDg==$6cwqAkcvs6+zadhoH9kiuWhjNuC84PhrUbMew0fBO6k=:BA4zsWmfF
          - FirstName: Priya
            LastName: Patel
            Email:
              - Type: Primary
                Value: priya.patel@tempmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$XBk2PG8K1d3q3lry5paxEh==$7dxrBlcws7+zbeipiI0ljvXikOvD95QisVcNfx1gCP7l=:CB5atXngG
          - FirstName: Rajesh
            LastName: Kumar
            Email:
              - Type: Primary
                Value: rajesh.kumar@mailbox.org
            PasswordHash: Rfc2898DeriveBytes$1000$YCl3QH9L2e4r4msz6qbyFi==$8eysCmd xt8+acrjqjJ1mkwYjlPwE06RjtWdOgy2hDQ8m=:DC6buYohH
          - FirstName: Sneha
            LastName: Gupta
            Email:
              - Type: Primary
                Value: sneha.gupta@guerrillamail.com
            PasswordHash: Rfc2898DeriveBytes$1000$ZDm4RI0M3f5s5nta7rcxGj==$9fztDney5u9+bdsksKk2nlxZkmQxF17SjuXePhz3hEQ9n=:ED7cvZpiI
    b2cDeltaBatchUplaod:
      summary: Batch Upload B2C with delta flag enabled
      value:
        DeltaMigrationModel:
          DeltaMigration: true
          OverWriteDuplicate: true
        Profiles:
          - FirstName: Ajay
            LastName: Sharma
            Email:
              - Type: Primary
                Value: ajaysharma@yopmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$VAh9OF7J0c2p2kpx4ozwDg==$6cwqAkcvs6+zadhoH9kiuWhjNuC84PhrUbMew0fBO6k=:BA4zsWmfF
          - FirstName: Priya
            LastName: Patel
            Email:
              - Type: Primary
                Value: priya.patel@tempmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$XBk2PG8K1d3q3lry5paxEh==$7dxrBlcws7+zbeipiI0ljvXikOvD95QisVcNfx1gCP7l=:CB5atXngG
          - FirstName: Rajesh
            LastName: Kumar
            Email:
              - Type: Primary
                Value: rajesh.kumar@mailbox.org
            PasswordHash: Rfc2898DeriveBytes$1000$YCl3QH9L2e4r4msz6qbyFi==$8eysCmd xt8+acrjqjJ1mkwYjlPwE06RjtWdOgy2hDQ8m=:DC6buYohH
          - FirstName: Sneha
            LastName: Gupta
            Email:
              - Type: Primary
                Value: sneha.gupta@guerrillamail.com
            PasswordHash: Rfc2898DeriveBytes$1000$ZDm4RI0M3f5s5nta7rcxGj==$9fztDney5u9+bdsksKk2nlxZkmQxF17SjuXePhz3hEQ9n=:ED7cvZpiI
    b2bBatchUplaod:
      summary: Batch Upload B2B
      value:
        Profiles:
          - FirstName: Ajay
            LastName: Sharma
            Email:
              - Type: Primary
                Value: ajaysharma@yopmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$VAh9OF7J0c2p2kpx4ozwDg==$6cwqAkcvs6+zadhoH9kiuWhjNuC84PhrUbMew0fBO6k=:BA4zsWmfF
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Priya
            LastName: Patel
            Email:
              - Type: Primary
                Value: priya.patel@tempmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$XBk2PG8K1d3q3lry5paxEh==$7dxrBlcws7+zbeipiI0ljvXikOvD95QisVcNfx1gCP7l=:CB5atXngG
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Rajesh
            LastName: Kumar
            Email:
              - Type: Primary
                Value: rajesh.kumar@mailbox.org
            PasswordHash: Rfc2898DeriveBytes$1000$YCl3QH9L2e4r4msz6qbyFi==$8eysCmd xt8+acrjqjJ1mkwYjlPwE06RjtWdOgy2hDQ8m=:DC6buYohH
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Sneha
            LastName: Gupta
            Email:
              - Type: Primary
                Value: sneha.gupta@guerrillamail.com
            PasswordHash: Rfc2898DeriveBytes$1000$ZDm4RI0M3f5s5nta7rcxGj==$9fztDney5u9+bdsksKk2nlxZkmQxF17SjuXePhz3hEQ9n=:ED7cvZpiI
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
    b2bBatchUplaodWithPasswordConfig:
      summary: Batch Upload B2B with password Config
      value:
        PasswordEncryption:
          Type: PBKDF2
          IsPerPasswordSalt: true
          NumberOfIteration: 1000
          SaltAttachType: None
          PasswordHasherVersion: V5
          SubKeyLength: 64
          SaltKeyLength: 32
        Profiles:
          - FirstName: Ajay
            LastName: Sharma
            Email:
              - Type: Primary
                Value: ajaysharma@yopmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$VAh9OF7J0c2p2kpx4ozwDg==$6cwqAkcvs6+zadhoH9kiuWhjNuC84PhrUbMew0fBO6k=:BA4zsWmfF
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Priya
            LastName: Patel
            Email:
              - Type: Primary
                Value: priya.patel@tempmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$XBk2PG8K1d3q3lry5paxEh==$7dxrBlcws7+zbeipiI0ljvXikOvD95QisVcNfx1gCP7l=:CB5atXngG
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Rajesh
            LastName: Kumar
            Email:
              - Type: Primary
                Value: rajesh.kumar@mailbox.org
            PasswordHash: Rfc2898DeriveBytes$1000$YCl3QH9L2e4r4msz6qbyFi==$8eysCmd xt8+acrjqjJ1mkwYjlPwE06RjtWdOgy2hDQ8m=:DC6buYohH
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Sneha
            LastName: Gupta
            Email:
              - Type: Primary
                Value: sneha.gupta@guerrillamail.com
            PasswordHash: Rfc2898DeriveBytes$1000$ZDm4RI0M3f5s5nta7rcxGj==$9fztDney5u9+bdsksKk2nlxZkmQxF17SjuXePhz3hEQ9n=:ED7cvZpiI
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
    b2bDeltaBatchUplaod:
      summary: Batch Upload B2B with delta flag enabled
      value:
        DeltaMigrationModel:
          DeltaMigration: true
          OverWriteDuplicate: true
        Profiles:
          - FirstName: Ajay
            LastName: Sharma
            Email:
              - Type: Primary
                Value: ajaysharma@yopmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$VAh9OF7J0c2p2kpx4ozwDg==$6cwqAkcvs6+zadhoH9kiuWhjNuC84PhrUbMew0fBO6k=:BA4zsWmfF
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Priya
            LastName: Patel
            Email:
              - Type: Primary
                Value: priya.patel@tempmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$XBk2PG8K1d3q3lry5paxEh==$7dxrBlcws7+zbeipiI0ljvXikOvD95QisVcNfx1gCP7l=:CB5atXngG
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Rajesh
            LastName: Kumar
            Email:
              - Type: Primary
                Value: rajesh.kumar@mailbox.org
            PasswordHash: Rfc2898DeriveBytes$1000$YCl3QH9L2e4r4msz6qbyFi==$8eysCmd xt8+acrjqjJ1mkwYjlPwE06RjtWdOgy2hDQ8m=:DC6buYohH
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
          - FirstName: Sneha
            LastName: Gupta
            Email:
              - Type: Primary
                Value: sneha.gupta@guerrillamail.com
            PasswordHash: Rfc2898DeriveBytes$1000$ZDm4RI0M3f5s5nta7rcxGj==$9fztDney5u9+bdsksKk2nlxZkmQxF17SjuXePhz3hEQ9n=:ED7cvZpiI
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
    b2bBatchUplaodOnlyOrgs:
      summary: Batch Upload B2B with orgIds only
      value:
        Profiles:
          - FirstName: Ajay
            LastName: Sharma
            Email:
              - Type: Primary
                Value: ajaysharma@yopmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$VAh9OF7J0c2p2kpx4ozwDg==$6cwqAkcvs6+zadhoH9kiuWhjNuC84PhrUbMew0fBO6k=:BA4zsWmfF
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
          - FirstName: Priya
            LastName: Patel
            Email:
              - Type: Primary
                Value: priya.patel@tempmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$XBk2PG8K1d3q3lry5paxEh==$7dxrBlcws7+zbeipiI0ljvXikOvD95QisVcNfx1gCP7l=:CB5atXngG
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
          - FirstName: Rajesh
            LastName: Kumar
            Email:
              - Type: Primary
                Value: rajesh.kumar@mailbox.org
            PasswordHash: Rfc2898DeriveBytes$1000$YCl3QH9L2e4r4msz6qbyFi==$8eysCmd xt8+acrjqjJ1mkwYjlPwE06RjtWdOgy2hDQ8m=:DC6buYohH
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
          - FirstName: Sneha
            LastName: Gupta
            Email:
              - Type: Primary
                Value: sneha.gupta@guerrillamail.com
            PasswordHash: Rfc2898DeriveBytes$1000$ZDm4RI0M3f5s5nta7rcxGj==$9fztDney5u9+bdsksKk2nlxZkmQxF17SjuXePhz3hEQ9n=:ED7cvZpiI
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
    b2bBatchUplaodOnlyRoles:
      summary: Batch Upload B2B with roleIds only
      value:
        Profiles:
          - FirstName: Ajay
            LastName: Sharma
            Email:
              - Type: Primary
                Value: ajaysharma@yopmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$VAh9OF7J0c2p2kpx4ozwDg==$6cwqAkcvs6+zadhoH9kiuWhjNuC84PhrUbMew0fBO6k=:BA4zsWmfF
            RoleIds:
              - role_aDikRwnDb67DwpBp
          - FirstName: Priya
            LastName: Patel
            Email:
              - Type: Primary
                Value: priya.patel@tempmail.com
            PasswordHash: Rfc2898DeriveBytes$1000$XBk2PG8K1d3q3lry5paxEh==$7dxrBlcws7+zbeipiI0ljvXikOvD95QisVcNfx1gCP7l=:CB5atXngG
            RoleIds:
              - role_aDikRwnDb67DwpBp
              - role_bCikRwnDb67FgpBp
          - FirstName: Rajesh
            LastName: Kumar
            Email:
              - Type: Primary
                Value: rajesh.kumar@mailbox.org
            PasswordHash: Rfc2898DeriveBytes$1000$YCl3QH9L2e4r4msz6qbyFi==$8eysCmd xt8+acrjqjJ1mkwYjlPwE06RjtWdOgy2hDQ8m=:DC6buYohH
          - FirstName: Sneha
            LastName: Gupta
            Email:
              - Type: Primary
                Value: sneha.gupta@guerrillamail.com
            PasswordHash: Rfc2898DeriveBytes$1000$ZDm4RI0M3f5s5nta7rcxGj==$9fztDney5u9+bdsksKk2nlxZkmQxF17SjuXePhz3hEQ9n=:ED7cvZpiI
            RoleIds:
              - role_aDikRwnDb67DwpBp
              - role_bCikRwnDb67FgpBp
            OrgRoles:
              - OrgId: org_aCXnRa2wQdvMpz1y
                RoleIds:
                  - role_aDikRwnDb67DwpBp
    batchUploadSuccess:
      summary: Migration with no failed records
      value:
        Profile:
          RecordInserted: 150
          RecordUpdated: 20
          Failed: []
    batchUploadPartialSuccess:
      summary: Migration with failed records
      value:
        Profile:
          RecordInserted: 120
          RecordUpdated: 30
          Failed:
            - RecordNumber: 2
              Message: Email is a primary identity and cannot be duplicated
            - RecordNumber: 5
              Message: Email is a primary identity and cannot be duplicated
    SUBKEYLENGTH_RANGE:
      value:
        ErrorCode: 8035
        Message: SubkeyLength field value needs to be between 32 and 128.
        Description: SubkeyLength field value needs to be between 32 and 128.
    SALTKEYLENGTH_RANGE:
      value:
        ErrorCode: 8034
        Message: SaltkeyLength field value needs to be between 16 and 128.
        Description: SaltkeyLength field value needs to be between 16 and 128.
    INVALID_PASSWORD_HASH_CONFIG:
      value:
        ErrorCode: 7992
        Message: Invalid password hash configuration
        Description: SubKeyLength or SaltKeyLength is invalid. Please use the values greater than or equal to 16.
    ValidateIdentity:
      value:
        Message: One or more records have parameters that are not formatted correctly.
        Description: Some records in the request contain invalid or incorrectly formatted parameters. Please review the 'Errors' array for details on each affected record.
        ErrorCode: 8198
        Errors:
          - FieldName: Record 1
            ErrorMessage: The uid is not valid, The uid can contains alphabets, digits, underscore and dash only and length must be between 1 to 50.
          - FieldName: Record 2
            ErrorMessage: The account ID has to be unique for your Site, please use a different account ID in order to process this request.
          - FieldName: Record 3
            ErrorMessage: The value of gender is invalid, please use a valid value of gender to process request.
          - FieldName: Record 4
            ErrorMessage: The provided birth date either is in the future or has an invalid format, please use the valid date and date format (mm/dd/yyyy).
          - FieldName: Record 5
            ErrorMessage: Please use different address types in the case of multiple addresses.
          - FieldName: Record 6
            ErrorMessage: The request couldn't be processed, the address type must be specified in the address.
          - FieldName: Record 7
            ErrorMessage: The type is a required parameter, The value is a required parameter.
          - FieldName: Record 8
            ErrorMessage: The value is a required parameter.
          - FieldName: Record 9
            ErrorMessage: The request couldn't be processed, the email type must be specified in the address.
          - FieldName: Record 10
            ErrorMessage: The provided email ID is invalid or not well-formatted, a valid email ID is required in order to process this request.
          - FieldName: Record 11
            ErrorMessage: Please use different email addresses in the case of multiple email addresses.
          - FieldName: Record 12
            ErrorMessage: The primary email address can be only one.
          - FieldName: Record 13
            ErrorMessage: The provided Email id domain is not allowed to register, please reach out to LoginRadius support for more information.
          - FieldName: Record 14
            ErrorMessage: This custom field is invalid, please use a correct or valid custom field.
          - FieldName: Record 15
            ErrorMessage: A username is required, please use a valid username in order to process this request.
          - FieldName: Record 16
            ErrorMessage: The security question or answer is not enabled, please enable security question or answer.
          - FieldName: Record 17
            ErrorMessage: This security question is invalid, please use a correct or valid security question.
          - FieldName: Record 18
            ErrorMessage: Your security question or answer is incorrect, please enter the correct security question or answer.
          - FieldName: Record 19
            ErrorMessage: This security question is invalid, please use a correct or valid security question.
          - FieldName: Record 20
            ErrorMessage: A parameter is not formatted correctly in the request, please check all the parameters in the API call.
    B2B_ORG_AND_ROLE_VALIDATION:
      value:
        Message: One or more records have parameters that are not formatted correctly.
        Description: Some records in the request contain invalid or incorrectly formatted parameters. Please review the 'Errors' array for details on each affected record.
        ErrorCode: 8198
        Errors:
          - FieldName: Record 1
            ErrorMessage: The specified tenant Role ID is invalid or cannot be assigned to the user. Please review the Role mapping.
          - FieldName: Record 2
            ErrorMessage: The organization ID is invalid or refers to an organization the user cannot be assigned to.
          - FieldName: Record 3
            ErrorMessage: The Role ID is not valid for the selected organization. Please verify the organization-role mapping.
          - FieldName: Record 4
            ErrorMessage: The organization Role ID is invalid or not assignable. Please ensure it exists and is accessible.
          - FieldName: Record 5
            ErrorMessage: The default Role ID provided is not valid or cannot be assigned. Please select a valid default Role.
    IDENTITY_VALIDATION_ERRORS:
      value:
        Message: One or more records have parameters that are not formatted correctly.
        Description: Some records in the request contain invalid or incorrectly formatted parameters. Please review the 'Errors' array for details on each affected record.
        ErrorCode: 8198
        Errors:
          - FieldName: Record 1
            ErrorMessage: The Privacy Policy version is not valid.
          - FieldName: Record 2
            ErrorMessage: The request couldn't be processed, the address type must be specified in the address.
          - FieldName: Record 3
            ErrorMessage: The request couldn't be processed, the phone type must be specified in the phone numbers.
          - FieldName: Record 4
            ErrorMessage: Please use different phone types in the case of multiple phone numbers.
          - FieldName: Record 5
            ErrorMessage: You are not eligible for registration, your age must be above specified by admin of this site.
          - FieldName: Record 6
            ErrorMessage: The email address has to be unique for your LoginRadius site, please use a different email address.
          - FieldName: Record 7
            ErrorMessage: The username you have selected is already in use, please choose a different username.
          - FieldName: Record 8
            ErrorMessage: The phone number has to be unique for your LoginRadius site, please use a different phone number.
    BATCH_MIGRATION_TOO_MANY_RECORDS:
      summary: BATCH_MIGRATION_TOO_MANY_RECORDS
      value:
        ErrorCode: 8199
        Message: Too many records in batch migration.
        Description: The request contains more than the allowed 500 records for a batch migration. Please split the data into smaller batches and try again.
    MIGRATION_FAILED:
      value:
        Message: User migration failed.
        Description: The user migration process encountered an unexpected error and could not be completed. Please contact support for assistance.
        ErrorCode: 8197
    CONSENT_MANAGEMENT_NOT_ENABLED:
      summary: CONSENT_MANAGEMENT_NOT_ENABLED
      value:
        Message: Consent Management is not enabled for this site.
        Description: Consent Management feature is not enabled for this site.
        ErrorCode: 8200
    CONSENT_OPTION_ID_ALREADY_EXISTS:
      summary: CONSENT_OPTION_ID_ALREADY_EXISTS
      value:
        Message: Consent Option ID already exists
        Description: Consent Option ID already exists. Please use another ID to add new config.
        ErrorCode: 8201
    CONSENT_OPTION_NOT_FOUND:
      summary: CONSENT_OPTION_NOT_FOUND
      value:
        Message: Consent Option not found
        Description: The Consent Option not found for this tenant.
        ErrorCode: 8203
    CONSENT_OPTION_IN_USE:
      summary: CONSENT_OPTION_IN_USE
      value:
        Message: Consent Option in use
        Description: This consent option is currently in use and cannot be deleted because it is part of an active consent form.
        ErrorCode: 8205
    CONSENT_OPTION_INVALID:
      summary: CONSENT_OPTION_INVALID
      value:
        Message: Consent Option is invalid
        Description: Consent Option is invalid. Please provide a valid consent option.
        ErrorCode: 8206
    CONSENT_FORM_ALREADY_EXISTS_FOR_EVENT_START_DATE:
      summary: CONSENT_FORM_ALREADY_EXISTS_FOR_EVENT_START_DATE
      value:
        Message: Consent form already exists for the event with the same start date
        Description: Consent form already exists for the event with the same start date. Please provide a different start date.
        ErrorCode: 8207
    PARAMETER_NOT_WELL_FORMATTED_INVALID_VERSION:
      summary: PARAMETER_NOT_WELL_FORMATTED_INVALID_VERSION
      value:
        Message: A parameter is not formatted correctly.
        Description: The provided consent form version is invalid. Please enter a valid consent form version in integer format.
        ErrorCode: 7900
    CONSENT_FORM_NOT_FOUND:
      summary: CONSENT_FORM_NOT_FOUND
      value:
        Message: Consent form not found
        Description: Consent form not found.
        ErrorCode: 8208
    CONSENT_FORM_ALREADY_DELETED:
      summary: CONSENT_FORM_ALREADY_DELETED
      value:
        Message: Consent form already deleted
        Description: Consent form already deleted.
        ErrorCode: 8209
    CONSENT_FORMS_NOT_FOUND:
      summary: CONSENT_FORMS_NOT_FOUND
      value:
        Message: Active consent Forms not found
        Description: Active consent Forms not found for this tenant.
        ErrorCode: 8202
  requestBodies:
    UnlockAccountRequest:
      content:
        application/json:
          schema:
            allOf:
              - type: object
                properties:
                  SecurityAnswer:
                    type: object
                    description: Security answer's of the User if the User is locked by security questions
              - $ref: '#/components/schemas/CaptchaModel'
            required:
              - SecurityAnswer
      required: true
    JWTLoginRequest:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/LoginByEmail'
              - $ref: '#/components/schemas/LoginByPhone'
              - $ref: '#/components/schemas/LoginByUserName'
        application/x-www-form-urlencoded:
          schema:
            oneOf:
              - $ref: '#/components/schemas/LoginByEmail'
              - $ref: '#/components/schemas/LoginByPhone'
              - $ref: '#/components/schemas/LoginByUserName'
      required: true
    OAuthDeviceCodeRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthDeviceCode'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/OAuthDeviceCode'
      required: true
    OAuthRevokeRefreshTokenRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthRevokeRefreshToken'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/OAuthRevokeRefreshToken'
      required: true
    OAuthTokenRequest:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/OAuthAuthorizationCodeFlow'
              - $ref: '#/components/schemas/OAuthAuthorizationCodePKCEFlow'
              - $ref: '#/components/schemas/OAuthRefreshTokenFlow'
              - $ref: '#/components/schemas/OAuthPasswordCredentialFlow'
              - $ref: '#/components/schemas/OAuthDeviceCodeFlow'
              - $ref: '#/components/schemas/OAuthLoginRadiusTokenExchangeFlow'
        application/x-www-form-urlencoded:
          schema:
            oneOf:
              - $ref: '#/components/schemas/OAuthAuthorizationCodeFlow'
              - $ref: '#/components/schemas/OAuthAuthorizationCodePKCEFlow'
              - $ref: '#/components/schemas/OAuthRefreshTokenFlow'
              - $ref: '#/components/schemas/OAuthPasswordCredentialFlow'
              - $ref: '#/components/schemas/OAuthDeviceCodeFlow'
              - $ref: '#/components/schemas/OAuthLoginRadiusTokenExchangeFlow'
      required: true
    OIDCDeviceCodeRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OIDCDeviceCode'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/OIDCDeviceCode'
      required: true
    OIDCTokenRequest:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/OAuthAuthorizationCodeFlow'
              - $ref: '#/components/schemas/OAuthAuthorizationCodePKCEFlow'
              - $ref: '#/components/schemas/OAuthRefreshTokenFlow'
              - $ref: '#/components/schemas/OAuthPasswordCredentialFlow'
              - $ref: '#/components/schemas/OAuthDeviceCodeFlow'
              - $ref: '#/components/schemas/OAuthLoginRadiusTokenExchangeFlow'
        application/x-www-form-urlencoded:
          schema:
            oneOf:
              - $ref: '#/components/schemas/OAuthAuthorizationCodeFlow'
              - $ref: '#/components/schemas/OAuthAuthorizationCodePKCEFlow'
              - $ref: '#/components/schemas/OAuthRefreshTokenFlow'
              - $ref: '#/components/schemas/OAuthPasswordCredentialFlow'
              - $ref: '#/components/schemas/OAuthDeviceCodeFlow'
              - $ref: '#/components/schemas/OAuthLoginRadiusTokenExchangeFlow'
      required: true
    OAuthM2MTokenIntrospectRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthM2MTokenIntrospect'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/OAuthM2MTokenIntrospect'
      required: true
    OAuthM2MTokenRevokeRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthM2MTokenRevoke'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/OAuthM2MTokenRevoke'
      required: true
    OAuthM2MTokenGenerateRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthM2MTokenGenerate'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/OAuthM2MTokenGenerate'
      required: true
    OIDCUserinfoRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OIDCUserinfo'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/OIDCUserinfo'
      required: true
    QRCodeMapToTokenRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/QRCodeMapToToken'
      required: true
x-tagGroups:
  - name: Authentication API
    tags:
      - Registration
      - Login
      - User
      - Password
      - Security
      - Session
      - Custom Object
  - name: Account API
    tags:
      - Accounts
      - Account Session
      - Account Security
      - Account Custom Object
      - Multipurpose Tokens
      - Roles Management
  - name: Single Sign-On API
    tags:
      - OAuth
      - OIDC
      - OAuth M2M
      - JWT
      - SAML
      - Cross Device SSO
  - name: Analytics API
    tags:
      - Identity
      - Custom Objects
      - Insights
  - name: Management API
    tags:
      - User Migration
      - Social Providers
      - OAuth Custom Providers
      - JWT Custom Providers
      - SAML Custom Providers
      - OAuth Clients
      - JWT Clients
      - SAML Clients
      - Password Policy
      - Second Factor Configuration
      - Passkey Configuration
      - Push Notification Configuration
      - Captcha Configuration
      - Security Questions
      - Domain Access Restrictions
      - IP Access Restrictions
      - Email Templates
      - SMS Templates
      - Custom Fields
      - Roles
      - Permissions
      - Webhooks
      - Consent
      - Workflows
      - SOTT
  - name: Partner IAM API
    tags:
      - Organization
      - Organization User Roles
      - Organization Connections
      - Organization Connection Group Roles
      - Organization Domains
      - Organization Invitations
  - name: Hosted Plugins API
    tags:
      - BigCommerce SSO
      - Shopify SSO
      - PerfectMind SSO