GoogleApi.Apigee.V1.Api.Organizations.apigee_organizations_set_sync_authorization

You're seeing just the function apigee_organizations_set_sync_authorization, go back to GoogleApi.Apigee.V1.Api.Organizations module for more information.
Link to this function

apigee_organizations_set_sync_authorization(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

apigee_organizations_set_sync_authorization(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SyncAuthorization.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SyncAuthorization.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SyncAuthorization{}} on success
  • {:error, info} on failure