Update Participant Authentication

connect_update_participant_authentication

R Documentation

Instructs Amazon Connect to resume the authentication process¶

Description¶

Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:

If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.
If an error is provided: The error branch of the Authenticate Customer block is executed.

The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.

Usage¶

connect_update_participant_authentication(State, InstanceId, Code,
  Error, ErrorDescription)

Arguments¶

State: [required] The state query parameter that was provided by Cognito in the redirectUri. This will also match the state parameter provided in the AuthenticationUrl from the GetAuthenticationUrl response.
InstanceId: [required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Code: The code query parameter provided by Cognito in the redirectUri.
Error: The error query parameter provided by Cognito in the redirectUri.
ErrorDescription: The error_description parameter provided by Cognito in the redirectUri.

Value¶

An empty list.

Request syntax¶

svc$update_participant_authentication(
  State = "string",
  InstanceId = "string",
  Code = "string",
  Error = "string",
  ErrorDescription = "string"
)