From 8611287c987b6cb1b1215634cdae5fd8b814befd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Dec 2024 07:10:18 +0000 Subject: [PATCH] feat(cloudidentity): update the api #### cloudidentity:v1 The following keys were added: - resources.policies.methods.get (Total Keys: 11) - resources.policies.methods.list (Total Keys: 14) - schemas.ListPoliciesResponse (Total Keys: 5) - schemas.Policy (Total Keys: 17) - schemas.Setting (Total Keys: 5) --- docs/dyn/cloudidentity_v1.html | 5 + docs/dyn/cloudidentity_v1.policies.html | 182 ++++++++++++++++++ .../documents/cloudidentity.v1.json | 172 ++++++++++++++++- .../documents/cloudidentity.v1beta1.json | 2 +- 4 files changed, 359 insertions(+), 2 deletions(-) create mode 100644 docs/dyn/cloudidentity_v1.policies.html diff --git a/docs/dyn/cloudidentity_v1.html b/docs/dyn/cloudidentity_v1.html index 2b319ff016f..c19e9525f54 100644 --- a/docs/dyn/cloudidentity_v1.html +++ b/docs/dyn/cloudidentity_v1.html @@ -99,6 +99,11 @@

Instance Methods

Returns the inboundSsoAssignments Resource.

+

+ policies() +

+

Returns the policies Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/cloudidentity_v1.policies.html b/docs/dyn/cloudidentity_v1.policies.html new file mode 100644 index 00000000000..3d279b75a63 --- /dev/null +++ b/docs/dyn/cloudidentity_v1.policies.html @@ -0,0 +1,182 @@ + + + +

Cloud Identity API . policies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Policy

+

+ list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

List Policies

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Get a Policy
+
+Args:
+  name: string, Required. The name of the policy to retrieve. Format: "policies/{policy}". (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
+  "customer": "A String", # Immutable. Customer that the Policy belongs to. The value is in the format 'customers/{customerId}'. The `customerId` must begin with "C" To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
+  "name": "A String", # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
+  "policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
+    "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
+    "orgUnit": "A String", # 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.
+    "query": "A String", # 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.
+    "sortOrder": 3.14, # 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).
+  },
+  "setting": { # Setting # Required. The Setting configured by this Policy.
+    "type": "A String", # Required. Immutable. The type of the Setting. .
+    "value": { # Required. The value of the Setting.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "type": "A String", # Output only. The type of the policy.
+}
+
+ +
+ list(filter=None, pageSize=None, pageToken=None, x__xgafv=None) + 
List Policies
+
+Args:
+  filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.name = 'settings/gmail.*' Policies can be filtered by setting type with this expression: setting.name = '*.service_status' A maximum of one of the above setting.name clauses can be used. Policies can be filtered by customer with this expression: 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. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.
+  pageSize: integer, 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.
+  pageToken: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for PoliciesService.ListPolicies.
+  "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+  "policies": [ # The results
+    { # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
+      "customer": "A String", # Immutable. Customer that the Policy belongs to. The value is in the format 'customers/{customerId}'. The `customerId` must begin with "C" To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
+      "name": "A String", # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
+      "policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
+        "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
+        "orgUnit": "A String", # 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.
+        "query": "A String", # 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.
+        "sortOrder": 3.14, # 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).
+      },
+      "setting": { # Setting # Required. The Setting configured by this Policy.
+        "type": "A String", # Required. Immutable. The type of the Setting. .
+        "value": { # Required. The value of the Setting.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "type": "A String", # Output only. The type of the policy.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index 3097436c1c9..904a7c95f78 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -23,6 +23,12 @@ "https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly": { "description": "See all of the Inbound SSO profiles and their assignments to any Org Units or Google Groups in your Cloud Identity Organization." }, +"https://www.googleapis.com/auth/cloud-identity.policies": { +"description": "See and edit policies in your Cloud Identity Organization." +}, +"https://www.googleapis.com/auth/cloud-identity.policies.readonly": { +"description": "See policies in your Cloud Identity Organization." +}, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } @@ -2014,9 +2020,72 @@ ] } } +}, +"policies": { +"methods": { +"get": { +"description": "Get a Policy", +"flatPath": "v1/policies/{policiesId}", +"httpMethod": "GET", +"id": "cloudidentity.policies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the policy to retrieve. Format: \"policies/{policy}\".", +"location": "path", +"pattern": "^policies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-identity.policies", +"https://www.googleapis.com/auth/cloud-identity.policies.readonly" +] +}, +"list": { +"description": "List Policies", +"flatPath": "v1/policies", +"httpMethod": "GET", +"id": "cloudidentity.policies.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.name = 'settings/gmail.*' Policies can be filtered by setting type with this expression: setting.name = '*.service_status' A maximum of one of the above setting.name clauses can be used. Policies can be filtered by customer with this expression: 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. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "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.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "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.", +"location": "query", +"type": "string" +} +}, +"path": "v1/policies", +"response": { +"$ref": "ListPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-identity.policies", +"https://www.googleapis.com/auth/cloud-identity.policies.readonly" +] +} +} } }, -"revision": "20241126", +"revision": "20241208", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -3607,6 +3676,24 @@ }, "type": "object" }, +"ListPoliciesResponse": { +"description": "The response message for PoliciesService.ListPolicies.", +"id": "ListPoliciesResponse", +"properties": { +"nextPageToken": { +"description": "The pagination token to retrieve the next page of results. If this field is empty, there are no subsequent pages.", +"type": "string" +}, +"policies": { +"description": "The results", +"items": { +"$ref": "Policy" +}, +"type": "array" +} +}, +"type": "object" +}, "ListUserInvitationsResponse": { "description": "Response message for UserInvitation listing request.", "id": "ListUserInvitationsResponse", @@ -3960,6 +4047,70 @@ }, "type": "object" }, +"Policy": { +"description": "A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.", +"id": "Policy", +"properties": { +"customer": { +"description": "Immutable. Customer that the Policy belongs to. The value is in the format 'customers/{customerId}'. The `customerId` must begin with \"C\" To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.", +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.", +"readOnly": true, +"type": "string" +}, +"policyQuery": { +"$ref": "PolicyQuery", +"description": "Required. The PolicyQuery the Setting applies to." +}, +"setting": { +"$ref": "Setting", +"description": "Required. The Setting configured by this Policy." +}, +"type": { +"description": "Output only. The type of the policy.", +"enum": [ +"POLICY_TYPE_UNSPECIFIED", +"SYSTEM", +"ADMIN" +], +"enumDescriptions": [ +"Unspecified policy type.", +"Policy type denoting the system-configured policies.", +"Policy type denoting the admin-configurable policies." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PolicyQuery": { +"description": "PolicyQuery", +"id": "PolicyQuery", +"properties": { +"group": { +"description": "Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.", +"type": "string" +}, +"orgUnit": { +"description": "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.", +"type": "string" +}, +"query": { +"description": "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.", +"type": "string" +}, +"sortOrder": { +"description": "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).", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, "RestrictionEvaluation": { "description": "The evaluated state of this restriction.", "id": "RestrictionEvaluation", @@ -4154,6 +4305,25 @@ "properties": {}, "type": "object" }, +"Setting": { +"description": "Setting", +"id": "Setting", +"properties": { +"type": { +"description": "Required. Immutable. The type of the Setting. .", +"type": "string" +}, +"value": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. The value of the Setting.", +"type": "object" +} +}, +"type": "object" +}, "SignInBehavior": { "description": "Controls sign-in behavior.", "id": "SignInBehavior", diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index c405598be0f..7e435d84a73 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2110,7 +2110,7 @@ } } }, -"revision": "20241126", +"revision": "20241210", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": {