Cloud Identity API . policies

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 within the whole 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 AND operator.
  pageSize: integer, Optional. The maximum number of results to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will default to 50. The maximum allowed value is 100, though requests with page_size greater than that will be interpreted as 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 within the whole 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.