@maxim_mazurok/gapi.client.accesscontextmanager-v1 0.0.20230126 → 0.0.20230207

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 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://accesscontextmanager.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230126
12
+ // Revision: 20230207
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -89,24 +89,24 @@ declare namespace gapi.client {
89
89
  logType?: string;
90
90
  }
91
91
  interface AuthorizedOrgsDesc {
92
- /** The asset type of this authorized orgs desc. e.g. device, credential strength. */
92
+ /** The asset type of this authorized orgs desc. Valid values are `ASSET_TYPE_DEVICE`, and `ASSET_TYPE_CREDENTIAL_STRENGTH`. */
93
93
  assetType?: string;
94
94
  /**
95
- * Authorization direction of this authorization relationship. i.e. Whether to allow specified orgs to evaluate this org's traffic, or allow specified orgs' traffic to be evaluated by
96
- * this org. Orgs specified as `AUTHORIZATION_DIRECTION_TO` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the
97
- * `AUTHORIZATION_DIRECTION_FROM` in their own AuthorizedOrgsDesc in order for this relationship to take effect. Orgs specified as `AUTHORIZATION_DIRECTION_FROM` in this
98
- * AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_TO` in their own AuthorizedOrgsDesc in
99
- * order for this relationship to take effect.
95
+ * The direction of the authorization relationship between this organization and the organizations listed in the `orgs` field. The valid values for this field include the following:
96
+ * `AUTHORIZATION_DIRECTION_FROM`: Allows this organization to evaluate traffic in the organizations listed in the `orgs` field. `AUTHORIZATION_DIRECTION_TO`: Allows the organizations
97
+ * listed in the `orgs` field to evaluate the traffic in this organization. For the authorization relationship to take effect, all of the organizations must authorize and specify the
98
+ * appropriate relationship direction. For example, if organization A authorized organization B and C to evaluate its traffic, by specifying `AUTHORIZATION_DIRECTION_TO` as the
99
+ * authorization direction, organizations B and C must specify `AUTHORIZATION_DIRECTION_FROM` as the authorization direction in their `AuthorizedOrgsDesc` resource.
100
100
  */
101
101
  authorizationDirection?: string;
102
- /** The authorization type of this authorized orgs desc. e.g.authorization, troubleshooting or logging. */
102
+ /** A granular control type for authorization levels. Valid value is `AUTHORIZATION_TYPE_TRUST`. */
103
103
  authorizationType?: string;
104
104
  /**
105
- * Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section
106
- * 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N"
105
+ * Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin with
106
+ * a letter, followed by alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you cannot change its `name`.
107
107
  */
108
108
  name?: string;
109
- /** The list of organization ids in this AuthorizedOrgsDesc. */
109
+ /** The list of organization ids in this AuthorizedOrgsDesc. Format: `organizations/` Example: `organizations/123456` */
110
110
  orgs?: string[];
111
111
  }
112
112
  interface BasicLevel {
@@ -132,14 +132,14 @@ declare namespace gapi.client {
132
132
  * Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example,
133
133
  * `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service
134
134
  * account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
135
- * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
136
- * identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to
137
- * `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing
138
- * a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value
139
- * reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
140
- * identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to
141
- * `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For
142
- * example, `google.com` or `example.com`.
135
+ * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the
136
+ * users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has
137
+ * been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains
138
+ * the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently
139
+ * deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and
140
+ * the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that
141
+ * has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group
142
+ * retains the role in the binding.
143
143
  */
144
144
  members?: string[];
145
145
  /** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
@@ -310,8 +310,8 @@ declare namespace gapi.client {
310
310
  accessLevel?: string;
311
311
  /**
312
312
  * A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are
313
- * allowed. Project format: `projects/{project_number}` VPC format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud
314
- * organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.
313
+ * allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google
314
+ * Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.
315
315
  */
316
316
  resource?: string;
317
317
  }
@@ -337,7 +337,7 @@ declare namespace gapi.client {
337
337
  nextPageToken?: string;
338
338
  }
339
339
  interface ListAuthorizedOrgsDescsResponse {
340
- /** List of the Authorized Orgs Desc instances. */
340
+ /** List of all the Authorized Orgs Desc instances. */
341
341
  authorizedOrgsDescs?: AuthorizedOrgsDesc[];
342
342
  /** The pagination token to retrieve the next page of results. If the value is empty, no further results remain. */
343
343
  nextPageToken?: string;
@@ -467,8 +467,8 @@ declare namespace gapi.client {
467
467
  */
468
468
  name?: string;
469
469
  /**
470
- * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a
471
- * perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.
470
+ * Perimeter type indicator. A single project or VPC network is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a
471
+ * included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.
472
472
  */
473
473
  perimeterType?: string;
474
474
  /**
@@ -506,8 +506,8 @@ declare namespace gapi.client {
506
506
  */
507
507
  ingressPolicies?: IngressPolicy[];
508
508
  /**
509
- * A list of Google Cloud resources that are inside of the service perimeter. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC format:
510
- * `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`.
509
+ * A list of Google Cloud resources that are inside of the service perimeter. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network
510
+ * format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`.
511
511
  */
512
512
  resources?: string[];
513
513
  /**
@@ -887,7 +887,7 @@ declare namespace gapi.client {
887
887
  }
888
888
  interface AuthorizedOrgsDescsResource {
889
889
  /**
890
- * Creates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized
890
+ * Creates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized
891
891
  * orgs desc contains errors, an error response is returned for the first error encountered. The name of this `AuthorizedOrgsDesc` will be assigned during creation.
892
892
  */
893
893
  create(request: {
@@ -946,7 +946,7 @@ declare namespace gapi.client {
946
946
  },
947
947
  body: AuthorizedOrgsDesc): Request<Operation>;
948
948
  /**
949
- * Deletes a authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from
949
+ * Deletes an authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from
950
950
  * long-lasting storage.
951
951
  */
952
952
  delete(request?: {
@@ -975,7 +975,7 @@ declare namespace gapi.client {
975
975
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
976
976
  uploadType?: string;
977
977
  }): Request<Operation>;
978
- /** Gets a authorized orgs desc based on the resource name. */
978
+ /** Gets an authorized orgs desc based on the resource name. */
979
979
  get(request?: {
980
980
  /** V1 error format. */
981
981
  "$.xgafv"?: string;
@@ -1034,7 +1034,7 @@ declare namespace gapi.client {
1034
1034
  uploadType?: string;
1035
1035
  }): Request<ListAuthorizedOrgsDescsResponse>;
1036
1036
  /**
1037
- * Updates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized
1037
+ * Updates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized
1038
1038
  * orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in `AuthorizedOrgsDesc` can be updated. The name,
1039
1039
  * authorization_type, asset_type and authorization_direction cannot be updated.
1040
1040
  */
@@ -1052,8 +1052,8 @@ declare namespace gapi.client {
1052
1052
  /** 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. */
1053
1053
  key?: string;
1054
1054
  /**
1055
- * Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section
1056
- * 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N"
1055
+ * Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin
1056
+ * with a letter, followed by alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you cannot change its `name`.
1057
1057
  */
1058
1058
  name: string;
1059
1059
  /** OAuth 2.0 token for the current user. */
@@ -1085,8 +1085,8 @@ declare namespace gapi.client {
1085
1085
  /** 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. */
1086
1086
  key?: string;
1087
1087
  /**
1088
- * Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section
1089
- * 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N"
1088
+ * Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin
1089
+ * with a letter, followed by alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you cannot change its `name`.
1090
1090
  */
1091
1091
  name: string;
1092
1092
  /** OAuth 2.0 token for the current user. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.accesscontextmanager-v1",
3
- "version": "0.0.20230126",
3
+ "version": "0.0.20230207",
4
4
  "description": "TypeScript typings for Access Context Manager API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TypeScript typings for Access Context Manager API v1
2
2
 
3
- An API for setting attribute based access control to requests to GCP services.
3
+ An API for setting attribute based access control to requests to Google Cloud services.
4
4
  For detailed description please check [documentation](https://cloud.google.com/access-context-manager/docs/reference/rest/).
5
5
 
6
6
  ## Installing
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230126
6
+ // Revision: 20230207
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -336,7 +336,7 @@ gapi.load('client', async () => {
336
336
  ],
337
337
  });
338
338
  /**
339
- * Creates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs
339
+ * Creates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs
340
340
  * desc contains errors, an error response is returned for the first error encountered. The name of this `AuthorizedOrgsDesc` will be assigned during creation.
341
341
  */
342
342
  await gapi.client.accesscontextmanager.accessPolicies.authorizedOrgsDescs.create({
@@ -351,13 +351,13 @@ gapi.load('client', async () => {
351
351
  ],
352
352
  });
353
353
  /**
354
- * Deletes a authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting
354
+ * Deletes an authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting
355
355
  * storage.
356
356
  */
357
357
  await gapi.client.accesscontextmanager.accessPolicies.authorizedOrgsDescs.delete({
358
358
  name: "Test string",
359
359
  });
360
- /** Gets a authorized orgs desc based on the resource name. */
360
+ /** Gets an authorized orgs desc based on the resource name. */
361
361
  await gapi.client.accesscontextmanager.accessPolicies.authorizedOrgsDescs.get({
362
362
  name: "Test string",
363
363
  });
@@ -368,7 +368,7 @@ gapi.load('client', async () => {
368
368
  parent: "Test string",
369
369
  });
370
370
  /**
371
- * Updates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs
371
+ * Updates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs
372
372
  * desc contains errors, an error response is returned for the first error encountered. Only the organization list in `AuthorizedOrgsDesc` can be updated. The name, authorization_type,
373
373
  * asset_type and authorization_direction cannot be updated.
374
374
  */