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

# User Signup

> Endpoint for user registration.

This endpoint allows users to sign up by providing necessary user data.
Upon successful registration, a new user is created and added to the database.
Self-service signup with org_name creates an Admin user and provisions the organization.

Parameters:
- user_data: UserCreate - Data required to create a new user.

Returns:
- dict: A dictionary containing a success message upon successful user creation.



## OpenAPI

````yaml post /api/user/signup/
openapi: 3.1.0
info:
  title: Apigene
  description: Apigene API
  version: 1.0.0
  contact:
    name: Apigene Support
    url: https://app.apigene.ai
    email: support@apigene.ai
servers:
  - url: https://app.apigene.ai
security:
  - BearerAuth: []
paths:
  /api/user/signup/:
    post:
      tags:
        - User
      summary: User Signup
      description: >-
        Endpoint for user registration.


        This endpoint allows users to sign up by providing necessary user data.

        Upon successful registration, a new user is created and added to the
        database.

        Self-service signup with org_name creates an Admin user and provisions
        the organization.


        Parameters:

        - user_data: UserCreate - Data required to create a new user.


        Returns:

        - dict: A dictionary containing a success message upon successful user
        creation.
      operationId: user_signup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    UserCreate:
      properties:
        org_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Org Name
        email:
          type: string
          format: email
          title: Email
        password:
          type: string
          title: Password
        role:
          $ref: '#/components/schemas/UserRole'
          default: User
      type: object
      required:
        - email
        - password
      title: UserCreate
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserRole:
      type: string
      enum:
        - APIGene
        - Owner
        - Admin
        - User
        - Member
      title: UserRole
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Example:
        'Authorization: Bearer {token}'

````