docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html b/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
index b279466..430c48a 100644
--- a/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
+++ b/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
@@ -100,11 +100,13 @@
The object takes the form of:
{
- "lifetime": "A String", # The desired lifetime duration of the access token in seconds.
- # Must be set to a value less than or equal to 3600 (1 hour). If a value is
- # not specified, the token's lifetime will be set to a default value of one
- # hour.
- "delegates": [ # The sequence of service accounts in a delegation chain. Each service
+ "scope": [ # Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
+ # See https://developers.google.com/identity/protocols/googlescopes for more
+ # information.
+ # At least one value required.
+ "A String",
+ ],
+ "delegates": [ # The sequence of service accounts in a delegation chain. Each service
# account must be granted the `roles/iam.serviceAccountTokenCreator` role
# on its next service account in the chain. The last service account in the
# chain must be granted the `roles/iam.serviceAccountTokenCreator` role
@@ -114,14 +116,12 @@
# The delegates must have the following format:
# `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
# character is required; replacing it with a project ID is invalid.
- "A String",
+ "A String",
],
- "scope": [ # Required. Code to identify the scopes to be included in the OAuth 2.0 access token.
- # See https://developers.google.com/identity/protocols/googlescopes for more
- # information.
- # At least one value required.
- "A String",
- ],
+ "lifetime": "A String", # The desired lifetime duration of the access token in seconds.
+ # Must be set to a value less than or equal to 3600 (1 hour). If a value is
+ # not specified, the token's lifetime will be set to a default value of one
+ # hour.
}
x__xgafv: string, V1 error format.
@@ -133,9 +133,9 @@
An object of the form:
{
- "expireTime": "A String", # Token expiration time.
+ "expireTime": "A String", # Token expiration time.
# The expiration time is always set.
- "accessToken": "A String", # The OAuth 2.0 access token.
+ "accessToken": "A String", # The OAuth 2.0 access token.
}</pre>
</div>
@@ -152,11 +152,7 @@
The object takes the form of:
{
- "includeEmail": True or False, # Include the service account email in the token. If set to `true`, the
- # token will contain `email` and `email_verified` claims.
- "audience": "A String", # Required. The audience for the token, such as the API or account that this token
- # grants access to.
- "delegates": [ # The sequence of service accounts in a delegation chain. Each service
+ "delegates": [ # The sequence of service accounts in a delegation chain. Each service
# account must be granted the `roles/iam.serviceAccountTokenCreator` role
# on its next service account in the chain. The last service account in the
# chain must be granted the `roles/iam.serviceAccountTokenCreator` role
@@ -166,8 +162,12 @@
# The delegates must have the following format:
# `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
# character is required; replacing it with a project ID is invalid.
- "A String",
+ "A String",
],
+ "audience": "A String", # Required. The audience for the token, such as the API or account that this token
+ # grants access to.
+ "includeEmail": True or False, # Include the service account email in the token. If set to `true`, the
+ # token will contain `email` and `email_verified` claims.
}
x__xgafv: string, V1 error format.
@@ -179,13 +179,13 @@
An object of the form:
{
- "token": "A String", # The OpenId Connect ID token.
+ "token": "A String", # The OpenId Connect ID token.
}</pre>
</div>
<div class="method">
<code class="details" id="signBlob">signBlob(name, body=None, x__xgafv=None)</code>
- <pre>Signs a blob using a service account's system-managed private key.
+ <pre>Signs a blob using a service account's system-managed private key.
Args:
name: string, Required. The resource name of the service account for which the credentials
@@ -196,8 +196,7 @@
The object takes the form of:
{
- "payload": "A String", # Required. The bytes to sign.
- "delegates": [ # The sequence of service accounts in a delegation chain. Each service
+ "delegates": [ # The sequence of service accounts in a delegation chain. Each service
# account must be granted the `roles/iam.serviceAccountTokenCreator` role
# on its next service account in the chain. The last service account in the
# chain must be granted the `roles/iam.serviceAccountTokenCreator` role
@@ -207,8 +206,9 @@
# The delegates must have the following format:
# `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
# character is required; replacing it with a project ID is invalid.
- "A String",
+ "A String",
],
+ "payload": "A String", # Required. The bytes to sign.
}
x__xgafv: string, V1 error format.
@@ -220,14 +220,14 @@
An object of the form:
{
- "signedBlob": "A String", # The signature for the blob. Does not include the original blob.
- "keyId": "A String", # The ID of the key used to sign the blob.
+ "keyId": "A String", # The ID of the key used to sign the blob.
+ "signedBlob": "A String", # The signature for the blob. Does not include the original blob.
}</pre>
</div>
<div class="method">
<code class="details" id="signJwt">signJwt(name, body=None, x__xgafv=None)</code>
- <pre>Signs a JWT using a service account's system-managed private key.
+ <pre>Signs a JWT using a service account's system-managed private key.
Args:
name: string, Required. The resource name of the service account for which the credentials
@@ -238,12 +238,12 @@
The object takes the form of:
{
- "payload": "A String", # Required. The JWT payload to sign. Must be a serialized JSON object that contains a
- # JWT Claim Set. For example: `{"sub": "user@example.com", "iat": 313435}`
+ "payload": "A String", # Required. The JWT payload to sign. Must be a serialized JSON object that contains a
+ # JWT Claim Set. For example: `{"sub": "user@example.com", "iat": 313435}`
#
# If the claim set contains an `exp` claim, it must be an integer timestamp
# that is not in the past and at most 12 hours in the future.
- "delegates": [ # The sequence of service accounts in a delegation chain. Each service
+ "delegates": [ # The sequence of service accounts in a delegation chain. Each service
# account must be granted the `roles/iam.serviceAccountTokenCreator` role
# on its next service account in the chain. The last service account in the
# chain must be granted the `roles/iam.serviceAccountTokenCreator` role
@@ -253,7 +253,7 @@
# The delegates must have the following format:
# `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard
# character is required; replacing it with a project ID is invalid.
- "A String",
+ "A String",
],
}
@@ -266,8 +266,8 @@
An object of the form:
{
- "keyId": "A String", # The ID of the key used to sign the JWT.
- "signedJwt": "A String", # The signed JWT. Contains the automatically generated header; the
+ "keyId": "A String", # The ID of the key used to sign the JWT.
+ "signedJwt": "A String", # The signed JWT. Contains the automatically generated header; the
# client-supplied payload; and the signature, which is generated using the
# key referenced by the `kid` field in the header.
}</pre>