Method: organizations.setSyncAuthorization

Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid.

Pass the ETag when calling setSyncAuthorization to ensure that you are updating the correct version. To get an ETag, call getSyncAuthorization. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately.

For more information, see Configure the Synchronizer.

Note: Available to Apigee hybrid only.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}

Authorization requires the following IAM permission on the specified resource name:

  • apigee.organizations.update

Request body

The request body contains an instance of SyncAuthorization.

Response body

If successful, the response body contains an instance of SyncAuthorization.

Authorization scopes

Requires the following OAuth scope: