| <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="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.authorizations.html">authorizations</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(parent, authorizationId=None, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates an Authorization.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes an Authorization.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets an Authorization.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists all Authorizations under an Engine.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates an Authorization</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="create">create(parent, authorizationId=None, body=None, x__xgafv=None)</code> | |
| <pre>Creates an Authorization. | |
| Args: | |
| parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}` (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Discovery Engine Authorization resource. | |
| "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters. | |
| "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. | |
| "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration. | |
| "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend. | |
| "basicAuthenticationEnabled": True or False, # Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used. | |
| "clientId": "A String", # Required. The OAuth2 client ID. | |
| "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. | |
| "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ | |
| "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. | |
| "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. | |
| }, | |
| "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. | |
| "A String", | |
| ], | |
| "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. | |
| }, | |
| } | |
| authorizationId: string, Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Discovery Engine Authorization resource. | |
| "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters. | |
| "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. | |
| "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration. | |
| "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend. | |
| "basicAuthenticationEnabled": True or False, # Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used. | |
| "clientId": "A String", # Required. The OAuth2 client ID. | |
| "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. | |
| "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ | |
| "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. | |
| "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. | |
| }, | |
| "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. | |
| "A String", | |
| ], | |
| "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> | |
| <pre>Deletes an Authorization. | |
| Args: | |
| name: string, Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>Gets an Authorization. | |
| Args: | |
| name: string, Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Discovery Engine Authorization resource. | |
| "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters. | |
| "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. | |
| "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration. | |
| "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend. | |
| "basicAuthenticationEnabled": True or False, # Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used. | |
| "clientId": "A String", # Required. The OAuth2 client ID. | |
| "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. | |
| "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ | |
| "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. | |
| "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. | |
| }, | |
| "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. | |
| "A String", | |
| ], | |
| "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Lists all Authorizations under an Engine. | |
| Args: | |
| parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}` (required) | |
| pageSize: integer, Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. | |
| pageToken: string, A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response message for the AuthorizationService.ListAuthorizations method. | |
| "authorizations": [ # All the customer's Authorizations. | |
| { # Discovery Engine Authorization resource. | |
| "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters. | |
| "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. | |
| "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration. | |
| "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend. | |
| "basicAuthenticationEnabled": True or False, # Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used. | |
| "clientId": "A String", # Required. The OAuth2 client ID. | |
| "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. | |
| "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ | |
| "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. | |
| "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. | |
| }, | |
| "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. | |
| "A String", | |
| ], | |
| "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. | |
| }, | |
| }, | |
| ], | |
| "nextPageToken": "A String", # A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> | |
| <pre>Updates an Authorization | |
| Args: | |
| name: string, Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Discovery Engine Authorization resource. | |
| "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters. | |
| "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. | |
| "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration. | |
| "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend. | |
| "basicAuthenticationEnabled": True or False, # Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used. | |
| "clientId": "A String", # Required. The OAuth2 client ID. | |
| "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. | |
| "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ | |
| "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. | |
| "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. | |
| }, | |
| "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. | |
| "A String", | |
| ], | |
| "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. | |
| }, | |
| } | |
| updateMask: string, The list of fields to update. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Discovery Engine Authorization resource. | |
| "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters. | |
| "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. | |
| "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration. | |
| "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend. | |
| "basicAuthenticationEnabled": True or False, # Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used. | |
| "clientId": "A String", # Required. The OAuth2 client ID. | |
| "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. | |
| "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ | |
| "privateNetworkConfig": { # Identifies the instance hosting an OAuth provider that is reachable only over a private network. # Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. | |
| "instanceResource": "A String", # Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. | |
| }, | |
| "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. | |
| "A String", | |
| ], | |
| "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |