<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="cloudidentity_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="cloudidentity_v1beta1.groups.memberships.html">memberships()</a></code>
</p>
<p class="firstline">Returns the memberships Resource.</p>

<p class="toc_element">
  <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a `Group`.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a `Group`.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a `Group`.</p>
<p class="toc_element">
  <code><a href="#list">list(pageSize=None, view=None, parent=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the `Group`s under a customer or namespace.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p>
<p class="firstline">Looks up the [resource</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a `Group`.</p>
<p class="toc_element">
  <code><a href="#search">search(view=None, pageToken=None, query=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches for `Group`s matching a specified query.</p>
<p class="toc_element">
  <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
  <pre>Creates a `Group`.

Args:
  body: object, The request body.
    The object takes the form of:

{ # A group within the Cloud Identity Groups API.
      # 
      # A `Group` is a collection of entities, where each entity is either a user,
      # another group or a service account.
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
    &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
        #
        # An entity can represent either a group with an optional `namespace` or a user
        # without a `namespace`. The combination of `id` and `namespace` must be
        # unique; however, the same `id` can be used with different `namespace`s.
      &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
          #
          # If not specified, the `EntityKey` represents a Google-managed entity such
          # as a Google user or a Google Group.
          #
          # If specified, the `EntityKey` represents an external-identity-mapped group.
          # The namespace must correspond to an identity source created in Admin
          # Console and must be in the form of `identitysources/{identity_source_id}.
      &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
          #
          # For Google-managed entities, the `id` must be the email address of an
          # existing group or user.
          #
          # For external-identity-mapped entities, the `id` must be a string conforming
          # to the Identity Source&#x27;s requirements.
          #
          # Must be unique within a `namespace`.
    },
    &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
        # 
        # Must not be longer than 4,096 characters.
    &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
      { # A unique identifier for an entity in the Cloud Identity Groups API.
          #
          # An entity can represent either a group with an optional `namespace` or a user
          # without a `namespace`. The combination of `id` and `namespace` must be
          # unique; however, the same `id` can be used with different `namespace`s.
        &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
            #
            # If not specified, the `EntityKey` represents a Google-managed entity such
            # as a Google user or a Google Group.
            #
            # If specified, the `EntityKey` represents an external-identity-mapped group.
            # The namespace must correspond to an identity source created in Admin
            # Console and must be in the form of `identitysources/{identity_source_id}.
        &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
            #
            # For Google-managed entities, the `id` must be the email address of an
            # existing group or user.
            #
            # For external-identity-mapped entities, the `id` must be a string conforming
            # to the Identity Source&#x27;s requirements.
            #
            # Must be unique within a `namespace`.
      },
    ],
    &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
        # Cloud Identity resource hierarchy.
        # 
        # Must be of the form `identitysources/{identity_source_id}` for external-
        # identity-mapped groups or `customers/{customer_id}` for Google Groups.
    &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
        # 
        # Must not contain more than one entry. Must contain the entry
        # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
        # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
        # external-identity-mapped group.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
    &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
        # the `Group`.
        # 
        # Shall be of the form `groups/{group_id}`.
    &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
  }

  initialGroupConfig: string, Required. The initial configuration option for the `Group`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a `Group`.

Args:
  name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
the `Group` to retrieve.

Must be of the form `groups/{group_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Retrieves a `Group`.

Args:
  name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of
the `Group` to retrieve.

Must be of the form `groups/{group_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A group within the Cloud Identity Groups API.
        #
        # A `Group` is a collection of entities, where each entity is either a user,
        # another group or a service account.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
      &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
          #
          # An entity can represent either a group with an optional `namespace` or a user
          # without a `namespace`. The combination of `id` and `namespace` must be
          # unique; however, the same `id` can be used with different `namespace`s.
        &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
            #
            # If not specified, the `EntityKey` represents a Google-managed entity such
            # as a Google user or a Google Group.
            #
            # If specified, the `EntityKey` represents an external-identity-mapped group.
            # The namespace must correspond to an identity source created in Admin
            # Console and must be in the form of `identitysources/{identity_source_id}.
        &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
            #
            # For Google-managed entities, the `id` must be the email address of an
            # existing group or user.
            #
            # For external-identity-mapped entities, the `id` must be a string conforming
            # to the Identity Source&#x27;s requirements.
            #
            # Must be unique within a `namespace`.
      },
      &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
          #
          # Must not be longer than 4,096 characters.
      &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
        { # A unique identifier for an entity in the Cloud Identity Groups API.
            #
            # An entity can represent either a group with an optional `namespace` or a user
            # without a `namespace`. The combination of `id` and `namespace` must be
            # unique; however, the same `id` can be used with different `namespace`s.
          &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
              #
              # If not specified, the `EntityKey` represents a Google-managed entity such
              # as a Google user or a Google Group.
              #
              # If specified, the `EntityKey` represents an external-identity-mapped group.
              # The namespace must correspond to an identity source created in Admin
              # Console and must be in the form of `identitysources/{identity_source_id}.
          &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
              #
              # For Google-managed entities, the `id` must be the email address of an
              # existing group or user.
              #
              # For external-identity-mapped entities, the `id` must be a string conforming
              # to the Identity Source&#x27;s requirements.
              #
              # Must be unique within a `namespace`.
        },
      ],
      &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
          # Cloud Identity resource hierarchy.
          #
          # Must be of the form `identitysources/{identity_source_id}` for external-
          # identity-mapped groups or `customers/{customer_id}` for Google Groups.
      &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
          #
          # Must not contain more than one entry. Must contain the entry
          # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
          # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
          # external-identity-mapped group.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
      &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
          # the `Group`.
          #
          # Shall be of the form `groups/{group_id}`.
      &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(pageSize=None, view=None, parent=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the `Group`s under a customer or namespace.

Args:
  pageSize: integer, The maximum number of results to return.

Note that the number of results returned may be less than this value even
if there are more available results. To fetch all results, clients must
continue calling this method repeatedly until the response no longer
contains a `next_page_token`.

If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`.

Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
  view: string, The level of detail to be returned.

If unspecified, defaults to `View.BASIC`.
  parent: string, Required. The parent resource under which to list all `Group`s.

Must be of the form `identitysources/{identity_source_id}` for external-
identity-mapped groups or `customers/{customer_id}` for Google Groups.
  pageToken: string, The `next_page_token` value returned from a previous list request, if any.
  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 GroupsService.ListGroups.
    &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if
        # there are no more results available.
    &quot;groups&quot;: [ # The `Group`s under the specified `parent`.
      { # A group within the Cloud Identity Groups API.
            #
            # A `Group` is a collection of entities, where each entity is either a user,
            # another group or a service account.
          &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
          &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
              #
              # An entity can represent either a group with an optional `namespace` or a user
              # without a `namespace`. The combination of `id` and `namespace` must be
              # unique; however, the same `id` can be used with different `namespace`s.
            &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
                #
                # If not specified, the `EntityKey` represents a Google-managed entity such
                # as a Google user or a Google Group.
                #
                # If specified, the `EntityKey` represents an external-identity-mapped group.
                # The namespace must correspond to an identity source created in Admin
                # Console and must be in the form of `identitysources/{identity_source_id}.
            &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
                #
                # For Google-managed entities, the `id` must be the email address of an
                # existing group or user.
                #
                # For external-identity-mapped entities, the `id` must be a string conforming
                # to the Identity Source&#x27;s requirements.
                #
                # Must be unique within a `namespace`.
          },
          &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
              #
              # Must not be longer than 4,096 characters.
          &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
            { # A unique identifier for an entity in the Cloud Identity Groups API.
                #
                # An entity can represent either a group with an optional `namespace` or a user
                # without a `namespace`. The combination of `id` and `namespace` must be
                # unique; however, the same `id` can be used with different `namespace`s.
              &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
                  #
                  # If not specified, the `EntityKey` represents a Google-managed entity such
                  # as a Google user or a Google Group.
                  #
                  # If specified, the `EntityKey` represents an external-identity-mapped group.
                  # The namespace must correspond to an identity source created in Admin
                  # Console and must be in the form of `identitysources/{identity_source_id}.
              &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
                  #
                  # For Google-managed entities, the `id` must be the email address of an
                  # existing group or user.
                  #
                  # For external-identity-mapped entities, the `id` must be a string conforming
                  # to the Identity Source&#x27;s requirements.
                  #
                  # Must be unique within a `namespace`.
            },
          ],
          &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
              # Cloud Identity resource hierarchy.
              #
              # Must be of the form `identitysources/{identity_source_id}` for external-
              # identity-mapped groups or `customers/{customer_id}` for Google Groups.
          &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
              #
              # Must not contain more than one entry. Must contain the entry
              # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
              # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
              # external-identity-mapped group.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
          &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
              # the `Group`.
              #
              # Shall be of the form `groups/{group_id}`.
          &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
        },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
  <pre>Looks up the [resource
name](https://cloud.google.com/apis/design/resource_names) of a `Group` by
its `EntityKey`.

Args:
  groupKey_id: string, The ID of the entity.

For Google-managed entities, the `id` must be the email address of an
existing group or user.

For external-identity-mapped entities, the `id` must be a string conforming
to the Identity Source&#x27;s requirements.

Must be unique within a `namespace`.
  groupKey_namespace: string, The namespace in which the entity exists.

If not specified, the `EntityKey` represents a Google-managed entity such
as a Google user or a Google Group.

If specified, the `EntityKey` represents an external-identity-mapped group.
The namespace must correspond to an identity source created in Admin
Console and must be in the form of `identitysources/{identity_source_id}.
  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 GroupsService.LookupGroupName.
    &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
        # the looked-up `Group`.
  }</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates a `Group`.

Args:
  name: string, Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
the `Group`.

Shall be of the form `groups/{group_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A group within the Cloud Identity Groups API.
      # 
      # A `Group` is a collection of entities, where each entity is either a user,
      # another group or a service account.
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
    &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
        #
        # An entity can represent either a group with an optional `namespace` or a user
        # without a `namespace`. The combination of `id` and `namespace` must be
        # unique; however, the same `id` can be used with different `namespace`s.
      &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
          #
          # If not specified, the `EntityKey` represents a Google-managed entity such
          # as a Google user or a Google Group.
          #
          # If specified, the `EntityKey` represents an external-identity-mapped group.
          # The namespace must correspond to an identity source created in Admin
          # Console and must be in the form of `identitysources/{identity_source_id}.
      &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
          #
          # For Google-managed entities, the `id` must be the email address of an
          # existing group or user.
          #
          # For external-identity-mapped entities, the `id` must be a string conforming
          # to the Identity Source&#x27;s requirements.
          #
          # Must be unique within a `namespace`.
    },
    &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
        # 
        # Must not be longer than 4,096 characters.
    &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
      { # A unique identifier for an entity in the Cloud Identity Groups API.
          #
          # An entity can represent either a group with an optional `namespace` or a user
          # without a `namespace`. The combination of `id` and `namespace` must be
          # unique; however, the same `id` can be used with different `namespace`s.
        &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
            #
            # If not specified, the `EntityKey` represents a Google-managed entity such
            # as a Google user or a Google Group.
            #
            # If specified, the `EntityKey` represents an external-identity-mapped group.
            # The namespace must correspond to an identity source created in Admin
            # Console and must be in the form of `identitysources/{identity_source_id}.
        &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
            #
            # For Google-managed entities, the `id` must be the email address of an
            # existing group or user.
            #
            # For external-identity-mapped entities, the `id` must be a string conforming
            # to the Identity Source&#x27;s requirements.
            #
            # Must be unique within a `namespace`.
      },
    ],
    &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
        # Cloud Identity resource hierarchy.
        # 
        # Must be of the form `identitysources/{identity_source_id}` for external-
        # identity-mapped groups or `customers/{customer_id}` for Google Groups.
    &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
        # 
        # Must not contain more than one entry. Must contain the entry
        # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
        # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
        # external-identity-mapped group.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
    &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
        # the `Group`.
        # 
        # Shall be of the form `groups/{group_id}`.
    &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
  }

  updateMask: string, Required. The fully-qualified names of fields to update.

May only contain the following fields: `display_name`, `description`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="search">search(view=None, pageToken=None, query=None, pageSize=None, x__xgafv=None)</code>
  <pre>Searches for `Group`s matching a specified query.

Args:
  view: string, The level of detail to be returned.

If unspecified, defaults to `View.BASIC`.
  pageToken: string, The `next_page_token` value returned from a previous search request, if
any.
  query: string, Required. The search query.

Must be specified in [Common Expression
Language](https://opensource.google/projects/cel). May only contain
equality operators on the parent and inclusion operators on labels (e.g.,
`parent == &#x27;customers/{customer_id}&#x27; &amp;&amp;
&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27; in labels`).
  pageSize: integer, The maximum number of results to return.

Note that the number of results returned may be less than this value even
if there are more available results. To fetch all results, clients must
continue calling this method repeatedly until the response no longer
contains a `next_page_token`.

If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for
`GroupView.FULL`.

Must not be greater than 1000 for `GroupView.BASIC` or 500 for
`GroupView.FULL`.
  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 GroupsService.SearchGroups.
    &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if
        # there are no more results available.
    &quot;groups&quot;: [ # The `Group`s that match the search query.
      { # A group within the Cloud Identity Groups API.
            #
            # A `Group` is a collection of entities, where each entity is either a user,
            # another group or a service account.
          &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
          &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. # Required. Immutable. The `EntityKey` of the `Group`.
              #
              # An entity can represent either a group with an optional `namespace` or a user
              # without a `namespace`. The combination of `id` and `namespace` must be
              # unique; however, the same `id` can be used with different `namespace`s.
            &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
                #
                # If not specified, the `EntityKey` represents a Google-managed entity such
                # as a Google user or a Google Group.
                #
                # If specified, the `EntityKey` represents an external-identity-mapped group.
                # The namespace must correspond to an identity source created in Admin
                # Console and must be in the form of `identitysources/{identity_source_id}.
            &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
                #
                # For Google-managed entities, the `id` must be the email address of an
                # existing group or user.
                #
                # For external-identity-mapped entities, the `id` must be a string conforming
                # to the Identity Source&#x27;s requirements.
                #
                # Must be unique within a `namespace`.
          },
          &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`.
              #
              # Must not be longer than 4,096 characters.
          &quot;additionalGroupKeys&quot;: [ # Additional entity key aliases for a Group.
            { # A unique identifier for an entity in the Cloud Identity Groups API.
                #
                # An entity can represent either a group with an optional `namespace` or a user
                # without a `namespace`. The combination of `id` and `namespace` must be
                # unique; however, the same `id` can be used with different `namespace`s.
              &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists.
                  #
                  # If not specified, the `EntityKey` represents a Google-managed entity such
                  # as a Google user or a Google Group.
                  #
                  # If specified, the `EntityKey` represents an external-identity-mapped group.
                  # The namespace must correspond to an identity source created in Admin
                  # Console and must be in the form of `identitysources/{identity_source_id}.
              &quot;id&quot;: &quot;A String&quot;, # The ID of the entity.
                  #
                  # For Google-managed entities, the `id` must be the email address of an
                  # existing group or user.
                  #
                  # For external-identity-mapped entities, the `id` must be a string conforming
                  # to the Identity Source&#x27;s requirements.
                  #
                  # Must be unique within a `namespace`.
            },
          ],
          &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the
              # Cloud Identity resource hierarchy.
              #
              # Must be of the form `identitysources/{identity_source_id}` for external-
              # identity-mapped groups or `customers/{customer_id}` for Google Groups.
          &quot;labels&quot;: { # Required. The labels that apply to the `Group`.
              #
              # Must not contain more than one entry. Must contain the entry
              # `&#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27;: &#x27;&#x27;` if the `Group`
              # is a Google Group or `&#x27;system/groups/external&#x27;: &#x27;&#x27;` if the `Group` is an
              # external-identity-mapped group.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
          &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of
              # the `Group`.
              #
              # Shall be of the form `groups/{group_id}`.
          &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
        },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

</body></html>