Get organization authentication methods
Changed onRetrieve the configured authentication methods for the organization.
Response Structure:
Returns an array of authentication steps, each containing:
- order: The step's position, 1, 2 or 3. Steps are returned in ascending order of the order they were saved with and renumbered from 1. A method removed in 1.0 is left out (azureAd reads as microsoft), a step left with no method is dropped, and when a removed method was left out password is added to the first step
- allowedMethods: Array of methods allowed for that step
Example Response:
{
"authMethods": [
{ "order": 1, "allowedMethods": [{ "type": "password" }, { "type": "google" }] },
{ "order": 2, "allowedMethods": [{ "type": "otp" }] }
]
}
Admin Access Required: Only organization admins can view auth configuration, with a session access token. The query string is not read.
Request
- Base URLhttps://app.pipeshub.com/api/v1
- URLhttps://app.pipeshub.com/api/v1/orgAuthConfig/authMethods
- AuthHTTP bearer
Response
Authentication methods retrieved successfully
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
removed the non-success response with the status
- breaking
- 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
- info