Organization Auth Config

Get organization authentication methods

Changed on

Retrieve 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.

get/orgAuthConfig/authMethods

Request

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

Response

Authentication methods retrieved successfully

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

      removed the non-success response with the status

    • 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