Cloud Identity-Aware Proxy API . projects . brands . identityAwareProxyClients

close()

Close httplib2 connections.

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

Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use.

Args:
  parent: string, Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a G Suite account. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains the data that describes an Identity Aware Proxy owned client.
  "displayName": "A String", # Human-friendly name given to the OAuth client.
  "name": "A String", # Output only. Unique identifier of the OAuth client.
  "secret": "A String", # Output only. Client secret of the OAuth client.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains the data that describes an Identity Aware Proxy owned client.
  "displayName": "A String", # Human-friendly name given to the OAuth client.
  "name": "A String", # Output only. Unique identifier of the OAuth client.
  "secret": "A String", # Output only. Client secret of the OAuth client.
}

delete(name, x__xgafv=None)

Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP.

Args:
  name: string, Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. (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)

Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.

Args:
  name: string, Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains the data that describes an Identity Aware Proxy owned client.
  "displayName": "A String", # Human-friendly name given to the OAuth client.
  "name": "A String", # Output only. Unique identifier of the OAuth client.
  "secret": "A String", # Output only. Client secret of the OAuth client.
}

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

Lists the existing clients for the brand.

Args:
  parent: string, Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}. (required)
  pageSize: integer, The maximum number of clients to return. The service may return fewer than this value. If unspecified, at most 100 clients will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListIdentityAwareProxyClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityAwareProxyClients` 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 ListIdentityAwareProxyClients.
  "identityAwareProxyClients": [ # Clients existing in the brand.
    { # Contains the data that describes an Identity Aware Proxy owned client.
      "displayName": "A String", # Human-friendly name given to the OAuth client.
      "name": "A String", # Output only. Unique identifier of the OAuth client.
      "secret": "A String", # Output only. Client secret of the OAuth client.
    },
  ],
  "nextPageToken": "A String", # A token, which can be send as `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.
        

resetSecret(name, body=None, x__xgafv=None)

Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.

Args:
  name: string, Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request sent to ResetIdentityAwareProxyClientSecret.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains the data that describes an Identity Aware Proxy owned client.
  "displayName": "A String", # Human-friendly name given to the OAuth client.
  "name": "A String", # Output only. Unique identifier of the OAuth client.
  "secret": "A String", # Output only. Client secret of the OAuth client.
}