@maxim_mazurok/gapi.client.iam-v1 0.0.20240514 → 0.0.20240521
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +68 -68
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://iam.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240521
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -215,13 +215,13 @@ declare namespace gapi.client {
|
|
|
215
215
|
validationUnitName?: string;
|
|
216
216
|
}
|
|
217
217
|
interface ListOauthClientCredentialsResponse {
|
|
218
|
-
/** A list of
|
|
218
|
+
/** A list of OauthClientCredentials. */
|
|
219
219
|
oauthClientCredentials?: OauthClientCredential[];
|
|
220
220
|
}
|
|
221
221
|
interface ListOauthClientsResponse {
|
|
222
222
|
/** 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. */
|
|
223
223
|
nextPageToken?: string;
|
|
224
|
-
/** A list of
|
|
224
|
+
/** A list of OauthClients. */
|
|
225
225
|
oauthClients?: OauthClient[];
|
|
226
226
|
}
|
|
227
227
|
interface ListRolesResponse {
|
|
@@ -277,37 +277,37 @@ declare namespace gapi.client {
|
|
|
277
277
|
workloadIdentityPools?: WorkloadIdentityPool[];
|
|
278
278
|
}
|
|
279
279
|
interface OauthClient {
|
|
280
|
-
/** Required. The list of OAuth grant
|
|
280
|
+
/** Required. The list of OAuth grant types is allowed for the OauthClient. */
|
|
281
281
|
allowedGrantTypes?: string[];
|
|
282
282
|
/** Required. The list of redirect uris that is allowed to redirect back when authorization process is completed. */
|
|
283
283
|
allowedRedirectUris?: string[];
|
|
284
|
-
/** Required. The list of scopes that the
|
|
284
|
+
/** 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. * `openid`: Associate you with your personal info on Google Cloud. * `email`: See your Google Cloud Account email address. */
|
|
285
285
|
allowedScopes?: string[];
|
|
286
|
-
/** Output only. The system-generated
|
|
286
|
+
/** Output only. The system-generated OauthClient id. */
|
|
287
287
|
clientId?: string;
|
|
288
|
-
/** Immutable. The type of
|
|
288
|
+
/** Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource. */
|
|
289
289
|
clientType?: string;
|
|
290
|
-
/** Optional. A user-specified description of the
|
|
290
|
+
/** Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters. */
|
|
291
291
|
description?: string;
|
|
292
|
-
/** Optional. Whether the
|
|
292
|
+
/** Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client. */
|
|
293
293
|
disabled?: boolean;
|
|
294
|
-
/** Optional. A user-specified display name of the
|
|
294
|
+
/** Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters. */
|
|
295
295
|
displayName?: string;
|
|
296
|
-
/** Output only. Time after which the
|
|
296
|
+
/** Output only. Time after which the OauthClient will be permanently purged and cannot be recovered. */
|
|
297
297
|
expireTime?: string;
|
|
298
|
-
/** Immutable. The resource name of the
|
|
298
|
+
/** Immutable. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. */
|
|
299
299
|
name?: string;
|
|
300
|
-
/** Output only. The state of the
|
|
300
|
+
/** Output only. The state of the OauthClient. */
|
|
301
301
|
state?: string;
|
|
302
302
|
}
|
|
303
303
|
interface OauthClientCredential {
|
|
304
|
-
/** Output only. The system-generated
|
|
304
|
+
/** 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) */
|
|
305
305
|
clientSecret?: string;
|
|
306
|
-
/** Optional. Whether the
|
|
306
|
+
/** Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential. */
|
|
307
307
|
disabled?: boolean;
|
|
308
|
-
/** Optional. A user-specified display name of the
|
|
308
|
+
/** Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters. */
|
|
309
309
|
displayName?: string;
|
|
310
|
-
/** Immutable. The resource name of the
|
|
310
|
+
/** Immutable. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` */
|
|
311
311
|
name?: string;
|
|
312
312
|
}
|
|
313
313
|
interface Oidc {
|
|
@@ -1865,7 +1865,7 @@ declare namespace gapi.client {
|
|
|
1865
1865
|
key?: string;
|
|
1866
1866
|
/** OAuth 2.0 token for the current user. */
|
|
1867
1867
|
oauth_token?: string;
|
|
1868
|
-
/** The `parent` parameter's value depends on the target resource for the request, namely [
|
|
1868
|
+
/** The `parent` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
1869
1869
|
parent: string;
|
|
1870
1870
|
/** Returns response with indentations and line breaks. */
|
|
1871
1871
|
prettyPrint?: boolean;
|
|
@@ -1894,7 +1894,7 @@ declare namespace gapi.client {
|
|
|
1894
1894
|
key?: string;
|
|
1895
1895
|
/** OAuth 2.0 token for the current user. */
|
|
1896
1896
|
oauth_token?: string;
|
|
1897
|
-
/** The `parent` parameter's value depends on the target resource for the request, namely [
|
|
1897
|
+
/** The `parent` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
1898
1898
|
parent: string;
|
|
1899
1899
|
/** Returns response with indentations and line breaks. */
|
|
1900
1900
|
prettyPrint?: boolean;
|
|
@@ -1923,7 +1923,7 @@ declare namespace gapi.client {
|
|
|
1923
1923
|
fields?: string;
|
|
1924
1924
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1925
1925
|
key?: string;
|
|
1926
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
1926
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
1927
1927
|
name: string;
|
|
1928
1928
|
/** OAuth 2.0 token for the current user. */
|
|
1929
1929
|
oauth_token?: string;
|
|
@@ -1950,7 +1950,7 @@ declare namespace gapi.client {
|
|
|
1950
1950
|
fields?: string;
|
|
1951
1951
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1952
1952
|
key?: string;
|
|
1953
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
1953
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
1954
1954
|
name: string;
|
|
1955
1955
|
/** OAuth 2.0 token for the current user. */
|
|
1956
1956
|
oauth_token?: string;
|
|
@@ -1983,7 +1983,7 @@ declare namespace gapi.client {
|
|
|
1983
1983
|
pageSize?: number;
|
|
1984
1984
|
/** Optional pagination token returned in an earlier ListRolesResponse. */
|
|
1985
1985
|
pageToken?: string;
|
|
1986
|
-
/** The `parent` parameter's value depends on the target resource for the request, namely [
|
|
1986
|
+
/** The `parent` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
1987
1987
|
parent: string;
|
|
1988
1988
|
/** Returns response with indentations and line breaks. */
|
|
1989
1989
|
prettyPrint?: boolean;
|
|
@@ -2012,7 +2012,7 @@ declare namespace gapi.client {
|
|
|
2012
2012
|
fields?: string;
|
|
2013
2013
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2014
2014
|
key?: string;
|
|
2015
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
2015
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
2016
2016
|
name: string;
|
|
2017
2017
|
/** OAuth 2.0 token for the current user. */
|
|
2018
2018
|
oauth_token?: string;
|
|
@@ -2043,7 +2043,7 @@ declare namespace gapi.client {
|
|
|
2043
2043
|
fields?: string;
|
|
2044
2044
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2045
2045
|
key?: string;
|
|
2046
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
2046
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
2047
2047
|
name: string;
|
|
2048
2048
|
/** OAuth 2.0 token for the current user. */
|
|
2049
2049
|
oauth_token?: string;
|
|
@@ -2074,7 +2074,7 @@ declare namespace gapi.client {
|
|
|
2074
2074
|
fields?: string;
|
|
2075
2075
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2076
2076
|
key?: string;
|
|
2077
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
2077
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
2078
2078
|
name: string;
|
|
2079
2079
|
/** OAuth 2.0 token for the current user. */
|
|
2080
2080
|
oauth_token?: string;
|
|
@@ -2103,7 +2103,7 @@ declare namespace gapi.client {
|
|
|
2103
2103
|
fields?: string;
|
|
2104
2104
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2105
2105
|
key?: string;
|
|
2106
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
2106
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
2107
2107
|
name: string;
|
|
2108
2108
|
/** OAuth 2.0 token for the current user. */
|
|
2109
2109
|
oauth_token?: string;
|
|
@@ -2195,9 +2195,9 @@ declare namespace gapi.client {
|
|
|
2195
2195
|
key?: string;
|
|
2196
2196
|
/** OAuth 2.0 token for the current user. */
|
|
2197
2197
|
oauth_token?: string;
|
|
2198
|
-
/** Required. The ID to use for the
|
|
2198
|
+
/** 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. */
|
|
2199
2199
|
oauthClientCredentialId?: string;
|
|
2200
|
-
/** Required. The parent resource to create the
|
|
2200
|
+
/** Required. The parent resource to create the OauthClientCredential in. */
|
|
2201
2201
|
parent: string;
|
|
2202
2202
|
/** Returns response with indentations and line breaks. */
|
|
2203
2203
|
prettyPrint?: boolean;
|
|
@@ -2226,9 +2226,9 @@ declare namespace gapi.client {
|
|
|
2226
2226
|
key?: string;
|
|
2227
2227
|
/** OAuth 2.0 token for the current user. */
|
|
2228
2228
|
oauth_token?: string;
|
|
2229
|
-
/** Required. The ID to use for the
|
|
2229
|
+
/** 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. */
|
|
2230
2230
|
oauthClientCredentialId?: string;
|
|
2231
|
-
/** Required. The parent resource to create the
|
|
2231
|
+
/** Required. The parent resource to create the OauthClientCredential in. */
|
|
2232
2232
|
parent: string;
|
|
2233
2233
|
/** Returns response with indentations and line breaks. */
|
|
2234
2234
|
prettyPrint?: boolean;
|
|
@@ -2241,7 +2241,7 @@ declare namespace gapi.client {
|
|
|
2241
2241
|
},
|
|
2242
2242
|
body: OauthClientCredential
|
|
2243
2243
|
): Request<OauthClientCredential>;
|
|
2244
|
-
/** Deletes
|
|
2244
|
+
/** Deletes an OauthClientCredential. Before deleting an OauthClientCredential, it should first be disabled. */
|
|
2245
2245
|
delete(request?: {
|
|
2246
2246
|
/** V1 error format. */
|
|
2247
2247
|
'$.xgafv'?: string;
|
|
@@ -2255,7 +2255,7 @@ declare namespace gapi.client {
|
|
|
2255
2255
|
fields?: string;
|
|
2256
2256
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2257
2257
|
key?: string;
|
|
2258
|
-
/** Required. The name of the
|
|
2258
|
+
/** Required. The name of the OauthClientCredential to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`. */
|
|
2259
2259
|
name: string;
|
|
2260
2260
|
/** OAuth 2.0 token for the current user. */
|
|
2261
2261
|
oauth_token?: string;
|
|
@@ -2282,7 +2282,7 @@ declare namespace gapi.client {
|
|
|
2282
2282
|
fields?: string;
|
|
2283
2283
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2284
2284
|
key?: string;
|
|
2285
|
-
/** Required. The name of the
|
|
2285
|
+
/** Required. The name of the OauthClientCredential to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`. */
|
|
2286
2286
|
name: string;
|
|
2287
2287
|
/** OAuth 2.0 token for the current user. */
|
|
2288
2288
|
oauth_token?: string;
|
|
@@ -2295,7 +2295,7 @@ declare namespace gapi.client {
|
|
|
2295
2295
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2296
2296
|
uploadType?: string;
|
|
2297
2297
|
}): Request<OauthClientCredential>;
|
|
2298
|
-
/** Lists all
|
|
2298
|
+
/** Lists all OauthClientCredentials in an OauthClient. */
|
|
2299
2299
|
list(request?: {
|
|
2300
2300
|
/** V1 error format. */
|
|
2301
2301
|
'$.xgafv'?: string;
|
|
@@ -2311,7 +2311,7 @@ declare namespace gapi.client {
|
|
|
2311
2311
|
key?: string;
|
|
2312
2312
|
/** OAuth 2.0 token for the current user. */
|
|
2313
2313
|
oauth_token?: string;
|
|
2314
|
-
/** Required. The parent to list
|
|
2314
|
+
/** Required. The parent to list OauthClientCredentials for. */
|
|
2315
2315
|
parent: string;
|
|
2316
2316
|
/** Returns response with indentations and line breaks. */
|
|
2317
2317
|
prettyPrint?: boolean;
|
|
@@ -2336,7 +2336,7 @@ declare namespace gapi.client {
|
|
|
2336
2336
|
fields?: string;
|
|
2337
2337
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2338
2338
|
key?: string;
|
|
2339
|
-
/** Immutable. The resource name of the
|
|
2339
|
+
/** Immutable. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` */
|
|
2340
2340
|
name: string;
|
|
2341
2341
|
/** OAuth 2.0 token for the current user. */
|
|
2342
2342
|
oauth_token?: string;
|
|
@@ -2367,7 +2367,7 @@ declare namespace gapi.client {
|
|
|
2367
2367
|
fields?: string;
|
|
2368
2368
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2369
2369
|
key?: string;
|
|
2370
|
-
/** Immutable. The resource name of the
|
|
2370
|
+
/** Immutable. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` */
|
|
2371
2371
|
name: string;
|
|
2372
2372
|
/** OAuth 2.0 token for the current user. */
|
|
2373
2373
|
oauth_token?: string;
|
|
@@ -2386,7 +2386,7 @@ declare namespace gapi.client {
|
|
|
2386
2386
|
): Request<OauthClientCredential>;
|
|
2387
2387
|
}
|
|
2388
2388
|
interface OauthClientsResource {
|
|
2389
|
-
/** Creates a new OauthClient. You cannot reuse the name of a deleted
|
|
2389
|
+
/** Creates a new OauthClient. You cannot reuse the name of a deleted OauthClient until 30 days after deletion. */
|
|
2390
2390
|
create(request: {
|
|
2391
2391
|
/** V1 error format. */
|
|
2392
2392
|
'$.xgafv'?: string;
|
|
@@ -2402,9 +2402,9 @@ declare namespace gapi.client {
|
|
|
2402
2402
|
key?: string;
|
|
2403
2403
|
/** OAuth 2.0 token for the current user. */
|
|
2404
2404
|
oauth_token?: string;
|
|
2405
|
-
/** Required. The ID to use for the
|
|
2405
|
+
/** 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. */
|
|
2406
2406
|
oauthClientId?: string;
|
|
2407
|
-
/** Required. The parent resource to create the
|
|
2407
|
+
/** Required. The parent resource to create the OauthClient in. The only supported location is `global`. */
|
|
2408
2408
|
parent: string;
|
|
2409
2409
|
/** Returns response with indentations and line breaks. */
|
|
2410
2410
|
prettyPrint?: boolean;
|
|
@@ -2433,9 +2433,9 @@ declare namespace gapi.client {
|
|
|
2433
2433
|
key?: string;
|
|
2434
2434
|
/** OAuth 2.0 token for the current user. */
|
|
2435
2435
|
oauth_token?: string;
|
|
2436
|
-
/** Required. The ID to use for the
|
|
2436
|
+
/** 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. */
|
|
2437
2437
|
oauthClientId?: string;
|
|
2438
|
-
/** Required. The parent resource to create the
|
|
2438
|
+
/** Required. The parent resource to create the OauthClient in. The only supported location is `global`. */
|
|
2439
2439
|
parent: string;
|
|
2440
2440
|
/** Returns response with indentations and line breaks. */
|
|
2441
2441
|
prettyPrint?: boolean;
|
|
@@ -2448,7 +2448,7 @@ declare namespace gapi.client {
|
|
|
2448
2448
|
},
|
|
2449
2449
|
body: OauthClient
|
|
2450
2450
|
): Request<OauthClient>;
|
|
2451
|
-
/** Deletes
|
|
2451
|
+
/** 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. */
|
|
2452
2452
|
delete(request?: {
|
|
2453
2453
|
/** V1 error format. */
|
|
2454
2454
|
'$.xgafv'?: string;
|
|
@@ -2462,7 +2462,7 @@ declare namespace gapi.client {
|
|
|
2462
2462
|
fields?: string;
|
|
2463
2463
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2464
2464
|
key?: string;
|
|
2465
|
-
/** Required. The name of the
|
|
2465
|
+
/** Required. The name of the OauthClient to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. */
|
|
2466
2466
|
name: string;
|
|
2467
2467
|
/** OAuth 2.0 token for the current user. */
|
|
2468
2468
|
oauth_token?: string;
|
|
@@ -2489,7 +2489,7 @@ declare namespace gapi.client {
|
|
|
2489
2489
|
fields?: string;
|
|
2490
2490
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2491
2491
|
key?: string;
|
|
2492
|
-
/** Required. The name of the
|
|
2492
|
+
/** Required. The name of the OauthClient to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. */
|
|
2493
2493
|
name: string;
|
|
2494
2494
|
/** OAuth 2.0 token for the current user. */
|
|
2495
2495
|
oauth_token?: string;
|
|
@@ -2502,7 +2502,7 @@ declare namespace gapi.client {
|
|
|
2502
2502
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2503
2503
|
uploadType?: string;
|
|
2504
2504
|
}): Request<OauthClient>;
|
|
2505
|
-
/** Lists all non-deleted
|
|
2505
|
+
/** Lists all non-deleted OauthClients in a project. If `show_deleted` is set to `true`, then deleted OauthClients are also listed. */
|
|
2506
2506
|
list(request?: {
|
|
2507
2507
|
/** V1 error format. */
|
|
2508
2508
|
'$.xgafv'?: string;
|
|
@@ -2518,17 +2518,17 @@ declare namespace gapi.client {
|
|
|
2518
2518
|
key?: string;
|
|
2519
2519
|
/** OAuth 2.0 token for the current user. */
|
|
2520
2520
|
oauth_token?: string;
|
|
2521
|
-
/** Optional. The maximum number of
|
|
2521
|
+
/** 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. */
|
|
2522
2522
|
pageSize?: number;
|
|
2523
2523
|
/** Optional. A page token, received from a previous `ListOauthClients` call. Provide this to retrieve the subsequent page. */
|
|
2524
2524
|
pageToken?: string;
|
|
2525
|
-
/** Required. The parent to list
|
|
2525
|
+
/** Required. The parent to list OauthClients for. */
|
|
2526
2526
|
parent: string;
|
|
2527
2527
|
/** Returns response with indentations and line breaks. */
|
|
2528
2528
|
prettyPrint?: boolean;
|
|
2529
2529
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2530
2530
|
quotaUser?: string;
|
|
2531
|
-
/** Optional. Whether to return soft-deleted
|
|
2531
|
+
/** Optional. Whether to return soft-deleted OauthClients. */
|
|
2532
2532
|
showDeleted?: boolean;
|
|
2533
2533
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2534
2534
|
upload_protocol?: string;
|
|
@@ -2549,7 +2549,7 @@ declare namespace gapi.client {
|
|
|
2549
2549
|
fields?: string;
|
|
2550
2550
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2551
2551
|
key?: string;
|
|
2552
|
-
/** Immutable. The resource name of the
|
|
2552
|
+
/** Immutable. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. */
|
|
2553
2553
|
name: string;
|
|
2554
2554
|
/** OAuth 2.0 token for the current user. */
|
|
2555
2555
|
oauth_token?: string;
|
|
@@ -2580,7 +2580,7 @@ declare namespace gapi.client {
|
|
|
2580
2580
|
fields?: string;
|
|
2581
2581
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2582
2582
|
key?: string;
|
|
2583
|
-
/** Immutable. The resource name of the
|
|
2583
|
+
/** Immutable. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. */
|
|
2584
2584
|
name: string;
|
|
2585
2585
|
/** OAuth 2.0 token for the current user. */
|
|
2586
2586
|
oauth_token?: string;
|
|
@@ -2597,7 +2597,7 @@ declare namespace gapi.client {
|
|
|
2597
2597
|
},
|
|
2598
2598
|
body: OauthClient
|
|
2599
2599
|
): Request<OauthClient>;
|
|
2600
|
-
/** Undeletes
|
|
2600
|
+
/** Undeletes an OauthClient, as long as it was deleted fewer than 30 days ago. */
|
|
2601
2601
|
undelete(request: {
|
|
2602
2602
|
/** V1 error format. */
|
|
2603
2603
|
'$.xgafv'?: string;
|
|
@@ -2611,7 +2611,7 @@ declare namespace gapi.client {
|
|
|
2611
2611
|
fields?: string;
|
|
2612
2612
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2613
2613
|
key?: string;
|
|
2614
|
-
/** Required. The name of the
|
|
2614
|
+
/** Required. The name of the OauthClient to undelete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. */
|
|
2615
2615
|
name: string;
|
|
2616
2616
|
/** OAuth 2.0 token for the current user. */
|
|
2617
2617
|
oauth_token?: string;
|
|
@@ -2640,7 +2640,7 @@ declare namespace gapi.client {
|
|
|
2640
2640
|
fields?: string;
|
|
2641
2641
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2642
2642
|
key?: string;
|
|
2643
|
-
/** Required. The name of the
|
|
2643
|
+
/** Required. The name of the OauthClient to undelete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. */
|
|
2644
2644
|
name: string;
|
|
2645
2645
|
/** OAuth 2.0 token for the current user. */
|
|
2646
2646
|
oauth_token?: string;
|
|
@@ -3620,7 +3620,7 @@ declare namespace gapi.client {
|
|
|
3620
3620
|
key?: string;
|
|
3621
3621
|
/** OAuth 2.0 token for the current user. */
|
|
3622
3622
|
oauth_token?: string;
|
|
3623
|
-
/** The `parent` parameter's value depends on the target resource for the request, namely [
|
|
3623
|
+
/** The `parent` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3624
3624
|
parent: string;
|
|
3625
3625
|
/** Returns response with indentations and line breaks. */
|
|
3626
3626
|
prettyPrint?: boolean;
|
|
@@ -3649,7 +3649,7 @@ declare namespace gapi.client {
|
|
|
3649
3649
|
key?: string;
|
|
3650
3650
|
/** OAuth 2.0 token for the current user. */
|
|
3651
3651
|
oauth_token?: string;
|
|
3652
|
-
/** The `parent` parameter's value depends on the target resource for the request, namely [
|
|
3652
|
+
/** The `parent` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3653
3653
|
parent: string;
|
|
3654
3654
|
/** Returns response with indentations and line breaks. */
|
|
3655
3655
|
prettyPrint?: boolean;
|
|
@@ -3678,7 +3678,7 @@ declare namespace gapi.client {
|
|
|
3678
3678
|
fields?: string;
|
|
3679
3679
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3680
3680
|
key?: string;
|
|
3681
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
3681
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3682
3682
|
name: string;
|
|
3683
3683
|
/** OAuth 2.0 token for the current user. */
|
|
3684
3684
|
oauth_token?: string;
|
|
@@ -3705,7 +3705,7 @@ declare namespace gapi.client {
|
|
|
3705
3705
|
fields?: string;
|
|
3706
3706
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3707
3707
|
key?: string;
|
|
3708
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
3708
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3709
3709
|
name: string;
|
|
3710
3710
|
/** OAuth 2.0 token for the current user. */
|
|
3711
3711
|
oauth_token?: string;
|
|
@@ -3738,7 +3738,7 @@ declare namespace gapi.client {
|
|
|
3738
3738
|
pageSize?: number;
|
|
3739
3739
|
/** Optional pagination token returned in an earlier ListRolesResponse. */
|
|
3740
3740
|
pageToken?: string;
|
|
3741
|
-
/** The `parent` parameter's value depends on the target resource for the request, namely [
|
|
3741
|
+
/** The `parent` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3742
3742
|
parent: string;
|
|
3743
3743
|
/** Returns response with indentations and line breaks. */
|
|
3744
3744
|
prettyPrint?: boolean;
|
|
@@ -3767,7 +3767,7 @@ declare namespace gapi.client {
|
|
|
3767
3767
|
fields?: string;
|
|
3768
3768
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3769
3769
|
key?: string;
|
|
3770
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
3770
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3771
3771
|
name: string;
|
|
3772
3772
|
/** OAuth 2.0 token for the current user. */
|
|
3773
3773
|
oauth_token?: string;
|
|
@@ -3798,7 +3798,7 @@ declare namespace gapi.client {
|
|
|
3798
3798
|
fields?: string;
|
|
3799
3799
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3800
3800
|
key?: string;
|
|
3801
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
3801
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3802
3802
|
name: string;
|
|
3803
3803
|
/** OAuth 2.0 token for the current user. */
|
|
3804
3804
|
oauth_token?: string;
|
|
@@ -3829,7 +3829,7 @@ declare namespace gapi.client {
|
|
|
3829
3829
|
fields?: string;
|
|
3830
3830
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3831
3831
|
key?: string;
|
|
3832
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
3832
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3833
3833
|
name: string;
|
|
3834
3834
|
/** OAuth 2.0 token for the current user. */
|
|
3835
3835
|
oauth_token?: string;
|
|
@@ -3858,7 +3858,7 @@ declare namespace gapi.client {
|
|
|
3858
3858
|
fields?: string;
|
|
3859
3859
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3860
3860
|
key?: string;
|
|
3861
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
3861
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
3862
3862
|
name: string;
|
|
3863
3863
|
/** OAuth 2.0 token for the current user. */
|
|
3864
3864
|
oauth_token?: string;
|
|
@@ -4480,7 +4480,7 @@ declare namespace gapi.client {
|
|
|
4480
4480
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4481
4481
|
uploadType?: string;
|
|
4482
4482
|
}): Request<ServiceAccount>;
|
|
4483
|
-
/** Gets the IAM policy that is attached to a ServiceAccount. This IAM policy specifies which principals have access to the service account. This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the `getIamPolicy` method for that resource. For example, to view the role grants for a project, call the Resource Manager API's [
|
|
4483
|
+
/** Gets the IAM policy that is attached to a ServiceAccount. This IAM policy specifies which principals have access to the service account. This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the `getIamPolicy` method for that resource. For example, to view the role grants for a project, call the Resource Manager API's [projects.getIamPolicy](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) method. */
|
|
4484
4484
|
getIamPolicy(request?: {
|
|
4485
4485
|
/** V1 error format. */
|
|
4486
4486
|
'$.xgafv'?: string;
|
|
@@ -4628,7 +4628,7 @@ declare namespace gapi.client {
|
|
|
4628
4628
|
},
|
|
4629
4629
|
body: SetIamPolicyRequest
|
|
4630
4630
|
): Request<Policy>;
|
|
4631
|
-
/** **Note:** This method is deprecated. Use the [
|
|
4631
|
+
/** **Note:** This method is deprecated. Use the [signBlob](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a blob using the system-managed private key for a ServiceAccount. */
|
|
4632
4632
|
signBlob(request: {
|
|
4633
4633
|
/** V1 error format. */
|
|
4634
4634
|
'$.xgafv'?: string;
|
|
@@ -4686,7 +4686,7 @@ declare namespace gapi.client {
|
|
|
4686
4686
|
},
|
|
4687
4687
|
body: SignBlobRequest
|
|
4688
4688
|
): Request<SignBlobResponse>;
|
|
4689
|
-
/** **Note:** This method is deprecated. Use the [
|
|
4689
|
+
/** **Note:** This method is deprecated. Use the [signJwt](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount. */
|
|
4690
4690
|
signJwt(request: {
|
|
4691
4691
|
/** V1 error format. */
|
|
4692
4692
|
'$.xgafv'?: string;
|
|
@@ -4912,7 +4912,7 @@ declare namespace gapi.client {
|
|
|
4912
4912
|
fields?: string;
|
|
4913
4913
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4914
4914
|
key?: string;
|
|
4915
|
-
/** The `name` parameter's value depends on the target resource for the request, namely [
|
|
4915
|
+
/** The `name` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
4916
4916
|
name: string;
|
|
4917
4917
|
/** OAuth 2.0 token for the current user. */
|
|
4918
4918
|
oauth_token?: string;
|
|
@@ -4945,7 +4945,7 @@ declare namespace gapi.client {
|
|
|
4945
4945
|
pageSize?: number;
|
|
4946
4946
|
/** Optional pagination token returned in an earlier ListRolesResponse. */
|
|
4947
4947
|
pageToken?: string;
|
|
4948
|
-
/** The `parent` parameter's value depends on the target resource for the request, namely [
|
|
4948
|
+
/** The `parent` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */
|
|
4949
4949
|
parent?: string;
|
|
4950
4950
|
/** Returns response with indentations and line breaks. */
|
|
4951
4951
|
prettyPrint?: boolean;
|