Nexla Self Sign-Up Admin API

openapi: 3.2.0
info:
  version: v1
  title: Nexla Rest Self Sign-Up Admin 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. It can be used to configure and monitor data flows for different data-integration use cases and to perform all aspects of data engineering automation offered by the Nexla platform.


    The Nexla API supports all data flow-creation and -management actions in the platform, as well as administrative user- and organization-level account-management tasks. Note that all other client packages, such as the Nexla CLI and Nexla UI, also connect to the overall Nexla infrastructure through the Nexla API.


    The API references in this document lists all API endpoints and the corresponding payloads.


    Check out the [API Developer Guides](https://developers.nexla.com/docs/nexla-api) to view guides and tutorials for recommended use cases for different endpoints.


    # API Data Format and Versions


    The API uses JSON for all data exchanges.


    You __should__ specify the API version that should be used in the Accept header of each request. For example, to access Version 1 of the API, the Accept header should be the following:

    ```

    Accept: application/vnd.nexla.api.v1+json

    ```


    The Nexla API also supports a generic version header, which will default your access to the latest version of the data source/destination API.



    ```

    Accept: application/json

    ```


    # Authentication


    Most Nexla API endpoints require `Bearer Token` authentication mechanism for making an authenticated request to the API. While this token can be generated programmatically outside Nexla UI by starting a session with an `api_key`, unless unavoidable, we recommend starting your session from the Nexla UI and using the `Nexla Session Token` from the Nexla UI as the Authorization header for calls to the Nexla API.


    <SecurityDefinitions />'
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 Admin
  description: Operations for approving self-signup requests.
paths:
  /self_signup_requests:
    get:
      operationId: get_self_signup_requests
      summary: List Self Sign Up Requests
      description: 'Returns a list of self sign up requests for an admin.

        '
      tags:
      - Self Sign-Up Admin
      responses:
        '200':
          $ref: '#/components/responses/self_signup_requests_response'
        '403':
          description: Forbidden
  /self_signup_requests/{request_id}/approve:
    put:
      operationId: approve_self_sign_up_request
      summary: Approve Self Sign Up Request
      description: "This endpoint is used to approve a self sign up request. System admin access required. \nThe user will be able to set a password and login to the system after the request is approved.\n"
      tags:
      - Self Sign-Up Admin
      parameters:
      - name: request_id
        in: path
        description: The ID of the self sign up request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
        '403':
          description: Forbidden
  /self_signup_blocked_domains:
    get:
      operationId: get_self_signup_blocked_domains
      summary: List self-sign-up blocked domains for admins.
      description: 'Returns a list of domains that are blocked for self-sign-up. Requires admin access.

        '
      tags:
      - Self Sign-Up Admin
      responses:
        '200':
          $ref: '#/components/responses/self_signup_blocked_domains_response'
        '403':
          description: Forbidden
    post:
      operationId: add_self_signup_blocked_domain
      summary: Add self-sign-up blocked domain for admins.
      description: 'Adds a domain to the list of domains that are blocked for self-sign-up. Requires admin access.

        '
      tags:
      - Self Sign-Up Admin
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  description: The domain to block for self-sign-up.
                  example: example-domain.com
      responses:
        '200':
          description: Successful response.
        '400':
          description: Bad Request
        '403':
          description: Forbidden
  /self_signup_blocked_domains/{domain_id}:
    put:
      operationId: update_self_signup_blocked_domain
      summary: Update self-sign-up blocked domain for admins.
      description: 'Updates a domain in the list of domains that are blocked for self-sign-up. Requires admin access.

        '
      tags:
      - Self Sign-Up Admin
      parameters:
      - name: domain_id
        in: path
        description: The ID of the self sign up blocked domain.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  description: The domain to block for self-sign-up.
                  example: example-domain.com
      responses:
        '200':
          description: Successful response.
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not found error
    delete:
      operationId: delete_self_signup_blocked_domain
      summary: Delete self-sign-up blocked domain for admins.
      description: 'Deletes a domain from the list of domains that are blocked for self-sign-up. Requires admin access.

        '
      tags:
      - Self Sign-Up Admin
      parameters:
      - name: domain_id
        in: path
        description: The ID of the self sign up blocked domain.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
        '403':
          description: Forbidden
        '404':
          description: Not found error
components:
  responses:
    self_signup_blocked_domains_response:
      description: Success
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                id:
                  type: integer
                  description: The unique identifier of the blocked domain.
                domain:
                  type: string
                  description: The email domain that is blocked.
    self_signup_requests_response:
      description: Success
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                id:
                  type: integer
                  description: The unique identifier of the self sign up request.
                status:
                  type: string
                  description: The status of the self sign up request.
                  enum:
                  - pending
                  - email_verified
                  - approved
                  - rejected
                email:
                  type: string
                  description: The email address of the user.
                full_name:
                  type: string
                  description: The full name of the user.
                invite_id:
                  type: integer
                  description: The unique identifier of the invite.
                created_at:
                  type: string
                  format: date-time
                  description: The date and time when the self sign up request was created.
                updated_at:
                  type: string
                  format: date-time
                  description: The date and time when the self sign up request was last updated.
  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