Nexla Self Sign-Up API

openapi: 3.2.0
info:
  version: v1
  title: Nexla Rest Self Sign-Up API
  termsOfService: https://nexla.com/terms-of-service/
  contact:
    name: Nexla Support
    url: https://docs.nexla.com
    email: support@nexla.com
  license:
    name: Nexla
    url: https://nexla.com
  x-logo:
    url: https://cdn.nexla.io/ui/assets/brand/v2/nexla-logo-color-portrait.svg
    backgroundColor: '#ffffff'
  description: '# Introduction


    The Nexla API is a REST-ful API used to easily create and manage resources in Nexla in ways that best fit any use case.'
servers:
- url: https://{nexla-api-host}
  variables:
    nexla-api-host:
      default: dataops.nexla.io/nexla-api
      description: Nexla API URL your Nexla instance
security:
- NexlaSessionToken: []
tags:
- name: Self Sign-Up
  description: Operations for self-signup and verification.
paths:
  /signup:
    post:
      operationId: self_sign_up
      summary: Sign Up
      description: 'This endpoint is used for users to register in the system. Once signup process is completed (email is verified, manual approval by admin may be required),

        user can set a password and login to the system.

        Email verification link is sent to the email provided by the user.


        Optionally, it allows for logged in user to be called. In this case, email verification will be skipped, and new org is created immediately.'
      tags:
      - Self Sign-Up
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignupRequest'
      responses:
        '200':
          description: Successful response.
        '400':
          description: Bad Request in case of invalid input, unacceptable email etc.
  /signup/verify_email:
    get:
      operationId: verify_email
      summary: Verify Email
      description: 'This endpoint is used to verify the email address of the user.

        The user will be able to set a password and login to the system after the email is verified (unless manual admin approval is required).'
      tags:
      - Self Sign-Up
      parameters:
      - name: token
        in: query
        description: The token received in the email.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
        '400':
          description: Bad Request
components:
  schemas:
    SignupRequest:
      type: object
      additionalProperties: false
      properties:
        email:
          type: string
        full_name:
          type: string
        g_captcha_response:
          type: string
        invite:
          description: "Invite code is required for self sign up. This is a unique code that is shared with the user to allow them to sign up. \nIncluded in the signup link if invites is used.\n"
          type: string
        personal_info:
          description: Free form object to store marketing/private information about the user.
          type: object
          additionalProperties: true
  securitySchemes:
    NexlaSessionToken:
      type: http
      scheme: Bearer
      bearerFormat: JWT
      description: "The first step in calling the Nexla API or Nexla CLI is to fetch a Session access token by logging on to your Nexla UI instance. This ensures that your authentication is performed through your organization's preferred Identity Provider.\n\nTo fetch an access token from the Nexla UI, simply go to your Nexla UI instance, and try the route `/token`. For example, if your Nexla UI instance is at `https://dataops.nexla.io`, open `https://dataops.nexla.io/token` in the browser. \n\nThis will automatically route you to a login page, ask you to authenticate using your preferred Identity Provider, and, upon successful authentication, route you to a page where you can copy the Access Token.\n\nUsage format: `Bearer <JWT>`.\n"
    NexlaApiKeyQuery:
      type: apiKey
      name: api_key
      in: query
      description: '> **Important:** Never share your API keys. Keep them guarded and secure. If you think the key has been compromised, you can rotate the API key by calling relevant API Key management endpoints.


        The platform generates a unique API key for this resource. Add the API key as a query parameter to authenticate this request.

        Usage: `?api_key=<api-key>`

        '
    NexlaApiKeyHeader:
      type: http
      scheme: Basic
      description: '> **Important:** Never share your API keys. Keep them guarded and secure. If you think the key has been compromised, you can rotate the API key by calling relevant API Key management endpoints.


        The platform generates a unique API key for this resource. Add the API key as an authorization header to authenticate this request.

        Usage format: `Basic <api-key>`

        '
    basicAuth:
      type: http
      scheme: basic
    GoogleSSOToken:
      type: http
      scheme: Bearer
      bearerFormat: JWT
      description: 'The token that is used when logging into Nexla via Google SSO.

        '
x-tagGroups:
- name: Session
  tags:
  - Session Management
- name: Integrate
  tags:
  - Flows
  - Sources
  - Destinations (Data Sinks)
  - Nexsets (Data Sets)
  - Credentials
  - Data Maps
  - Code Containers
  - Transforms
  - Projects
- name: Monitor
  tags:
  - Notifications
  - Metrics
  - Audit Logs
  - Quarantine Settings
- name: Collaborate
  tags:
  - Access Control
- name: Account Management
  tags:
  - Organizations
  - Users
  - User Settings
  - Teams
  - Gen AI Configs
- name: Real-Time Events
  tags:
  - Webhooks
- name: Rate Limiting
  tags:
  - Limits
- name: Marketplace
  tags:
  - Marketplace
- name: Self Sign-Up
  tags:
  - Self Sign-Up
  - Self Sign-Up Admin
- name: Async Tasks
  tags:
  - Async Tasks