StartAccountAssociationRefresh

Initiates a refresh of an existing account association to update its authorization and connection status.

Request Syntax


POST /account-associations/AccountAssociationId/refresh HTTP/1.1

The request uses the following URI parameters.

The unique identifier of the account association to refresh.

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

Pattern: [0-9a-zA-Z]+

Required: Yes

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

{
   "OAuthAuthorizationUrl": "string"
}

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

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

Third-party IoT platform OAuth authorization server URL with all required parameters to perform end-user authentication during the refresh process.

Type: String

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

Pattern: (https)://.*

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

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400