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

ConnectAppAuthorization

Establishes a connection between AWS AppFabric and an application, which allows AppFabric to call the APIs of the application.

Request Syntax


POST /appbundles/appBundleIdentifier/appauthorizations/appAuthorizationIdentifier/connect HTTP/1.1
Content-type: application/json

{
   "authRequest": { 
      "code": "string",
      "redirectUri": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

appAuthorizationIdentifier

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.

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

Pattern: arn:.+$|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

appBundleIdentifier

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request.

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

Pattern: arn:.+$|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

authRequest

Contains OAuth2 authorization information.

This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.

Type: AuthRequest object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "appAuthorizationSummary": { 
      "app": "string",
      "appAuthorizationArn": "string",
      "appBundleArn": "string",
      "status": "string",
      "tenant": { 
         "tenantDisplayName": "string",
         "tenantIdentifier": "string"
      },
      "updatedAt": "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.

appAuthorizationSummary

Contains a summary of the app authorization.

Type: AppAuthorizationSummary object

Errors

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

AccessDeniedException

You are not authorized to perform this operation.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request rate exceeds the limit.

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400