Validates that the provided values will work (as best Wayfinder can tell) to integrate with the specified IDP, without reconfiguring the system

POST 
/api/v2/idpconfig/verify

Validates that the provided values will work (as best Wayfinder can tell) to integrate with the specified IDP, without reconfiguring the system

Request

Query Parameters

redirect_url stringrequired

URL to redirect to if the IDP configuration is valid

application/json

Body

required

IDP configuration to test

allowedRedirectURLHosts string[]
clientID string
clientScopes string[]
clientSecret string
provider string

providerParameters

object

property name* string
requiredIDPGroups string[]
serverURL string
userClaims string[]

Responses

200

Validation report about the IDP configuration

application/json

Schema

Schema

messages string[]
success booleanrequired
testURL string

Example (from schema)

{
  "messages": [
    "string"
  ],
  "success": true,
  "testURL": "string"
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32required

fieldErrors

undefined[]

required

Array [

errCode stringrequired

field stringrequired

message stringrequired

]

message stringrequired

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

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

code int32required
detail stringrequired
message stringrequired
uri stringrequired
verb stringrequired

Example (from schema)

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

Loading...