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

# Post organisations connection init

> InitialiseConnection is used to initiate a connection of an App to a user's organisation. Different connections
require different auth methods (or even no auth method at all), this endpoint returns the necessary
configuration required to establish that connection.




## OpenAPI

````yaml post /organisations/{organisationId}/connection-init
openapi: 3.0.3
info:
  title: Switchboard API
  description: >-
    The Switchboard API provides users the ability to manage their Apps,
    Integrations and Workflows
  version: 0.0.1-alpha.0
servers:
  - url: https://platform.versori.com/api/switchboard/v1alpha1/
    description: Production server
  - url: http://localhost:8080/v1alpha1/
    description: Localhost
security:
  - apiKey: []
paths:
  /organisations/{organisationId}/connection-init:
    post:
      tags:
        - connections
      description: >
        InitialiseConnection is used to initiate a connection of an App to a
        user's organisation. Different connections

        require different auth methods (or even no auth method at all), this
        endpoint returns the necessary

        configuration required to establish that connection.
      operationId: InitialiseConnection
      parameters:
        - name: organisationId
          in: path
          required: true
          schema:
            type: string
          example: '101'
      requestBody:
        $ref: '#/components/requestBodies/InitConnectionRequest'
      responses:
        '200':
          $ref: '#/components/responses/InitConnectionResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  requestBodies:
    InitConnectionRequest:
      description: The parameters to initialise a new connection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InitConnectionRequestBody'
  responses:
    InitConnectionResponse:
      description: The configuration to initialise a new connection.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InitConnectionResponseBody'
    ErrorResponse:
      description: The default error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    InitConnectionRequestBody:
      type: object
      properties:
        appId:
          type: string
        authType:
          type: string
      required:
        - appId
        - authType
    InitConnectionResponseBody:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/InitConnectionAction'
      required:
        - action
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        extensions:
          type: object
      required:
        - code
        - message
    InitConnectionAction:
      type: object
      properties:
        redirect:
          $ref: '#/components/schemas/InitConnectionActionRedirect'
        form:
          $ref: '#/components/schemas/InitConnectionActionForm'
    InitConnectionActionRedirect:
      description: >
        InitConnectionActionRedirect tells the user agent to redirect to the
        provided URL to complete the connection.

        This is most likely to perform an OAuth2.0 authorization code grant, but
        there may be other protocols in the

        future. In the case of an OAuth2.0 flow, the redirect URL will be back
        to switchboard to complete the connection

        process, this will be transparent to the user.
      type: object
      properties:
        url:
          description: The URL to redirect the user
          type: string
      required:
        - url
    InitConnectionActionForm:
      description: >
        InitConnectionActionForm tells the user agent to render a form
        requesting additional information from the user

        such as api-key or basic-auth credentials.
      type: object
      properties:
        schema:
          description: >
            This is to be some kind of schema used to generate a HTML form. The
            exact details of this schema are not

            known at the time of writing.
          type: object
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization

````