delete(name, requestId=None, x__xgafv=None)

Deletes a single Authorization.

Args:
  name: string, Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization} (required)
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  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 details of a single Authorization.

Args:
  name: string, Required. Name of the resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing Authorization object
  "clientUserId": "A String", # Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
  "createTime": "A String", # Output only. [Output only] Create time stamp
  "name": "A String", # Identifier. name of resource
  "scopes": [ # Output only. The scopes actually granted by the end user during the consent flow.
    "A String",
  ],
  "state": "A String", # Output only. The state of the authorization.
  "updateTime": "A String", # Output only. [Output only] Update time stamp
}

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

Lists Authorizations in a given project and location.

Args:
  parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
  filter: string, Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=""`
  orderBy: string, Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A page token, received from a previous `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:

    { # Message for response to listing Authorizations
  "authorizations": [ # The list of Authorization
    { # Message describing Authorization object
      "clientUserId": "A String", # Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
      "createTime": "A String", # Output only. [Output only] Create time stamp
      "name": "A String", # Identifier. name of resource
      "scopes": [ # Output only. The scopes actually granted by the end user during the consent flow.
        "A String",
      ],
      "state": "A String", # Output only. The state of the authorization.
      "updateTime": "A String", # Output only. [Output only] Update time stamp
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "unreachable": [ # Unordered list. Locations that could not be reached.
    "A String",
  ],
}

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.

Agent Identity API . projects . locations . authProviders . authorizations

Instance Methods

Method Details