GetConnectorDestination - Managed integrations
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetConnectorDestination

Get connector destination details linked to a cloud-to-cloud (C2C) connector.

Request Syntax

GET /connector-destinations/Identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identifier

The identifier of the C2C connector destination.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9-_]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "AuthConfig": { 
      "oAuth": { 
         "authUrl": "string",
         "oAuthCompleteRedirectUrl": "string",
         "proactiveRefreshTokenRenewal": { 
            "DaysBeforeRenewal": number,
            "enabled": boolean
         },
         "scope": "string",
         "tokenEndpointAuthenticationScheme": "string",
         "tokenUrl": "string"
      }
   },
   "AuthType": "string",
   "CloudConnectorId": "string",
   "Description": "string",
   "Id": "string",
   "Name": "string",
   "OAuthCompleteRedirectUrl": "string",
   "SecretsManager": { 
      "arn": "string",
      "versionId": "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.

AuthConfig

The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.

Type: AuthConfig object

AuthType

The authentication type used for the connector destination, which determines how credentials and access are managed.

Type: String

Valid Values: OAUTH

CloudConnectorId

The identifier of the C2C connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9-_]+

Description

A description of the connector destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [0-9A-Za-z_\- ]+

Id

The unique identifier of the connector destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9-_]+

Name

The display name of the connector destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9-_ ]+

OAuthCompleteRedirectUrl

The URL where users are redirected after completing the OAuth authorization process for the connector destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: (http|https)://.*

SecretsManager

The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.

Type: SecretsManager object

Errors

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

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: