Organization Auth Config

Set up auth configuration

Changed on

Set up or initialize the organization's authentication configuration.

First-run only: when the deployment already has a sign-in configuration the answer is 200 with Org config already done, and the request body is not read at all (a missing body, missing or mistyped fields and unknown fields are all accepted). The route has no validator; the body fields below are the ones read when the organization is created. The query string is not read.

post/orgAuthConfig

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/orgAuthConfig
  • Auth
    HTTP bearer

Request body

contactEmailstring email required

Organization contact email

registeredNamestring required

Organization registered name

adminFullNamestring required

Admin user full name

sendEmailboolean

Whether to send welcome email

Response

Auth configuration already exists for this deployment

messagestring required

Changes