Test an Identity Provider connection.

Prev Next
Post
/identity-providers/test

Test connection for the given Identity Provider JSON.

Security
HTTP
Type bearer
Body parameters

Identity Provider object.

object
#content#
Responses
200

Test result.

object
success
boolean

Whether the connection succeeded or not.

Examplefalse
error
boolean

The error text if the connection fails.

ExampleConnection timed out.
400

JSON error. Check the JSON format.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

422

Request validation error. Check "errors" array for details.

Expand All
object

Http 422 error for object validation.

id
string

Machine readable error code.

message
string

Human readable error details.

errors
Array of object

List of fields with validation errors.

object
field
string

Name of the field that failed validation.

Examplename
message
string

Failure reason.

Examplemay not be null