Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ConnectorRegistrationsV2

Grants permission to complete the authorization based on input parameters. This API is in preview release and subject to change.

Request Syntax


POST /connectorsv2/registrations HTTP/1.1
Content-type: application/json

{
   "AuthCode": "string",
   "AuthState": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AuthCode

The authCode retrieved from authUrl to complete the OAuth 2.0 authorization code flow.

Type: String

Pattern: .*\S.*

Required: Yes

AuthState

The authState retrieved from authUrl to complete the OAuth 2.0 authorization code flow.

Type: String

Pattern: .*\S.*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConnectorArn": "string",
   "ConnectorId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConnectorArn

The Amazon Resource Name (ARN) of the connectorV2.

Type: String

Pattern: .*\S.*

ConnectorId

The UUID of the connectorV2 to identify connectorV2 resource.

Type: String

Pattern: .*\S.*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

ConflictException

The request causes conflict with the current state of the service resource.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400