> ## Documentation Index
> Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a user

> Create a user with default roles. Admin privileges are required.



## OpenAPI

````yaml POST /api/v1/users
openapi: 3.1.0
info:
  title: Risk Cloud API
  description: >-
    The Risk Cloud API is a collection of RESTful API endpoints that empower you
    and your team to directly integrate, automate, and build with the Risk
    Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints
    supporting exports in CSV and XSLX formats for flexible integration.


    This API documentation showcases our Risk Cloud API v1, containing a variety
    of endpoints with continued support for enabling integrations with the Risk
    Cloud.


    Visit the [LogicGate Risk Cloud Developer
    Portal](https://www.logicgate.com/developer/) to get started with building
    your custom integration with quick start guides, usage guides, release
    notes, and more. Or download the [v1 OpenAPI
    specification](/legacy-openapi.json).


    Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html)
    endpoints and documentation as well. [Risk Cloud API
    v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First
    endpoints that are tailor made for our developer users, offer concise and
    highly documented details, are supported by a [Postman
    collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc)
    and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi),
    and contain our latest API endpoint releases.
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.11.0
servers:
  - url: https://{subdomain}.logicgate.com
    description: Your Risk Cloud environment.
    variables:
      subdomain:
        description: Your Risk Cloud environment's subdomain (e.g. `qa`).
        default: your-instance
security:
  - ApiToken: []
  - basic: []
tags:
  - name: Authentication
    description: >-
      Getting Started: How to create an [API Access
      Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/)
      to begin integrating with the Risk Cloud API
  - name: Attachment
    description: Endpoints for uploading, downloading, and retrieving record attachments.
  - name: Field
    description: Endpoints for creating, updating, and querying fields.
  - name: Principal
    description: >-
      Endpoints for the authenticated principal to view and manage their own
      details.
  - name: Record Audit
    description: Endpoints for retrieving record audit history and productivity data.
  - name: Step
    description: Endpoints for retrieving steps and the steps a user can access.
  - name: Table Report
    description: Endpoints for retrieving and managing table reports.
  - name: User Group
    description: Endpoints for managing user groups and their membership.
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/
paths:
  /api/v1/users:
    post:
      tags:
        - User
      summary: Create a user
      description: Create a user with default roles. Admin privileges are required.
      operationId: create_2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User_BasicUserSummary'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_BasicUserSummary'
components:
  schemas:
    User_BasicUserSummary:
      allOf:
        - $ref: '#/components/schemas/CurrentValue_BasicUserSummary'
        - type: object
          properties:
            email:
              type: string
            company:
              type: string
            imageUrl:
              type: string
            status:
              type: string
            tier:
              type: string
              enum:
                - PRIMARY
                - SECONDARY
                - LIMITED
            pricingUserTier:
              type: string
              enum:
                - STANDARD
                - POWER
            first:
              type: string
            last:
              type: string
            languageTag:
              type: string
            timeZone:
              type: string
            mfaEnabled:
              type: boolean
            mfaSetup:
              type: boolean
            autoprovisioned:
              type: boolean
            scimStatus:
              type: string
            sendEmail:
              type: boolean
            automatedUser:
              type: boolean
            automatedUserFieldLabels:
              type: array
              items:
                type: string
            roles:
              type: array
              items:
                $ref: '#/components/schemas/Role_BasicUserSummary'
            stepPermissionSets:
              type: array
              items:
                $ref: '#/components/schemas/StepPermissionSet_BasicUserSummary'
            applicationEntitlements:
              type: array
              items:
                $ref: '#/components/schemas/ApplicationEntitlement_BasicUserSummary'
            records:
              type: string
              description: records
            lastLogin:
              $ref: '#/components/schemas/AccessAudit_BasicUserSummary'
            lastDeactivated:
              type: string
              format: date-time
            external:
              type: boolean
            disabled:
              type: boolean
            serviceAccount:
              type: boolean
            superUser:
              type: boolean
            name:
              type: string
            locked:
              type: boolean
        - type: object
          properties:
            email:
              type: string
            company:
              type: string
            imageUrl:
              type: string
            status:
              type: string
            tier:
              type: string
              enum:
                - PRIMARY
                - SECONDARY
                - LIMITED
            pricingUserTier:
              type: string
              enum:
                - STANDARD
                - POWER
            first:
              type: string
            last:
              type: string
            languageTag:
              type: string
            timeZone:
              type: string
            mfaEnabled:
              type: boolean
            mfaSetup:
              type: boolean
            autoprovisioned:
              type: boolean
            scimStatus:
              type: string
            sendEmail:
              type: boolean
            automatedUser:
              type: boolean
            automatedUserFieldLabels:
              type: array
              items:
                type: string
            roles:
              type: array
              items:
                $ref: '#/components/schemas/Role_BasicUserSummary'
            stepPermissionSets:
              type: array
              items:
                $ref: '#/components/schemas/StepPermissionSet_BasicUserSummary'
            applicationEntitlements:
              type: array
              items:
                type: object
                properties:
                  neo4jId:
                    type: string
                  created:
                    type: string
                    format: date-time
                  updated:
                    type: string
                    format: date-time
                  end:
                    $ref: '#/components/schemas/Application_BasicUserSummary'
                  endId:
                    type: string
                  startId:
                    type: string
                required:
                  - created
                  - end
                  - updated
            records:
              type: string
              description: records
            lastLogin:
              $ref: '#/components/schemas/AccessAudit_BasicUserSummary'
            lastDeactivated:
              type: string
              format: date-time
            external:
              type: boolean
            disabled:
              type: boolean
            serviceAccount:
              type: boolean
            superUser:
              type: boolean
            name:
              type: string
            locked:
              type: boolean
      description: Entity for storing all information pertaining to a user.
      discriminator:
        propertyName: status
      oneOf:
        - description: Circular reference to Active_BasicUserSummary
        - description: >-
            And other types: Automated_BasicUserSummary,
            Disabled_BasicUserSummary, External_BasicUserSummary,
            Locked_BasicUserSummary, Service_BasicUserSummary
      properties:
        status:
          type: string
      required:
        - status
    CurrentValue_BasicUserSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_BasicUserSummary'
        - description: >-
            And other types: CurrentDateValue_BasicUserSummary,
            CurrentDateRangeValue_BasicUserSummary,
            CurrentJobValue_BasicUserSummary,
            CurrentCommonValue_BasicUserSummary,
            CurrentDateValue_BasicUserSummary,
            CurrentDateRangeValue_BasicUserSummary, LabelValue_BasicUserSummary,
            CleanAttachment_BasicUserSummary, DirtyAttachment_BasicUserSummary,
            PendingAttachment_BasicUserSummary,
            CurrentGoogleAttachmentValue_BasicUserSummary,
            CurrentSharepointAttachmentValue_BasicUserSummary,
            Active_BasicUserSummary, Automated_BasicUserSummary,
            Disabled_BasicUserSummary, External_BasicUserSummary,
            Locked_BasicUserSummary, Service_BasicUserSummary,
            CurrentNumericRangeValue_BasicUserSummary,
            CurrentJobValue_BasicUserSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        discriminator:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - created
        - discriminator
        - id
        - updated
    Role_BasicUserSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
        locked:
          type: boolean
        superAdmin:
          type: boolean
        defaultRoleForNewUsers:
          type: boolean
        autoprovisioned:
          type: boolean
        externalId:
          type: string
        userCount:
          type: integer
          format: int32
      required:
        - active
        - autoprovisioned
        - created
        - defaultRoleForNewUsers
        - externalId
        - id
        - locked
        - name
        - superAdmin
        - updated
        - userCount
    StepPermissionSet_BasicUserSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
      required:
        - active
        - created
        - id
        - updated
    ApplicationEntitlement_BasicUserSummary:
      type: object
      properties:
        neo4jId:
          type: string
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        end:
          $ref: '#/components/schemas/Application_BasicUserSummary'
        endId:
          type: string
        startId:
          type: string
      required:
        - created
        - end
        - updated
    AccessAudit_BasicUserSummary:
      type: object
      description: Entity used to track authentication attempts.
      discriminator:
        propertyName: accessType
      oneOf:
        - $ref: '#/components/schemas/LogIn_BasicUserSummary'
        - description: >-
            And other types: LogOut_BasicUserSummary,
            LogInFail_BasicUserSummary, CredentialsRolled_BasicUserSummary,
            TokenRolled_BasicUserSummary, LogIn_BasicUserSummary,
            LogOut_BasicUserSummary, LogInFail_BasicUserSummary,
            CredentialsRolled_BasicUserSummary, TokenRolled_BasicUserSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        accessType:
          type: string
      required:
        - accessType
        - active
        - created
        - id
        - updated
    Application_BasicUserSummary:
      type: object
      description: >-
        An entity for managing top-level application data. A application
        represents the highest level of organization for other entities within
        the application.
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
          description: Name of the application.
        createdBy:
          description: Circular reference to User_BasicUserSummary
        description:
          type: string
          description: Description of the application.
          maxLength: 2000
          minLength: 0
        color:
          type: string
          description: Icon color of the application.
        icon:
          type: string
          description: Icon type of the application.
          enum:
            - >-
              fa-bookmark, fa-bolt, fa-bullhorn,
              fa-certificate,fa-check-square-o, fa-cloud, fa-comments,
              fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder,
              fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring,
              fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal,
              fa-university, fa-user-circle
        type:
          type: string
        sourceApplicationId:
          type: string
        sourceEnvironment:
          type: string
        permissionsEnabled:
          type: boolean
        imported:
          type: boolean
        copied:
          type: boolean
        live:
          type: boolean
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
        uxriEnabled:
          type: boolean
          description: Whether or not UXRI is enabled on this application.
        shortCode:
          type: string
          description: Short display code for the application in navigation.
          pattern: ^(?! +$)[a-zA-Z0-9 ]{1,10}$
        defaultHomeScreen:
          $ref: '#/components/schemas/HomeScreen_BasicUserSummary'
      required:
        - active
        - color
        - copied
        - created
        - createdBy
        - currency
        - defaultHomeScreen
        - description
        - icon
        - id
        - imported
        - live
        - name
        - permissionsEnabled
        - shortCode
        - sourceApplicationId
        - sourceEnvironment
        - type
        - updated
        - uxriEnabled
    CurrentCommonValue_BasicUserSummary:
      allOf:
        - description: Circular reference to CurrentValue_BasicUserSummary
      required:
        - description
    LogIn_BasicUserSummary:
      allOf:
        - description: Circular reference to AccessAudit_BasicUserSummary
      required:
        - accessType
    HomeScreen_BasicUserSummary:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
      required:
        - active
        - created
        - id
        - updated
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.