Authorizing a Resource Aggregator Account_Resource Aggregators_APIs_API Reference (Kuala Lumpur Region)

Function

This API is used to authorize a resource aggregator account to collect data from source accounts.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/resource-manager/domains/{domain_id}/aggregators/aggregation-authorization

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies tags. Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
authorized_account_id	Yes	String	Specifies the ID of the resource aggregator account to be authorized. Minimum: 1 Maximum: 36

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
aggregation_authorization_urn	String	Specifies the authorization identifier of the resource aggregator account.
authorized_account_id	String	Specifies the ID of the authorized resource aggregator account.
created_at	String	Specifies the time when the resource aggregator account was authorized.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Authorizing a resource aggregator account

PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/aggregation-authorization

{
  "authorized_account_id" : "3fd23817bd85480e8dc4f520075de348"
}

Example Responses

Status code: 200

Operation succeeded.

{
  "aggregation_authorization_urn" : "rms::e74e043fab784a45ad88f5ef6a4bcffc:aggregationAuthorization:fb51a91e798a4beb831c9be365aba4db",
  "authorized_account_id" : "3fd23817bd85480e8dc4f520075de348",
  "created_at" : "2020-01-18T02:49:12.465Z"
}

Status Codes

Status Code	Description
200	Operation succeeded.
400	Invalid parameters.
403	Authentication failed or you do not have the operation permissions.
500	Server error.

Error Codes

See Error Codes.

Authorizing a Resource Aggregator Account