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

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 OauthClientCredential in. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.
  "clientSecret": "A String", # Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth client and credential security risks and mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security)
  "disabled": True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}

  oauthClientCredentialId: string, Required. The ID to use for the OauthClientCredential, 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 OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.
  "clientSecret": "A String", # Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth client and credential security risks and mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security)
  "disabled": True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}

delete(name, x__xgafv=None)

Deletes an OauthClientCredential. Before deleting an OauthClientCredential, it should first be disabled.

Args:
  name: string, Required. The name of the OauthClientCredential 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 OauthClientCredential 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 OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.
  "clientSecret": "A String", # Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth client and credential security risks and mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security)
  "disabled": True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}

list(parent, x__xgafv=None)

Lists all OauthClientCredentials in an OauthClient.

Args:
  parent: string, Required. The parent to list OauthClientCredentials 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 OauthClientCredentials.
    { # Represents an OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.
      "clientSecret": "A String", # Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth client and credential security risks and mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security)
      "disabled": True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
      "displayName": "A String", # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
      "name": "A String", # Immutable. Identifier. The resource name of the OauthClientCredential. 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. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.
  "clientSecret": "A String", # Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth client and credential security risks and mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security)
  "disabled": True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClientCredential. 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 OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.
  "clientSecret": "A String", # Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth client and credential security risks and mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security)
  "disabled": True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
  "displayName": "A String", # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
  "name": "A String", # Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
}