| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.apiproducts.html">apiproducts()</a></code> |
| </p> |
| <p class="firstline">Returns the apiproducts Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.apis.html">apis()</a></code> |
| </p> |
| <p class="firstline">Returns the apis Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.apps.html">apps()</a></code> |
| </p> |
| <p class="firstline">Returns the apps Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.deployments.html">deployments()</a></code> |
| </p> |
| <p class="firstline">Returns the deployments Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.developers.html">developers()</a></code> |
| </p> |
| <p class="firstline">Returns the developers Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.environments.html">environments()</a></code> |
| </p> |
| <p class="firstline">Returns the environments Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.keyvaluemaps.html">keyvaluemaps()</a></code> |
| </p> |
| <p class="firstline">Returns the keyvaluemaps Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.operations.html">operations()</a></code> |
| </p> |
| <p class="firstline">Returns the operations Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.reports.html">reports()</a></code> |
| </p> |
| <p class="firstline">Returns the reports Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="apigee_v1.organizations.sharedflows.html">sharedflows()</a></code> |
| </p> |
| <p class="firstline">Returns the sharedflows Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#create">create(body=None, parent=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates an Apigee organization. See</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the profile for an Apigee organization.</p> |
| <p class="toc_element"> |
| <code><a href="#getSyncAuthorization">getSyncAuthorization(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the service accounts with the permissions required to allow</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the Apigee organizations and associated GCP projects that you have</p> |
| <p class="toc_element"> |
| <code><a href="#setSyncAuthorization">setSyncAuthorization(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the permissions required to allow the Synchronizer to download</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the properties for an Apigee organization. No other fields in the</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(body=None, parent=None, x__xgafv=None)</code> |
| <pre>Creates an Apigee organization. See |
| [Create an |
| organization](https://docs.apigee.com/hybrid/latest/precog-provision). |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds |
| # since epoch. |
| "createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch. |
| "properties": { # Message for compatibility with legacy Edge specification for Java Properties # Properties defined in the Apigee organization profile. |
| # object in JSON. |
| "property": [ # List of all properties in the object |
| { # A single property entry in the Properties message. |
| "value": "A String", # The property value |
| "name": "A String", # The property key |
| }, |
| ], |
| }, |
| "analyticsRegion": "A String", # Required. Primary GCP region for analytics data storage. For valid values, see |
| # [Create an |
| # organization](https://docs.apigee.com/hybrid/latest/precog-provision). |
| "displayName": "A String", |
| "subscriptionType": "A String", # Output only. Subscription type of the Apigee organization. Valid values include trial |
| # (free, limited, and for evaluation purposes only) or paid (full |
| # subscription has been purchased). See |
| # [Apigee pricing](https://cloud.google.com/apigee/pricing/). |
| "environments": [ # Output only. List of environments in the Apigee organization. |
| "A String", |
| ], |
| "customerName": "A String", # Not used by Apigee. |
| "runtimeType": "A String", # Output only. Runtime type of the Apigee organization based on the Apigee subscription |
| # purchased. |
| "name": "A String", # Output only. Name of the Apigee organization. |
| "type": "A String", # Not used by Apigee. |
| "attributes": [ # Not used by Apigee. |
| "A String", |
| ], |
| "description": "A String", # Description of the Apigee organization. |
| } |
| |
| parent: string, Required. Name of the GCP project in which to associate the Apigee organization. |
| Pass the information as a query parameter using the following structure |
| in your request: |
| `projects/<project>` |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets the profile for an Apigee organization. |
| See |
| [Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations). |
| |
| Args: |
| name: string, Required. Apigee organization name in the following format: |
| `organizations/{org}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds |
| # since epoch. |
| "createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch. |
| "properties": { # Message for compatibility with legacy Edge specification for Java Properties # Properties defined in the Apigee organization profile. |
| # object in JSON. |
| "property": [ # List of all properties in the object |
| { # A single property entry in the Properties message. |
| "value": "A String", # The property value |
| "name": "A String", # The property key |
| }, |
| ], |
| }, |
| "analyticsRegion": "A String", # Required. Primary GCP region for analytics data storage. For valid values, see |
| # [Create an |
| # organization](https://docs.apigee.com/hybrid/latest/precog-provision). |
| "displayName": "A String", |
| "subscriptionType": "A String", # Output only. Subscription type of the Apigee organization. Valid values include trial |
| # (free, limited, and for evaluation purposes only) or paid (full |
| # subscription has been purchased). See |
| # [Apigee pricing](https://cloud.google.com/apigee/pricing/). |
| "environments": [ # Output only. List of environments in the Apigee organization. |
| "A String", |
| ], |
| "customerName": "A String", # Not used by Apigee. |
| "runtimeType": "A String", # Output only. Runtime type of the Apigee organization based on the Apigee subscription |
| # purchased. |
| "name": "A String", # Output only. Name of the Apigee organization. |
| "type": "A String", # Not used by Apigee. |
| "attributes": [ # Not used by Apigee. |
| "A String", |
| ], |
| "description": "A String", # Description of the Apigee organization. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getSyncAuthorization">getSyncAuthorization(name, body=None, x__xgafv=None)</code> |
| <pre>Lists the service accounts with the permissions required to allow |
| the Synchronizer to download environment data from the control plane. |
| |
| An ETag is returned in the response to `getSyncAuthorization`. |
| Pass that ETag when calling [setSyncAuthorization](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. |
| |
| For more information, see |
| [Enable Synchronizer |
| access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access). |
| |
| **Note**: Available to Apigee hybrid only. |
| |
| Args: |
| name: string, Required. Name of the Apigee organization. Use the following structure in your |
| request: |
| `organizations/{org}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for |
| # GetSyncAuthorization. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "identities": [ # Required. Array of service accounts to grant access to control plane |
| # resources, each specified using the following |
| # format: `serviceAccount:`<var>service-account-name</var>. |
| # |
| # The <var>service-account-name</var> 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](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service-accounts). |
| "A String", |
| ], |
| "etag": "A String", # 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](getSyncAuthorization) |
| # an ETag is returned in the response. Pass that ETag when calling |
| # the [setSyncAuthorization](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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, x__xgafv=None)</code> |
| <pre>Lists the Apigee organizations and associated GCP projects that you have |
| permission to access. See |
| [Organizations](https://docs.apigee.com/hybrid/latest/terminology#organizations). |
| |
| Args: |
| parent: string, Required. Use the following structure in your request: |
| `organizations` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "organizations": [ # List of Apigee organizations and associated GCP projects. |
| { |
| "projectIds": [ # List of GCP projects associated with the Apigee organization. |
| "A String", |
| ], |
| "organization": "A String", # Name of the Apigee organization. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setSyncAuthorization">setSyncAuthorization(name, body=None, x__xgafv=None)</code> |
| <pre>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](getSyncAuthorization). |
| If you don't pass the ETag in the call to `setSyncAuthorization`, then the |
| existing authorization is overwritten indiscriminately. |
| |
| For more information, see |
| [Enable Synchronizer |
| access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access). |
| |
| **Note**: Available to Apigee hybrid only. |
| |
| Args: |
| name: string, Required. Name of the Apigee organization. Use the following structure in your |
| request: |
| `organizations/{org}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "identities": [ # Required. Array of service accounts to grant access to control plane |
| # resources, each specified using the following |
| # format: `serviceAccount:`<var>service-account-name</var>. |
| # |
| # The <var>service-account-name</var> 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](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service-accounts). |
| "A String", |
| ], |
| "etag": "A String", # 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](getSyncAuthorization) |
| # an ETag is returned in the response. Pass that ETag when calling |
| # the [setSyncAuthorization](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. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "identities": [ # Required. Array of service accounts to grant access to control plane |
| # resources, each specified using the following |
| # format: `serviceAccount:`<var>service-account-name</var>. |
| # |
| # The <var>service-account-name</var> 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](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service-accounts). |
| "A String", |
| ], |
| "etag": "A String", # 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](getSyncAuthorization) |
| # an ETag is returned in the response. Pass that ETag when calling |
| # the [setSyncAuthorization](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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> |
| <pre>Updates the properties for an Apigee organization. No other fields in the |
| organization profile will be updated. |
| |
| Args: |
| name: string, Required. Apigee organization name in the following format: |
| `organizations/{org}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds |
| # since epoch. |
| "createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch. |
| "properties": { # Message for compatibility with legacy Edge specification for Java Properties # Properties defined in the Apigee organization profile. |
| # object in JSON. |
| "property": [ # List of all properties in the object |
| { # A single property entry in the Properties message. |
| "value": "A String", # The property value |
| "name": "A String", # The property key |
| }, |
| ], |
| }, |
| "analyticsRegion": "A String", # Required. Primary GCP region for analytics data storage. For valid values, see |
| # [Create an |
| # organization](https://docs.apigee.com/hybrid/latest/precog-provision). |
| "displayName": "A String", |
| "subscriptionType": "A String", # Output only. Subscription type of the Apigee organization. Valid values include trial |
| # (free, limited, and for evaluation purposes only) or paid (full |
| # subscription has been purchased). See |
| # [Apigee pricing](https://cloud.google.com/apigee/pricing/). |
| "environments": [ # Output only. List of environments in the Apigee organization. |
| "A String", |
| ], |
| "customerName": "A String", # Not used by Apigee. |
| "runtimeType": "A String", # Output only. Runtime type of the Apigee organization based on the Apigee subscription |
| # purchased. |
| "name": "A String", # Output only. Name of the Apigee organization. |
| "type": "A String", # Not used by Apigee. |
| "attributes": [ # Not used by Apigee. |
| "A String", |
| ], |
| "description": "A String", # Description of the Apigee organization. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds |
| # since epoch. |
| "createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch. |
| "properties": { # Message for compatibility with legacy Edge specification for Java Properties # Properties defined in the Apigee organization profile. |
| # object in JSON. |
| "property": [ # List of all properties in the object |
| { # A single property entry in the Properties message. |
| "value": "A String", # The property value |
| "name": "A String", # The property key |
| }, |
| ], |
| }, |
| "analyticsRegion": "A String", # Required. Primary GCP region for analytics data storage. For valid values, see |
| # [Create an |
| # organization](https://docs.apigee.com/hybrid/latest/precog-provision). |
| "displayName": "A String", |
| "subscriptionType": "A String", # Output only. Subscription type of the Apigee organization. Valid values include trial |
| # (free, limited, and for evaluation purposes only) or paid (full |
| # subscription has been purchased). See |
| # [Apigee pricing](https://cloud.google.com/apigee/pricing/). |
| "environments": [ # Output only. List of environments in the Apigee organization. |
| "A String", |
| ], |
| "customerName": "A String", # Not used by Apigee. |
| "runtimeType": "A String", # Output only. Runtime type of the Apigee organization based on the Apigee subscription |
| # purchased. |
| "name": "A String", # Output only. Name of the Apigee organization. |
| "type": "A String", # Not used by Apigee. |
| "attributes": [ # Not used by Apigee. |
| "A String", |
| ], |
| "description": "A String", # Description of the Apigee organization. |
| }</pre> |
| </div> |
| |
| </body></html> |
