OneRail LP Self Onboarding API

openapi: 3.2.0
info:
  version: 1.0.0
  title: OneRail Operation Dashboard LP Self Onboarding API
  description: Defines Operations Dashboard APIs
  license:
    name: UNLICENSED
    url: ''
servers:
- url: /
  description: Default relative server URL
security:
- bearer: []
tags:
- name: LP Self Onboarding
paths:
  /v1/user/lp-self-onboarding:
    post:
      x-exegesis-controller: LPSelfOnboarding
      summary: Creates user
      operationId: createLpSelfOnboarding
      security:
      - ApiKey: []
        AppId: []
      - bearer: []
      tags:
      - LP Self Onboarding
      requestBody:
        description: Organization and User details
        content:
          application/json:
            schema:
              type: object
              description: Create user request
              properties:
                organization:
                  type: object
                  required:
                  - name
                  properties:
                    name:
                      description: Organization name
                      type: string
                user:
                  type: object
                  required:
                  - firstName
                  - lastName
                  - emailAddress
                  properties:
                    firstName:
                      type: string
                    lastName:
                      type: string
                    emailAddress:
                      type: string
                    active:
                      type: boolean
                      default: true
      responses:
        '200':
          description: LP Self Onboarding Record
          content:
            application/json:
              schema:
                type: object
                description: LP onboarding details.
                properties:
                  userId:
                    type: string
                    format: uuid
                  organizationId:
                    type: string
                    format: uuid
                  lpAdminRoleId:
                    type: string
                    format: uuid
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
  /v1/role/{roleId}/lp-self-onboarding:
    parameters:
    - name: roleId
      in: path
      required: true
      description: roleId
      schema:
        type: string
    put:
      x-exegesis-controller: LPSelfOnboarding
      summary: Update user role permissions
      operationId: updateRolePermissionsApi
      security:
      - ApiKey: []
        AppId: []
      tags:
      - LP Self Onboarding
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Update role request
              required:
              - userId
              - permissions
              properties:
                userId:
                  type: string
                  format: uuid
                permissions:
                  type: array
                  description: Array of permissions
                  items:
                    type: string
      responses:
        '200':
          $ref: '#/paths/~1v1~1user~1lp-self-onboarding/post/responses/200'
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'Standard JWT bearer token used for authenticated OmniPoint users

        and internal service-to-service calls. Clients send `Authorization: Bearer <jwt>`

        and the token is validated using the shared Core access token secret.

        '
    ApiKey:
      type: apiKey
      in: header
      name: X-ONERAIL-API-KEY
      description: 'Shared secret key used for machine-to-machine integrations. Must be sent

        together with `X-ONERAIL-APP-ID` and is validated against the stored ApiAuth

        record for that application.

        '
    AppId:
      type: apiKey
      in: header
      name: X-ONERAIL-APP-ID
      description: 'Application identifier (UUID) that pairs with `X-ONERAIL-API-KEY` for

        machine-to-machine integrations. Both headers are required for ApiKey-based

        authentication.

        '
    OAuth:
      type: oauth2
      description: 'OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed

        integrations). Clients obtain tokens from their own IdP outside of this API

        and call endpoints with `Authorization: OAuth <access_token>`. The

        `authorizationUrl` and `tokenUrl` values below are placeholders only to

        satisfy the OpenAPI schema; this service does not call them directly and the

        real IdP URLs are configured via environment and introspection logic in code.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://dummy-unused-url.com
          tokenUrl: https://dummy-unused-url.com
          scopes: {}