---
title: "POST /dplex/users/invite"
method: POST
path: "/dplex/users/invite"
tags: ["registration-controller"]
---

# POST /dplex/users/invite

`POST /dplex/users/invite`

## Request body

- AdminUser
  - `id` integer
  - `createdBy` string
  - `createdOn` string, date-time
  - `modifiedBy` string
  - `modifiedOn` string, date-time
  - `group` Group
    - `id` integer
    - `createdBy` string
    - `createdOn` string, date-time
    - `modifiedBy` string
    - `modifiedOn` string, date-time
    - `groupId` integer
    - `groupExternalCode` string
    - `name` string
    - `securityKey` SecurityKey
      - `id` integer
      - `createdBy` string
      - `createdOn` string, date-time
      - `modifiedBy` string
      - `modifiedOn` string, date-time
      - `user` User
        - `id` integer
        - `createdBy` string
        - `createdOn` string, date-time
        - `modifiedBy` string
        - `modifiedOn` string, date-time
        - `group` Group — recursive
        - `groupCode` string
        - `groupId` string
        - `locationFilter` LocationFilters[]
          - `ipAddressRanges` string[]
        - `meta` string
        - `newPassword` string
        - `password` string
        - `passwordHash` string
        - `roleIds` string[]
        - `roleNames` string[]
        - `roles` Role[]
          - `id` integer
          - `createdBy` string
          - `createdOn` string, date-time
          - `modifiedBy` string
          - `modifiedOn` string, date-time
          - `roleId` integer
          - `name` string
          - `newName` string
          - `title` string
          - `description` string
          - `groupCode` string
          - `groupId` integer
          - `applicationName` string
          - `capabilities` Capability[]
            - `id` integer
            - `createdBy` string
            - `createdOn` string, date-time
            - `modifiedBy` string
            - `modifiedOn` string, date-time
            - `capabilityId` integer
            - `name` string
            - `title` string
            - `description` string
            - `type` string
            - `tagName` string
            - `applicationName` string
            - `applicationId` integer
            - `changedBy` string
            - `changedOn` string, date-time
          - `capabilityIds` integer[]
          - `capabilityNames` string[]
          - `changedBy` string
          - `persona` string
          - `platformId` integer
          - `platformName` string
          - `applicationDisplayName` string
          - `platformDisplayName` string
          - `roleAlias` string
          - `changedOn` string, date-time
        - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE' | 'LOCKED' | 'DELETED' | 'LOCKED_CODE' | 'LOCKED_VERIFY' | 'LOCKED_PWD' | 'LOCKED_2FA' | 'SUCCESS' | 'LOGIN_FAILED' | 'PENDING_AUTOREG'
        - `type` string
        - `userId` integer
        - `username` string
        - `usernameHash` string
        - `userRole` UserRole
          - `userRoleId` integer
          - `accessType` string
          - `roles` Role[]
            - `id` integer
            - `createdBy` string
            - `createdOn` string, date-time
            - `modifiedBy` string
            - `modifiedOn` string, date-time
            - `roleId` integer
            - `name` string
            - `newName` string
            - `title` string
            - `description` string
            - `groupCode` string
            - `groupId` integer
            - `applicationName` string
            - `capabilities` Capability[]
              - …
            - `capabilityIds` integer[]
            - `capabilityNames` string[]
            - `changedBy` string
            - `persona` string
            - `platformId` integer
            - `platformName` string
            - `applicationDisplayName` string
            - `platformDisplayName` string
            - `roleAlias` string
            - `changedOn` string, date-time
        - `changedBy` string
        - `deleteFlag` integer
        - `lastPasswordChanged` string, date-time
        - `changedOn` string, date-time
      - `groupCode` string
      - `expiryPeriod` integer
      - `key` string
      - `keyType` string
      - `accessId` string
      - `expirationTime` string
      - `status` string
      - `expirationDate` integer
      - `changedBy` string
      - `changedOn` string, date-time
    - `changedBy` string
    - `changedOn` string, date-time
  - `groupCode` string
  - `groupId` string
  - `locationFilter` LocationFilters[]
    - `ipAddressRanges` string[]
  - `meta` string
  - `newPassword` string
  - `password` string
  - `passwordHash` string
  - `roleIds` string[]
  - `roleNames` string[]
  - `roles` Role[]
    - `id` integer
    - `createdBy` string
    - `createdOn` string, date-time
    - `modifiedBy` string
    - `modifiedOn` string, date-time
    - `roleId` integer
    - `name` string
    - `newName` string
    - `title` string
    - `description` string
    - `groupCode` string
    - `groupId` integer
    - `applicationName` string
    - `capabilities` Capability[]
      - `id` integer
      - `createdBy` string
      - `createdOn` string, date-time
      - `modifiedBy` string
      - `modifiedOn` string, date-time
      - `capabilityId` integer
      - `name` string
      - `title` string
      - `description` string
      - `type` string
      - `tagName` string
      - `applicationName` string
      - `applicationId` integer
      - `changedBy` string
      - `changedOn` string, date-time
    - `capabilityIds` integer[]
    - `capabilityNames` string[]
    - `changedBy` string
    - `persona` string
    - `platformId` integer
    - `platformName` string
    - `applicationDisplayName` string
    - `platformDisplayName` string
    - `roleAlias` string
    - `changedOn` string, date-time
  - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE' | 'LOCKED' | 'DELETED' | 'LOCKED_CODE' | 'LOCKED_VERIFY' | 'LOCKED_PWD' | 'LOCKED_2FA' | 'SUCCESS' | 'LOGIN_FAILED' | 'PENDING_AUTOREG'
  - `type` string
  - `userId` integer
  - `username` string
  - `usernameHash` string
  - `userRole` UserRole
    - `userRoleId` integer
    - `accessType` string
    - `roles` Role[]
      - `id` integer
      - `createdBy` string
      - `createdOn` string, date-time
      - `modifiedBy` string
      - `modifiedOn` string, date-time
      - `roleId` integer
      - `name` string
      - `newName` string
      - `title` string
      - `description` string
      - `groupCode` string
      - `groupId` integer
      - `applicationName` string
      - `capabilities` Capability[]
        - `id` integer
        - `createdBy` string
        - `createdOn` string, date-time
        - `modifiedBy` string
        - `modifiedOn` string, date-time
        - `capabilityId` integer
        - `name` string
        - `title` string
        - `description` string
        - `type` string
        - `tagName` string
        - `applicationName` string
        - `applicationId` integer
        - `changedBy` string
        - `changedOn` string, date-time
      - `capabilityIds` integer[]
      - `capabilityNames` string[]
      - `changedBy` string
      - `persona` string
      - `platformId` integer
      - `platformName` string
      - `applicationDisplayName` string
      - `platformDisplayName` string
      - `roleAlias` string
      - `changedOn` string, date-time
  - `changedBy` string
  - `deleteFlag` integer
  - `lastPasswordChanged` string, date-time
  - `adminUserId` integer
  - `lastName` string
  - `firstName` string
  - `emailAddress` string
  - `invalidForgotPwdAttempts` string
  - `invalidPwdAttempts` string
  - `company` string
  - `phoneNumber` string
  - `mfa` boolean
  - `applicationName` string
  - `userCreatedInstance` string
  - `appSpaceAccess` AppSpace[]
    - `id` integer
    - `createdBy` string
    - `createdOn` string, date-time
    - `modifiedBy` string
    - `modifiedOn` string, date-time
    - `appName` string
    - `userSpaces` UserSpace[]
      - `id` integer
      - `createdBy` string
      - `createdOn` string, date-time
      - `modifiedBy` string
      - `modifiedOn` string, date-time
      - `spaceKey` string
      - `userName` string
      - `userNameHash` string
      - `changedBy` string
      - `deletedFlag` integer
      - `adminUserId` integer
      - `groupCode` string
      - `userSpaceApplications` string[]
      - `appName` string
      - `changedOn` string, date-time
    - `changedBy` string
    - `changedOn` string, date-time
  - `adminUserType` 'TSYS_ROOT_GLOBAL_ACCESS' | 'TSYS_ROOT_LIMITED_ACCESS' | 'CLIENT_ACCESS'
  - `accessUserManager` string
  - `portfolios` string[]
  - `changedOn` string, date-time

## Response `200`

OK

- ApiResponse
  - `status` string
  - `type` string
  - `title` string
  - `detail` string

---

[API](https://skmtc.net/tsys/apis/quark.md) · [All operations](https://skmtc.net/tsys/apis/quark/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tsys/quark/revisions/f2162281b469/schema)