Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

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.

post/v1/{+name}:setSyncAuthorization

Path parameters

namestring required

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

Request body

identitiesstring[]

Required. Array of service accounts to grant access to control plane resources, each specified using the following format: serviceAccount: service-account-name. The service-account-name is formatted like an email address. For example: my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have Apigee Synchronizer Manager role. See also Create service accounts.

etagstring byte

Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call getSyncAuthorization an ETag is returned in the response. Pass that ETag when calling the setSyncAuthorization to ensure that you are updating the correct version. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. Note: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions.

Response

Successful response