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

Instance Methods

close()

Close httplib2 connections.

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

Creates a new OauthClientCredential.

delete(name, x__xgafv=None)

Deletes a OauthClientCredential. Before deleting an oauth client credential, it should first be disabled.

get(name, x__xgafv=None)

Gets an individual OauthClientCredential.

list(parent, x__xgafv=None)

Lists all OauthClientCredentialss in a OauthClient.

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

Updates an existing OauthClientCredential.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, oauthClientCredentialId=None, x__xgafv=None)
Creates a new OauthClientCredential.

Args:
  parent: string, Required. The parent resource to create the oauth client Credential in. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an oauth client credential. Used to authenticate an oauth client while accessing Google Cloud resources on behalf of a user by using OAuth2 Protocol.
  "clientSecret": "A String", # Output only. The system-generated oauth client secret.
  "disabled": True or False, # Optional. Whether the oauth client credential is disabled. You cannot use a disabled oauth client credential for OAuth.
  "displayName": "A String", # Optional. A user-specified display name of the oauth client credential Cannot exceed 32 characters.
  "name": "A String", # Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}

  oauthClientCredentialId: string, Required. The ID to use for the oauth client credential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. 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 oauth client credential. Used to authenticate an oauth client while accessing Google Cloud resources on behalf of a user by using OAuth2 Protocol.
  "clientSecret": "A String", # Output only. The system-generated oauth client secret.
  "disabled": True or False, # Optional. Whether the oauth client credential is disabled. You cannot use a disabled oauth client credential for OAuth.
  "displayName": "A String", # Optional. A user-specified display name of the oauth client credential Cannot exceed 32 characters.
  "name": "A String", # Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}
delete(name, x__xgafv=None)
Deletes a OauthClientCredential. Before deleting an oauth client credential, it should first be disabled.

Args:
  name: string, Required. The name of the oauth client credential to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`. (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 individual OauthClientCredential.

Args:
  name: string, Required. The name of the oauth client credential to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`. (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 oauth client credential. Used to authenticate an oauth client while accessing Google Cloud resources on behalf of a user by using OAuth2 Protocol.
  "clientSecret": "A String", # Output only. The system-generated oauth client secret.
  "disabled": True or False, # Optional. Whether the oauth client credential is disabled. You cannot use a disabled oauth client credential for OAuth.
  "displayName": "A String", # Optional. A user-specified display name of the oauth client credential Cannot exceed 32 characters.
  "name": "A String", # Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}
list(parent, x__xgafv=None)
Lists all OauthClientCredentialss in a OauthClient.

Args:
  parent: string, Required. The parent to list oauth client credentials for. (required)
  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 ListOauthClientCredentials.
  "oauthClientCredentials": [ # A list of oauth client credentials.
    { # Represents an oauth client credential. Used to authenticate an oauth client while accessing Google Cloud resources on behalf of a user by using OAuth2 Protocol.
      "clientSecret": "A String", # Output only. The system-generated oauth client secret.
      "disabled": True or False, # Optional. Whether the oauth client credential is disabled. You cannot use a disabled oauth client credential for OAuth.
      "displayName": "A String", # Optional. A user-specified display name of the oauth client credential Cannot exceed 32 characters.
      "name": "A String", # Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
    },
  ],
}
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an existing OauthClientCredential.

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

{ # Represents an oauth client credential. Used to authenticate an oauth client while accessing Google Cloud resources on behalf of a user by using OAuth2 Protocol.
  "clientSecret": "A String", # Output only. The system-generated oauth client secret.
  "disabled": True or False, # Optional. Whether the oauth client credential is disabled. You cannot use a disabled oauth client credential for OAuth.
  "displayName": "A String", # Optional. A user-specified display name of the oauth client credential Cannot exceed 32 characters.
  "name": "A String", # Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}

  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 oauth client credential. Used to authenticate an oauth client while accessing Google Cloud resources on behalf of a user by using OAuth2 Protocol.
  "clientSecret": "A String", # Output only. The system-generated oauth client secret.
  "disabled": True or False, # Optional. Whether the oauth client credential is disabled. You cannot use a disabled oauth client credential for OAuth.
  "displayName": "A String", # Optional. A user-specified display name of the oauth client credential Cannot exceed 32 characters.
  "name": "A String", # Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}