Creates a new OauthClient. You cannot reuse the name of a deleted OauthClient until 30 days after deletion.

Deletes an OauthClient. You cannot use a deleted OauthClient. However, deletion does not revoke access tokens that have already been issued. They continue to grant access. Deletion does revoke refresh tokens that have already been issued. They cannot be used to renew an access token. If the OauthClient is undeleted, and the refresh tokens are not expired, they are valid for token exchange again. You can undelete an OauthClient for 30 days. After 30 days, deletion is permanent. You cannot update deleted OauthClients. However, you can view and list them.

Lists all non-deleted OauthClients in a project. If `show_deleted` is set to `true`, then deleted OauthClients are also listed.

Method Details

close()

Close httplib2 connections.

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

Creates a new OauthClient. You cannot reuse the name of a deleted OauthClient until 30 days after deletion.

Args:
  parent: string, Required. The parent resource to create the OauthClient in. The only supported location is `global`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
  "allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
    "A String",
  ],
  "allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
    "A String",
  ],
  "allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    "A String",
  ],
  "clientId": "A String", # Output only. The system-generated OauthClient id.
  "clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
  "description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
  "disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
  "expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
  "state": "A String", # Output only. The state of the OauthClient.
}

  oauthClientId: string, Required. The ID to use for the OauthClient, which becomes the final component of the resource name. This value should be a string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
  "allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
    "A String",
  ],
  "allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
    "A String",
  ],
  "allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    "A String",
  ],
  "clientId": "A String", # Output only. The system-generated OauthClient id.
  "clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
  "description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
  "disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
  "expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
  "state": "A String", # Output only. The state of the OauthClient.
}

delete(name, x__xgafv=None)

Args:
name: string, Required. The name of the OauthClient to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
}

get(name, x__xgafv=None)

Gets an individual OauthClient.

Args:
  name: string, Required. The name of the OauthClient to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
  "allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
    "A String",
  ],
  "allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
    "A String",
  ],
  "allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    "A String",
  ],
  "clientId": "A String", # Output only. The system-generated OauthClient id.
  "clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
  "description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
  "disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
  "expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
  "state": "A String", # Output only. The state of the OauthClient.
}

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

Lists all non-deleted OauthClients in a project. If `show_deleted` is set to `true`, then deleted OauthClients are also listed.

Args:
  parent: string, Required. The parent to list OauthClients for. (required)
  pageSize: integer, Optional. The maximum number of OauthClients to return. If unspecified, at most 50 OauthClients will be returned. The maximum value is 100; values above 100 are truncated to 100.
  pageToken: string, Optional. A page token, received from a previous `ListOauthClients` call. Provide this to retrieve the subsequent page.
  showDeleted: boolean, Optional. Whether to return soft-deleted OauthClients.
  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 ListOauthClients.
  "nextPageToken": "A String", # Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "oauthClients": [ # A list of OauthClients.
    { # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
      "allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
        "A String",
      ],
      "allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
        "A String",
      ],
      "allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
        "A String",
      ],
      "clientId": "A String", # Output only. The system-generated OauthClient id.
      "clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
      "description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
      "disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
      "displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
      "expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
      "name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
      "state": "A String", # Output only. The state of the OauthClient.
    },
  ],
}

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 existing OauthClient.

Args:
  name: string, Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
  "allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
    "A String",
  ],
  "allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
    "A String",
  ],
  "allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    "A String",
  ],
  "clientId": "A String", # Output only. The system-generated OauthClient id.
  "clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
  "description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
  "disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
  "expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
  "state": "A String", # Output only. The state of the OauthClient.
}

  updateMask: string, Required. 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:

    { # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
  "allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
    "A String",
  ],
  "allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
    "A String",
  ],
  "allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    "A String",
  ],
  "clientId": "A String", # Output only. The system-generated OauthClient id.
  "clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
  "description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
  "disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
  "expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
  "state": "A String", # Output only. The state of the OauthClient.
}

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

Undeletes an OauthClient, as long as it was deleted fewer than 30 days ago.

Args:
  name: string, Required. The name of the OauthClient to undelete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for UndeleteOauthClient.
}

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

Returns:
  An object of the form:

    { # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
  "allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
    "A String",
  ],
  "allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
    "A String",
  ],
  "allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    "A String",
  ],
  "clientId": "A String", # Output only. The system-generated OauthClient id.
  "clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
  "description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
  "disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
  "expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
  "state": "A String", # Output only. The state of the OauthClient.
}

Identity and Access Management (IAM) API . projects . locations . oauthClients

Instance Methods

Method Details