Jump to

• Request
• Response

Get the reponses from init challenge, finalize challenge and challenge api to identify if user needs to be challenged further.

put

/authn/v1

Update the authn status within UAS. Also returns if more challenge is required for the user or can return success for the user. Internally can call validate to verfiy the passed parameters with factors which are passive.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

The object defines the request parametes for update authentication request.

Show Source

• challengeAnswer: string
  answer provided by the user to be passed to factor.
• challengedata: object InitChallengeData
  Information about the user and user's registration for challenge factor.
• challengeop(required): string
  Requested operation to perform on the challenge API. It can be one of Init/Validate/Finalize. For init nonce is optional. Validate/Finalize nonce is required.
• challengeResult: string
  Result of the challenge. One of Success/Error/Failure. Validate will result in invocation of passive factor api to validate ChallengeAnswer. If the factor is not passive, exception will be thrown. Other result will be passed directly to finalize challenge call.
• challengeResultReason: string
  Reason for challenge result if it is failure. One of wrong_answer/too_many_attempts/channel_comm_error/other_error/unavailable_for_user/user_abandoned/user_timedout.
• correlationId(required): string
  transaction id provided by the challenge api. Also this field contains previous id used within the session to update store.
• nonce: string
  random string to identify the future request. This will change in each response and the lastest nonce is expected in the finalize call.

{
    "required":[
        "challengeop",
        "correlationId"
    ],
    "type":"object",
    "properties":{
        "correlationId":{
            "type":"string",
            "description":"transaction id provided by the challenge api. Also this field contains previous id used within the session to update store."
        },
        "nonce":{
            "type":"string",
            "description":"random string to identify the future request. This will change in each response and the lastest nonce is expected in the finalize call."
        },
        "challengedata":{
            "$ref":"#/components/schemas/InitChallengeData"
        },
        "challengeop":{
            "type":"string",
            "description":"Requested operation to perform on the challenge API. It can be one of Init/Validate/Finalize. For init nonce is optional. Validate/Finalize nonce is required."
        },
        "challengeAnswer":{
            "type":"string",
            "description":"answer provided by the user to be passed to factor."
        },
        "challengeResult":{
            "type":"string",
            "description":"Result of the challenge. One of Success/Error/Failure. Validate will result in invocation of passive factor api to validate ChallengeAnswer. If the factor is not passive, exception will be thrown. Other result will be passed directly to finalize challenge call."
        },
        "challengeResultReason":{
            "type":"string",
            "description":"Reason for challenge result if it is failure. One of wrong_answer/too_many_attempts/channel_comm_error/other_error/unavailable_for_user/user_abandoned/user_timedout."
        }
    },
    "description":"The object defines the request parametes for update authentication request."
}

Nested Schema : InitChallengeData

Type: object

Information about the user and user's registration for challenge factor.

Show Source

• abandonedChallenge: boolean
  Flag to indicate if this challenge is abandoned by user.
• correlationId: string
  Co-relation Id for this challenge. Factor implementation should use this in call back to SP/UAS during the finishChallenge call.
• factorAttributes: array factorAttributes
• factorKey: string
  the name of the factor that is selected by end user.
• failureURL: string
  Resource where flow should be redirected to in case of failed challenge. Most times this will be URL of the finalizerChallenge.
• groupId: string
  Group Id or app-name as applicable for user.
• isRetry: boolean
  If this is a retry.
• successURL: string
  Resource where flow should be redirected to in case of successful challenge.
• timeToLiveInSec: integer
  duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated.
• uniqueUserId: string
  Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination.
• userId: string
  Unique identifier of the user. May be further qualified by groupId.

{
    "required":[
        "userId|factorKey|correlationId"
    ],
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "description":"Unique identifier of the user. May be further qualified by groupId."
        },
        "groupId":{
            "type":"string",
            "description":"Group Id or app-name as applicable for user."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        },
        "correlationId":{
            "type":"string",
            "description":"Co-relation Id for this challenge. Factor implementation should use this in call back to SP/UAS during the finishChallenge call."
        },
        "factorKey":{
            "type":"string",
            "description":"the name of the factor that is selected by end user."
        },
        "isRetry":{
            "type":"boolean",
            "description":"If this is a retry."
        },
        "successURL":{
            "type":"string",
            "description":"Resource where flow should be redirected to in case of successful challenge."
        },
        "failureURL":{
            "type":"string",
            "description":"Resource where flow should be redirected to in case of failed challenge. Most times this will be URL of the finalizerChallenge."
        },
        "timeToLiveInSec":{
            "type":"integer",
            "description":"duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated."
        },
        "abandonedChallenge":{
            "type":"boolean",
            "description":"Flag to indicate if this challenge is abandoned by user."
        },
        "factorAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserFactorAttribute"
            }
        }
    },
    "description":"Information about the user and user's registration for challenge factor."
}

Nested Schema : factorAttributes

Type: array

Show Source

• Array of: object UserFactorAttribute
  A map represented as an array of entries.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserFactorAttribute"
    }
}

Nested Schema : UserFactorAttribute

Type: object

A map represented as an array of entries.

Show Source

• userAttributeName: string
  Name of factor specific attribute for this user.
• userAttributeValue: string
  Value of factor specific attribute for this user.

{
    "required":[
        "userAttributeName|userAttributeValue"
    ],
    "type":"object",
    "properties":{
        "userAttributeName":{
            "type":"string",
            "description":"Name of factor specific attribute for this user."
        },
        "userAttributeValue":{
            "type":"string",
            "description":"Value of factor specific attribute for this user."
        }
    },
    "description":"A map represented as an array of entries."
}

Request Body - application/json ()

Root Schema : schema

Type: object

The object defines the request parametes for update authentication request.

Show Source

• challengeAnswer: string
  answer provided by the user to be passed to factor.
• challengedata: object InitChallengeData
  Information about the user and user's registration for challenge factor.
• challengeop(required): string
  Requested operation to perform on the challenge API. It can be one of Init/Validate/Finalize. For init nonce is optional. Validate/Finalize nonce is required.
• challengeResult: string
  Result of the challenge. One of Success/Error/Failure. Validate will result in invocation of passive factor api to validate ChallengeAnswer. If the factor is not passive, exception will be thrown. Other result will be passed directly to finalize challenge call.
• challengeResultReason: string
  Reason for challenge result if it is failure. One of wrong_answer/too_many_attempts/channel_comm_error/other_error/unavailable_for_user/user_abandoned/user_timedout.
• correlationId(required): string
  transaction id provided by the challenge api. Also this field contains previous id used within the session to update store.
• nonce: string
  random string to identify the future request. This will change in each response and the lastest nonce is expected in the finalize call.

{
    "required":[
        "challengeop",
        "correlationId"
    ],
    "type":"object",
    "properties":{
        "correlationId":{
            "type":"string",
            "description":"transaction id provided by the challenge api. Also this field contains previous id used within the session to update store."
        },
        "nonce":{
            "type":"string",
            "description":"random string to identify the future request. This will change in each response and the lastest nonce is expected in the finalize call."
        },
        "challengedata":{
            "$ref":"#/components/schemas/InitChallengeData"
        },
        "challengeop":{
            "type":"string",
            "description":"Requested operation to perform on the challenge API. It can be one of Init/Validate/Finalize. For init nonce is optional. Validate/Finalize nonce is required."
        },
        "challengeAnswer":{
            "type":"string",
            "description":"answer provided by the user to be passed to factor."
        },
        "challengeResult":{
            "type":"string",
            "description":"Result of the challenge. One of Success/Error/Failure. Validate will result in invocation of passive factor api to validate ChallengeAnswer. If the factor is not passive, exception will be thrown. Other result will be passed directly to finalize challenge call."
        },
        "challengeResultReason":{
            "type":"string",
            "description":"Reason for challenge result if it is failure. One of wrong_answer/too_many_attempts/channel_comm_error/other_error/unavailable_for_user/user_abandoned/user_timedout."
        }
    },
    "description":"The object defines the request parametes for update authentication request."
}

Nested Schema : InitChallengeData

Type: object

Information about the user and user's registration for challenge factor.

Show Source

• abandonedChallenge: boolean
  Flag to indicate if this challenge is abandoned by user.
• correlationId: string
  Co-relation Id for this challenge. Factor implementation should use this in call back to SP/UAS during the finishChallenge call.
• factorAttributes: array factorAttributes
• factorKey: string
  the name of the factor that is selected by end user.
• failureURL: string
  Resource where flow should be redirected to in case of failed challenge. Most times this will be URL of the finalizerChallenge.
• groupId: string
  Group Id or app-name as applicable for user.
• isRetry: boolean
  If this is a retry.
• successURL: string
  Resource where flow should be redirected to in case of successful challenge.
• timeToLiveInSec: integer
  duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated.
• uniqueUserId: string
  Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination.
• userId: string
  Unique identifier of the user. May be further qualified by groupId.

{
    "required":[
        "userId|factorKey|correlationId"
    ],
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "description":"Unique identifier of the user. May be further qualified by groupId."
        },
        "groupId":{
            "type":"string",
            "description":"Group Id or app-name as applicable for user."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        },
        "correlationId":{
            "type":"string",
            "description":"Co-relation Id for this challenge. Factor implementation should use this in call back to SP/UAS during the finishChallenge call."
        },
        "factorKey":{
            "type":"string",
            "description":"the name of the factor that is selected by end user."
        },
        "isRetry":{
            "type":"boolean",
            "description":"If this is a retry."
        },
        "successURL":{
            "type":"string",
            "description":"Resource where flow should be redirected to in case of successful challenge."
        },
        "failureURL":{
            "type":"string",
            "description":"Resource where flow should be redirected to in case of failed challenge. Most times this will be URL of the finalizerChallenge."
        },
        "timeToLiveInSec":{
            "type":"integer",
            "description":"duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated."
        },
        "abandonedChallenge":{
            "type":"boolean",
            "description":"Flag to indicate if this challenge is abandoned by user."
        },
        "factorAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserFactorAttribute"
            }
        }
    },
    "description":"Information about the user and user's registration for challenge factor."
}

Nested Schema : factorAttributes

Type: array

Show Source

• Array of: object UserFactorAttribute
  A map represented as an array of entries.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserFactorAttribute"
    }
}

Nested Schema : UserFactorAttribute

Type: object

A map represented as an array of entries.

Show Source

• userAttributeName: string
  Name of factor specific attribute for this user.
• userAttributeValue: string
  Value of factor specific attribute for this user.

{
    "required":[
        "userAttributeName|userAttributeValue"
    ],
    "type":"object",
    "properties":{
        "userAttributeName":{
            "type":"string",
            "description":"Name of factor specific attribute for this user."
        },
        "userAttributeValue":{
            "type":"string",
            "description":"Value of factor specific attribute for this user."
        }
    },
    "description":"A map represented as an array of entries."
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : UpdateAuthnResponse

Type: object

The update response object.

Show Source

• apiResponse: object StatusInfo
  Status of the fetch challenge info request. It contains the information required to process the user authentication request.
• challengecontext: object InitContext
• challengeInfo: array challengeInfo
  A user can be challenged in many ways, the object will contain all the possible ways a user can be authenticated. In case the user information is not available in the request, the Default challenge mechanism as per the service provider configuration will be present.
• challengeselectiontext: string
  Message to be displayed to select one of multiple challenges
• cookies: array cookies
  Cookies present in the user access request.
• correlationId: string
  transaction id provided by the challenge api. Also this field contains previous id used within the session to update store.
• nonce: string
  random string to identify the future request. This will change in each response and the lastest nonce is expected in the finalize call.

{
    "type":"object",
    "properties":{
        "correlationId":{
            "type":"string",
            "description":"transaction id provided by the challenge api. Also this field contains previous id used within the session to update store."
        },
        "apiResponse":{
            "$ref":"#/components/schemas/StatusInfo"
        },
        "challengeselectiontext":{
            "type":"string",
            "description":"Message to be displayed to select one of multiple challenges"
        },
        "challengeInfo":{
            "type":"array",
            "description":"A user can be challenged in many ways, the object will contain all the possible ways a user can be authenticated. In case the user information is not available in the request, the Default challenge mechanism as per the service provider configuration will be present.",
            "items":{
                "$ref":"#/components/schemas/FactorChallengeInfo"
            }
        },
        "nonce":{
            "type":"string",
            "description":"random string to identify the future request. This will change in each response and the lastest nonce is expected in the finalize call."
        },
        "challengecontext":{
            "$ref":"#/components/schemas/InitContext"
        },
        "cookies":{
            "type":"array",
            "description":"Cookies present in the user access request.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        }
    },
    "description":"The update response object."
}

Nested Schema : StatusInfo

Type: object

Status of the fetch challenge info request. It contains the information required to process the user authentication request.

Show Source

• code: integer
  Code representing the challenge status.
• message: string
  Error message generated if the server is unable to process the request.
• status(required): string
  status of the fetch challenge info for user request. It will be one of the following authenticated/pending verification/pending identification/failed/error/missing registration/challenge blocked.

{
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "description":"Code representing the challenge status."
        },
        "status":{
            "type":"string",
            "description":"status of the fetch challenge info for user request. It will be one of the following authenticated/pending verification/pending identification/failed/error/missing registration/challenge blocked."
        },
        "message":{
            "type":"string",
            "description":"Error message generated if the server is unable to process the request."
        }
    },
    "description":"Status of the fetch challenge info request. It contains the information required to process the user authentication request."
}

Nested Schema : InitContext

Type: object

Show Source

• factorAttributes: array factorAttributes
• factorKey: string
  the name of the factor that is selected by end user.
• failureURL: string
  Resource where flow should be redirected to in case of failed challenge. Most times this will be URL of the finalizerChallenge.
• groupId: string
  Group Id or app-name as applicable for user.
• requestParams: array requestParams
• successURL: string
  Resource where flow should be redirected to in case of successful challenge.
• timeToLiveInSec: integer
  duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated.
• uniqueUserId: string
  Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination.
• userId: string
  Unique identifier of the user. May be further qualified by groupId.

{
    "type":"object",
    "properties":{
        "factorKey":{
            "type":"string",
            "description":"the name of the factor that is selected by end user."
        },
        "successURL":{
            "type":"string",
            "description":"Resource where flow should be redirected to in case of successful challenge."
        },
        "failureURL":{
            "type":"string",
            "description":"Resource where flow should be redirected to in case of failed challenge. Most times this will be URL of the finalizerChallenge."
        },
        "timeToLiveInSec":{
            "type":"integer",
            "description":"duration of the blocking call when initiating blocking call. After the duration, the blocking call will be invalidated."
        },
        "factorAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserFactorAttribute"
            }
        },
        "requestParams":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KeyValPair_2"
            }
        },
        "userId":{
            "type":"string",
            "description":"Unique identifier of the user. May be further qualified by groupId."
        },
        "groupId":{
            "type":"string",
            "description":"Group Id or app-name as applicable for user."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

Nested Schema : challengeInfo

Type: array

A user can be challenged in many ways, the object will contain all the possible ways a user can be authenticated. In case the user information is not available in the request, the Default challenge mechanism as per the service provider configuration will be present.

Show Source

• Array of: object FactorChallengeInfo
  information required to process user request using the factors available to it will be present in the object.

{
    "type":"array",
    "description":"A user can be challenged in many ways, the object will contain all the possible ways a user can be authenticated. In case the user information is not available in the request, the Default challenge mechanism as per the service provider configuration will be present.",
    "items":{
        "$ref":"#/components/schemas/FactorChallengeInfo"
    }
}

Nested Schema : cookies

Type: array

Cookies present in the user access request.

Show Source

• Array of: object KeyValPair
  Key-value pair which can be used generically.

{
    "type":"array",
    "description":"Cookies present in the user access request.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

Nested Schema : factorAttributes

Type: array

Show Source

• Array of: object UserFactorAttribute
  A map represented as an array of entries.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserFactorAttribute"
    }
}

Nested Schema : requestParams

Type: array

Show Source

• Array of: object KeyValPair_2
  Key-value pair which can be used generically.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KeyValPair_2"
    }
}

Nested Schema : UserFactorAttribute

Type: object

A map represented as an array of entries.

Show Source

• userAttributeName: string
  Name of factor specific attribute for this user.
• userAttributeValue: string
  Value of factor specific attribute for this user.

{
    "required":[
        "userAttributeName|userAttributeValue"
    ],
    "type":"object",
    "properties":{
        "userAttributeName":{
            "type":"string",
            "description":"Name of factor specific attribute for this user."
        },
        "userAttributeValue":{
            "type":"string",
            "description":"Value of factor specific attribute for this user."
        }
    },
    "description":"A map represented as an array of entries."
}

Nested Schema : KeyValPair_2

Type: object

Key-value pair which can be used generically.

Show Source

• key(required): string
  Key that can be used to fetch the related value.
• value(required): object value
  Content that needs to be provided.

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"object",
            "description":"Content that needs to be provided."
        }
    },
    "description":"Key-value pair which can be used generically."
}

Nested Schema : value

Type: object

Content that needs to be provided.

Nested Schema : FactorChallengeInfo

Type: object

information required to process user request using the factors available to it will be present in the object.

Show Source

• displayOrder(required): integer
  The order of display to user when multiple factors are present
• factorContext(required): object FactorContext
  The context required by factor to process the user authentication request.
• factorKey: string
  key of the factor that can be used for registration.
• factorName(required): string
  name of the factor
• factorUrl(required): string
  URL of the factor

{
    "required":[
        "displayOrder",
        "factorContext",
        "factorName",
        "factorUrl"
    ],
    "type":"object",
    "properties":{
        "displayOrder":{
            "type":"integer",
            "description":"The order of display to user when multiple factors are present"
        },
        "factorUrl":{
            "type":"string",
            "description":"URL of the factor"
        },
        "factorName":{
            "type":"string",
            "description":"name of the factor"
        },
        "factorKey":{
            "type":"string",
            "description":"key of the factor that can be used for registration."
        },
        "factorContext":{
            "$ref":"#/components/schemas/FactorContext"
        }
    },
    "description":"information required to process user request using the factors available to it will be present in the object."
}

Nested Schema : FactorContext

Type: object

The context required by factor to process the user authentication request.

Show Source

• challengeAttrMap(required): array challengeAttrMap
• isSelected(required): boolean
  if this is the selected option as per the user preference.
• prompts(required): array prompts
  the display prompt will contain one or more prompts that can be further selected by user.
• promptselectmessage: string
  Message to select one of the challenge prompts.

{
    "required":[
        "challengeAttrMap",
        "isSelected",
        "prompts"
    ],
    "type":"object",
    "properties":{
        "promptselectmessage":{
            "type":"string",
            "description":"Message to select one of the challenge prompts."
        },
        "prompts":{
            "type":"array",
            "description":"the display prompt will contain one or more prompts that can be further selected by user.",
            "items":{
                "$ref":"#/components/schemas/Prompt"
            }
        },
        "isSelected":{
            "type":"boolean",
            "description":"if this is the selected option as per the user preference."
        },
        "challengeAttrMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FactorAttribute"
            }
        }
    },
    "description":"The context required by factor to process the user authentication request."
}

Nested Schema : challengeAttrMap

Type: array

Show Source

• Array of: object FactorAttribute
  A map represented as an array of entries.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FactorAttribute"
    }
}

Nested Schema : prompts

Type: array

the display prompt will contain one or more prompts that can be further selected by user.

Show Source

• Array of: object Prompt
  Prompt the can be displayed to end user

{
    "type":"array",
    "description":"the display prompt will contain one or more prompts that can be further selected by user.",
    "items":{
        "$ref":"#/components/schemas/Prompt"
    }
}

Nested Schema : FactorAttribute

Type: object

A map represented as an array of entries.

Show Source

• factorAttributeName: string
  Name of factor specific attribute.
• factorAttributeValue: string
  Value of factor specific attribute.
• isValidated: boolean
  If the given attribute is validated. Some attributes do not require validation hence this field is optional.
• isVerified: boolean
  is the given attribute is verified. Some attributes does not require verification hence this field is optional.

{
    "type":"object",
    "properties":{
        "factorAttributeName":{
            "type":"string",
            "description":"Name of factor specific attribute."
        },
        "factorAttributeValue":{
            "type":"string",
            "description":"Value of factor specific attribute."
        },
        "isVerified":{
            "type":"boolean",
            "description":"is the given attribute is verified. Some attributes does not require verification hence this field is optional."
        },
        "isValidated":{
            "type":"boolean",
            "description":"If the given attribute is validated. Some attributes do not require validation hence this field is optional."
        }
    },
    "description":"A map represented as an array of entries."
}

Nested Schema : Prompt

Type: object

Prompt the can be displayed to end user

Show Source

• challengeText: string
  Message to be displayed on the challenge screen.
• name: string
  friendly name of the device or the prompt.
• prompt: string
  Masked device info.
• prompttext: string
  Message string that can be displayed to end user for selection.
• requiredInputType: string
  Enumeration of none/text/radio/checkbox/textarea/waitingpage
• selected: boolean
  if this particular prompt is selected.
• validated: boolean
  if the prompt is validated
• verified: boolean
  if the prompt is verified

{
    "required":[
        "promptmessage"
    ],
    "type":"object",
    "properties":{
        "prompttext":{
            "type":"string",
            "description":"Message string that can be displayed to end user for selection."
        },
        "prompt":{
            "type":"string",
            "description":"Masked device info."
        },
        "challengeText":{
            "type":"string",
            "description":"Message to be displayed on the challenge screen."
        },
        "requiredInputType":{
            "type":"string",
            "description":"Enumeration of none/text/radio/checkbox/textarea/waitingpage"
        },
        "selected":{
            "type":"boolean",
            "description":"if this particular prompt is selected."
        },
        "name":{
            "type":"string",
            "description":"friendly name of the device or the prompt."
        },
        "verified":{
            "type":"boolean",
            "description":"if the prompt is verified"
        },
        "validated":{
            "type":"boolean",
            "description":"if the prompt is validated"
        }
    },
    "description":"Prompt the can be displayed to end user"
}

Nested Schema : KeyValPair

Type: object

Key-value pair which can be used generically.

Show Source

• key(required): string
  Key that can be used to fetch the related value.
• value(required): object value
  associated value.

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"object",
            "description":"associated value."
        }
    },
    "description":"Key-value pair which can be used generically."
}

Nested Schema : value

Type: object

associated value.

400 Response

if the update authn failed due to validation of parameters.

Body ()

Root Schema : AuthnAPIResponse

Type: object

Show Source

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

Back to Top