Metadata on how to configure for common IDP providers

GET 
/api/v2/idpconfig/examples

Metadata on how to configure for common IDP providers

Request

Responses

200

Example IDP configurations

application/json

Schema

Schema

providers

undefined[]

required

Array [

defaultConfig

required

allowedRedirectURLHostsstring[]

clientIDstring

clientScopesstring[]

clientSecretstring

providerstring

providerParameters

object

property name*string

requiredIDPGroupsstring[]

serverURLstring

userClaimsstring[]

docsLinkstring

helpstring

idstringrequired

namestringrequired

serverURLParameters

object

required

properties

[object Object]

Possible values: Value must match regular expression [object Object]

]

Example (from schema)

{
  "providers": [
    {
      "defaultConfig": {
        "allowedRedirectURLHosts": [
          "string"
        ],
        "clientID": "string",
        "clientScopes": [
          "string"
        ],
        "clientSecret": "string",
        "provider": "string",
        "providerParameters": {},
        "requiredIDPGroups": [
          "string"
        ],
        "serverURL": "string",
        "userClaims": [
          "string"
        ]
      },
      "docsLink": "string",
      "help": "string",
      "id": "string",
      "name": "string",
      "serverURLParameters": {}
    }
  ]
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

codeint32required
detailstringrequired
messagestringrequired
uristringrequired
verbstringrequired

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}