Get Identity Precheck Result

Get a list precheck result with warnings/errors

Request

URI

GET

https://{api_host}/v1/identity-broker/prechecks

COPY

Query Parameters

string

type

Optional

IDP type for which Precheck needs to be run

Responses

200

Returns IdentityProviderPrecheckResult of type(s) application/json

{
    "status": "string",
    "details": [
        {
            "type": "string",
            "message": "string"
        }
    ]
}

string

status

Required

One of SUCCESS, WARNING, FAILURE

array of details

details

Optional

Details about status type and error messages

404

Not Found

Returns ErrorResponse of type(s) application/json

{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

errorCode

array of string

arguments

Optional

arguments

object

context

Optional

context

string

message

Optional

message

string

remediationMessage

Optional

remediationMessage

array of ErrorCause

cause

Optional

cause

array of ErrorResponse

nestedErrors

Optional

nestedErrors

string

referenceToken

Optional

referenceToken

500

Internal Server Error

Returns ErrorResponse of type(s) application/json

{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

errorCode

array of string

arguments

Optional

arguments

object

context

Optional

context