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

UpdateAppAuthorization

Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.

If the app authorization was in a connected state, updating the app authorization will set it back to a PendingConnect state.

Request Syntax


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

{
   "credential": { ... },
   "tenant": { 
      "tenantDisplayName": "string",
      "tenantIdentifier": "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 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.

credential

Contains credentials for the application, such as an API key or OAuth2 client ID and secret.

Specify credentials that match the authorization type of the app authorization to update. For example, if the authorization type of the app authorization is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.

Type: Credential object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

tenant

Contains information about an application tenant, such as the application display name and identifier.

Type: Tenant object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "appAuthorization": { 
      "app": "string",
      "appAuthorizationArn": "string",
      "appBundleArn": "string",
      "authType": "string",
      "authUrl": "string",
      "createdAt": "string",
      "persona": "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.

appAuthorization

Contains information about an app authorization.

Type: AppAuthorization 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