Organization Auth Config

Update organization authentication methods

Changed on

Update the authentication methods configuration for an organization. This allows admins to configure single or multi-factor authentication.

Validation Rules:

  • Minimum 1 step, maximum 3 steps
  • Each step must have a unique order. order is only checked to be a number and is stored as sent; sign-in runs the steps in ascending order
  • No duplicate methods within the same step
  • No method can appear in multiple steps
  • Each step must have at least one allowed method
  • samlSso and oauth were removed in 1.0 and are refused; use microsoft in place of azureAd

The two rules that compare steps with each other (unique order, a method in only one step) are not expressed in the request schema below; the API refuses a request that breaks them with 400 VALIDATION_ERROR naming body.authMethod.

Unknown fields, at any level of the body, and any query string are dropped by the validator, not refused.

Available Methods:

  • password: Email/password authentication
  • otp: One-time password via email
  • google: Google OAuth 2.0
  • microsoft: Microsoft OAuth 2.0

Example - Single Factor (Password or Google):

{
  "authMethod": [
    { "order": 1, "allowedMethods": [{ "type": "password" }, { "type": "google" }] }
  ]
}

Example - Two Factor (Password + OTP):

{
  "authMethod": [
    { "order": 1, "allowedMethods": [{ "type": "password" }] },
    { "order": 2, "allowedMethods": [{ "type": "otp" }] }
  ]
}

Admin Access Required: Only organization admins can update auth configuration.

post/orgAuthConfig/updateAuthMethod

Request

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

Request body

Response

Authentication methods updated successfully

messagestring required

Example response

{
  "message": "Auth method updated"
}

Changes

    • breaking

      the // response's property type changed from integer to number for status

    • warning

      added the new github enum value to the //// response property for the response status

    • info

      added the new github enum value to the request property ////

    • info

      the // request property type was generalized from integer to number

    • info

      removed the non-success response with the status

    • breaking

      removed the enum value azureAd of the request property ////

    • breaking

      removed the enum value oauth of the request property ////

    • breaking

      removed the enum value samlSso of the request property ////

    • info

      removed the azureAd enum value from the //// response property for the response status

    • info

      removed the oauth enum value from the //// response property for the response status

    • info

      removed the samlSso enum value from the //// response property for the response status