docs/dyn/iam_v1.projects.locations.oauthClients.credentials.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.locations.html">locations</a> . <a href="iam_v1.projects.locations.oauthClients.html">oauthClients</a> . <a href="iam_v1.projects.locations.oauthClients.credentials.html">credentials</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#close">close()</a></code></p>
 <p class="firstline">Close httplib2 connections.</p>
 <p class="toc_element">
   <code><a href="#create">create(parent, body=None, oauthClientCredentialId=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Creates a new OauthClientCredential.</p>
 <p class="toc_element">
   <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes an OauthClientCredential. Before deleting an OauthClientCredential, it should first be disabled.</p>
 <p class="toc_element">
   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets an individual OauthClientCredential.</p>
 <p class="toc_element">
   <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
 <p class="firstline">Lists all OauthClientCredentials in an OauthClient.</p>
 <p class="toc_element">
   <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Updates an existing OauthClientCredential.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="close">close()</code>
   <pre>Close httplib2 connections.</pre>
 </div>

 <div class="method">
     <code class="details" id="create">create(parent, body=None, oauthClientCredentialId=None, x__xgafv=None)</code>
   <pre>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.
   &quot;clientSecret&quot;: &quot;A String&quot;, # 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)
   &quot;disabled&quot;: True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
   &quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
   &quot;name&quot;: &quot;A String&quot;, # 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.
   &quot;clientSecret&quot;: &quot;A String&quot;, # 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)
   &quot;disabled&quot;: True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
   &quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
   &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="delete">delete(name, x__xgafv=None)</code>
   <pre>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); }
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(name, x__xgafv=None)</code>
   <pre>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.
   &quot;clientSecret&quot;: &quot;A String&quot;, # 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)
   &quot;disabled&quot;: True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
   &quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
   &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(parent, x__xgafv=None)</code>
   <pre>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.
   &quot;oauthClientCredentials&quot;: [ # 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.
       &quot;clientSecret&quot;: &quot;A String&quot;, # 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)
       &quot;disabled&quot;: True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
       &quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
       &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
     },
   ],
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
   <pre>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.
   &quot;clientSecret&quot;: &quot;A String&quot;, # 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)
   &quot;disabled&quot;: True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
   &quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
   &quot;name&quot;: &quot;A String&quot;, # 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.
   &quot;clientSecret&quot;: &quot;A String&quot;, # 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)
   &quot;disabled&quot;: True or False, # Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.
   &quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.
   &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`
 }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.locations.html">locations</a> . <a href="iam_v1.projects.locations.oauthClients.html">oauthClients</a> . <a href="iam_v1.projects.locations.oauthClients.credentials.html">credentials</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#close">close()</a></code></p>
	<p class="firstline">Close httplib2 connections.</p>
	<p class="toc_element">
	<code><a href="#create">create(parent, body=None, oauthClientCredentialId=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Creates a new OauthClientCredential.</p>
	<p class="toc_element">
	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Deletes an OauthClientCredential. Before deleting an OauthClientCredential, it should first be disabled.</p>
	<p class="toc_element">
	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Gets an individual OauthClientCredential.</p>
	<p class="toc_element">
	<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
	<p class="firstline">Lists all OauthClientCredentials in an OauthClient.</p>
	<p class="toc_element">
	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Updates an existing OauthClientCredential.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="close">close()</code>
	<pre>Close httplib2 connections.</pre>
	</div>

	<div class="method">
	<code class="details" id="create">create(parent, body=None, oauthClientCredentialId=None, x__xgafv=None)</code>
	<pre>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}`
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
	<pre>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); }
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="get">get(name, x__xgafv=None)</code>
	<pre>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}`
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(parent, x__xgafv=None)</code>
	<pre>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}`
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
	<pre>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}`
	}</pre>
	</div>

	</body></html>