Jump to

• Request
• Response

Get Active OIDC Provider Name

get

/api/v1/auth/provider/active

Get the active OIDC provider name for the login page.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ActiveProviderResponse

Type: object

Active provider name response.

Show Source

• providerName: string
  Provider name. It cannot be Default, which is reserved for the built-in LDAP configuration.

{
    "description":"Active provider name response.",
    "type":"object",
    "properties":{
        "providerName":{
            "type":"string",
            "description":"Provider name. It cannot be Default, which is reserved for the built-in LDAP configuration."
        }
    }
}

204 Response

No active provider is configured.

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Back to Top