Discovery Engine API . projects . locations . authorizations

close()

Close httplib2 connections.

create(parent, authorizationId=None, body=None, x__xgafv=None)

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.
    "clientId": "A String", # Required. The OAuth2 client ID.
    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
      "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.
    "clientId": "A String", # Required. The OAuth2 client ID.
    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
      "A String",
    ],
    "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
  },
}

delete(name, x__xgafv=None)

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); }
}

get(name, x__xgafv=None)

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.
    "clientId": "A String", # Required. The OAuth2 client ID.
    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
      "A String",
    ],
    "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
  },
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

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.
        "clientId": "A String", # Required. The OAuth2 client ID.
        "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
        "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
          "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.
}

list_next()

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.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

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.
    "clientId": "A String", # Required. The OAuth2 client ID.
    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
      "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.
    "clientId": "A String", # Required. The OAuth2 client ID.
    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
      "A String",
    ],
    "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
  },
}