Update organization authentication methods
Changed onUpdate 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.
Request
- Base URLhttps://app.pipeshub.com/api/v1
- URLhttps://app.pipeshub.com/api/v1/orgAuthConfig/updateAuthMethod
- AuthHTTP bearer
Request body
Response
Authentication methods updated successfully
Example response
{
"message": "Auth method updated"
}Changes
- breaking
the
//response's property type changed fromintegertonumberfor status - warning
added the new
githubenum value to the////response property for the response status - info
added the new
githubenum value to the request property//// - info
the
//request property type was generalized fromintegertonumber - info
removed the non-success response with the status
- breaking
- breaking
removed the enum value
azureAdof the request property//// - breaking
removed the enum value
oauthof the request property//// - breaking
removed the enum value
samlSsoof the request property//// - info
removed the
azureAdenum value from the////response property for the response status - info
removed the
oauthenum value from the////response property for the response status - info
removed the
samlSsoenum value from the////response property for the response status
- breaking