@maxim_mazurok/gapi.client.cloudidentity-v1 0.2.20260317 → 0.2.20260608
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 +145 -5
- package/package.json +1 -1
- package/readme.md +32 -0
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://cloudidentity.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260608
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -677,6 +677,7 @@ declare namespace gapi.client {
|
|
|
677
677
|
| 'GROUP'
|
|
678
678
|
| 'SHARED_DRIVE'
|
|
679
679
|
| 'CBCM_BROWSER'
|
|
680
|
+
| 'CHROME_OS_DEVICE'
|
|
680
681
|
| 'OTHER';
|
|
681
682
|
/** Output only. The time when the `Membership` was last updated. */
|
|
682
683
|
updateTime?: string;
|
|
@@ -779,7 +780,7 @@ declare namespace gapi.client {
|
|
|
779
780
|
group?: string;
|
|
780
781
|
/** Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. */
|
|
781
782
|
orgUnit?: string;
|
|
782
|
-
/** Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. */
|
|
783
|
+
/** Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. */
|
|
783
784
|
query?: string;
|
|
784
785
|
/** Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). */
|
|
785
786
|
sortOrder?: number;
|
|
@@ -866,7 +867,7 @@ declare namespace gapi.client {
|
|
|
866
867
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
867
868
|
code?: number;
|
|
868
869
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
869
|
-
details?:
|
|
870
|
+
details?: {[P in string]: any}[];
|
|
870
871
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
871
872
|
message?: string;
|
|
872
873
|
}
|
|
@@ -3412,6 +3413,87 @@ declare namespace gapi.client {
|
|
|
3412
3413
|
): Request<Operation>;
|
|
3413
3414
|
}
|
|
3414
3415
|
interface PoliciesResource {
|
|
3416
|
+
/** Create a policy. */
|
|
3417
|
+
create(request: {
|
|
3418
|
+
/** V1 error format. */
|
|
3419
|
+
'$.xgafv'?: '1' | '2';
|
|
3420
|
+
/** OAuth access token. */
|
|
3421
|
+
access_token?: string;
|
|
3422
|
+
/** Data format for response. */
|
|
3423
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3424
|
+
/** JSONP */
|
|
3425
|
+
callback?: string;
|
|
3426
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3427
|
+
fields?: string;
|
|
3428
|
+
/** 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. */
|
|
3429
|
+
key?: string;
|
|
3430
|
+
/** OAuth 2.0 token for the current user. */
|
|
3431
|
+
oauth_token?: string;
|
|
3432
|
+
/** Returns response with indentations and line breaks. */
|
|
3433
|
+
prettyPrint?: boolean;
|
|
3434
|
+
/** 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. */
|
|
3435
|
+
quotaUser?: string;
|
|
3436
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3437
|
+
upload_protocol?: string;
|
|
3438
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3439
|
+
uploadType?: string;
|
|
3440
|
+
/** Request body */
|
|
3441
|
+
resource: Policy;
|
|
3442
|
+
}): Request<Operation>;
|
|
3443
|
+
create(
|
|
3444
|
+
request: {
|
|
3445
|
+
/** V1 error format. */
|
|
3446
|
+
'$.xgafv'?: '1' | '2';
|
|
3447
|
+
/** OAuth access token. */
|
|
3448
|
+
access_token?: string;
|
|
3449
|
+
/** Data format for response. */
|
|
3450
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3451
|
+
/** JSONP */
|
|
3452
|
+
callback?: string;
|
|
3453
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3454
|
+
fields?: string;
|
|
3455
|
+
/** 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. */
|
|
3456
|
+
key?: string;
|
|
3457
|
+
/** OAuth 2.0 token for the current user. */
|
|
3458
|
+
oauth_token?: string;
|
|
3459
|
+
/** Returns response with indentations and line breaks. */
|
|
3460
|
+
prettyPrint?: boolean;
|
|
3461
|
+
/** 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. */
|
|
3462
|
+
quotaUser?: string;
|
|
3463
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3464
|
+
upload_protocol?: string;
|
|
3465
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3466
|
+
uploadType?: string;
|
|
3467
|
+
},
|
|
3468
|
+
body: Policy,
|
|
3469
|
+
): Request<Operation>;
|
|
3470
|
+
/** Delete a policy. */
|
|
3471
|
+
delete(request?: {
|
|
3472
|
+
/** V1 error format. */
|
|
3473
|
+
'$.xgafv'?: '1' | '2';
|
|
3474
|
+
/** OAuth access token. */
|
|
3475
|
+
access_token?: string;
|
|
3476
|
+
/** Data format for response. */
|
|
3477
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3478
|
+
/** JSONP */
|
|
3479
|
+
callback?: string;
|
|
3480
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3481
|
+
fields?: string;
|
|
3482
|
+
/** 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. */
|
|
3483
|
+
key?: string;
|
|
3484
|
+
/** Required. The name of the policy to delete. Format: `policies/{policy}`. */
|
|
3485
|
+
name: string;
|
|
3486
|
+
/** OAuth 2.0 token for the current user. */
|
|
3487
|
+
oauth_token?: string;
|
|
3488
|
+
/** Returns response with indentations and line breaks. */
|
|
3489
|
+
prettyPrint?: boolean;
|
|
3490
|
+
/** 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. */
|
|
3491
|
+
quotaUser?: string;
|
|
3492
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3493
|
+
upload_protocol?: string;
|
|
3494
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3495
|
+
uploadType?: string;
|
|
3496
|
+
}): Request<Operation>;
|
|
3415
3497
|
/** Get a policy. */
|
|
3416
3498
|
get(request?: {
|
|
3417
3499
|
/** V1 error format. */
|
|
@@ -3451,13 +3533,13 @@ declare namespace gapi.client {
|
|
|
3451
3533
|
callback?: string;
|
|
3452
3534
|
/** Selector specifying which fields to include in a partial response. */
|
|
3453
3535
|
fields?: string;
|
|
3454
|
-
/** Optional. A CEL expression for filtering the results. Policies can be filtered
|
|
3536
|
+
/** Optional. A CEL expression for filtering the results. Policies can be filtered using the expression in the following ways: - Filter by application: `setting.type.matches('^settings/gmail\\..*$')` - Filter by setting type: `setting.type.matches('^.*\\.service_status$')` - Filter by customer: `customer == "customers/{customer}"` Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no `customer` is mentioned it will be default to `customers/my_customer`. You may only filter on policies for a single customer at a time. The above clauses can be combined together in a single filter expression with the `&&` and `||` operators, like in the following example: `customer == "customers/my_customer" && ( setting.type.matches('^settings/gmail\\..*$') || setting.type.matches('^.*\\.service_status$') )`. */
|
|
3455
3537
|
filter?: string;
|
|
3456
3538
|
/** 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. */
|
|
3457
3539
|
key?: string;
|
|
3458
3540
|
/** OAuth 2.0 token for the current user. */
|
|
3459
3541
|
oauth_token?: string;
|
|
3460
|
-
/** Optional. The maximum number of results to return. The service can return fewer than this number. If omitted or set to 0
|
|
3542
|
+
/** Optional. The maximum number of results to return. The service can return fewer than this number. If omitted or set to `0`, the default is `50` results per page. The maximum allowed value is `100`. `page_size` values greater than `100` default to `100`. */
|
|
3461
3543
|
pageSize?: number;
|
|
3462
3544
|
/** Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token. */
|
|
3463
3545
|
pageToken?: string;
|
|
@@ -3470,6 +3552,64 @@ declare namespace gapi.client {
|
|
|
3470
3552
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3471
3553
|
uploadType?: string;
|
|
3472
3554
|
}): Request<ListPoliciesResponse>;
|
|
3555
|
+
/** Update a policy. */
|
|
3556
|
+
patch(request: {
|
|
3557
|
+
/** V1 error format. */
|
|
3558
|
+
'$.xgafv'?: '1' | '2';
|
|
3559
|
+
/** OAuth access token. */
|
|
3560
|
+
access_token?: string;
|
|
3561
|
+
/** Data format for response. */
|
|
3562
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3563
|
+
/** JSONP */
|
|
3564
|
+
callback?: string;
|
|
3565
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3566
|
+
fields?: string;
|
|
3567
|
+
/** 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. */
|
|
3568
|
+
key?: string;
|
|
3569
|
+
/** Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}. */
|
|
3570
|
+
name: string;
|
|
3571
|
+
/** OAuth 2.0 token for the current user. */
|
|
3572
|
+
oauth_token?: string;
|
|
3573
|
+
/** Returns response with indentations and line breaks. */
|
|
3574
|
+
prettyPrint?: boolean;
|
|
3575
|
+
/** 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. */
|
|
3576
|
+
quotaUser?: string;
|
|
3577
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3578
|
+
upload_protocol?: string;
|
|
3579
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3580
|
+
uploadType?: string;
|
|
3581
|
+
/** Request body */
|
|
3582
|
+
resource: Policy;
|
|
3583
|
+
}): Request<Operation>;
|
|
3584
|
+
patch(
|
|
3585
|
+
request: {
|
|
3586
|
+
/** V1 error format. */
|
|
3587
|
+
'$.xgafv'?: '1' | '2';
|
|
3588
|
+
/** OAuth access token. */
|
|
3589
|
+
access_token?: string;
|
|
3590
|
+
/** Data format for response. */
|
|
3591
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3592
|
+
/** JSONP */
|
|
3593
|
+
callback?: string;
|
|
3594
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3595
|
+
fields?: string;
|
|
3596
|
+
/** 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. */
|
|
3597
|
+
key?: string;
|
|
3598
|
+
/** Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}. */
|
|
3599
|
+
name: string;
|
|
3600
|
+
/** OAuth 2.0 token for the current user. */
|
|
3601
|
+
oauth_token?: string;
|
|
3602
|
+
/** Returns response with indentations and line breaks. */
|
|
3603
|
+
prettyPrint?: boolean;
|
|
3604
|
+
/** 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. */
|
|
3605
|
+
quotaUser?: string;
|
|
3606
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3607
|
+
upload_protocol?: string;
|
|
3608
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3609
|
+
uploadType?: string;
|
|
3610
|
+
},
|
|
3611
|
+
body: Policy,
|
|
3612
|
+
): Request<Operation>;
|
|
3473
3613
|
}
|
|
3474
3614
|
|
|
3475
3615
|
const customers: CustomersResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Cloud Identity API:
|
|
|
11
11
|
npm install @types/gapi.client.cloudidentity-v1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.cloudidentity-v1"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|
|
@@ -246,6 +263,16 @@ Updates an InboundSsoAssignment. The body of this request is the `inbound_sso_as
|
|
|
246
263
|
*/
|
|
247
264
|
await gapi.client.cloudidentity.inboundSsoAssignments.patch({name: 'name'});
|
|
248
265
|
|
|
266
|
+
/*
|
|
267
|
+
Create a policy.
|
|
268
|
+
*/
|
|
269
|
+
await gapi.client.cloudidentity.policies.create({});
|
|
270
|
+
|
|
271
|
+
/*
|
|
272
|
+
Delete a policy.
|
|
273
|
+
*/
|
|
274
|
+
await gapi.client.cloudidentity.policies.delete({name: 'name'});
|
|
275
|
+
|
|
249
276
|
/*
|
|
250
277
|
Get a policy.
|
|
251
278
|
*/
|
|
@@ -255,6 +282,11 @@ await gapi.client.cloudidentity.policies.get({name: 'name'});
|
|
|
255
282
|
List policies.
|
|
256
283
|
*/
|
|
257
284
|
await gapi.client.cloudidentity.policies.list({});
|
|
285
|
+
|
|
286
|
+
/*
|
|
287
|
+
Update a policy.
|
|
288
|
+
*/
|
|
289
|
+
await gapi.client.cloudidentity.policies.patch({name: 'name'});
|
|
258
290
|
```
|
|
259
291
|
|
|
260
292
|
For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.cloudidentity-v1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)
|