1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudidentity_v1.html">Cloud Identity API</a> . <a href="cloudidentity_v1.groups.html">groups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="cloudidentity_v1.groups.memberships.html">memberships()</a></code> 79</p> 80<p class="firstline">Returns the memberships Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a Group.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes a `Group`.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Retrieves a `Group`.</p> 94<p class="toc_element"> 95 <code><a href="#getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Get Security Settings</p> 97<p class="toc_element"> 98 <code><a href="#list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Lists the `Group` resources under a customer or namespace.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.</p> 106<p class="toc_element"> 107 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 108<p class="firstline">Updates a `Group`.</p> 109<p class="toc_element"> 110 <code><a href="#search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</a></code></p> 111<p class="firstline">Searches for `Group` resources matching a specified query.</p> 112<p class="toc_element"> 113 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p> 114<p class="firstline">Retrieves the next page of results.</p> 115<p class="toc_element"> 116 <code><a href="#updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 117<p class="firstline">Update Security Settings</p> 118<h3>Method Details</h3> 119<div class="method"> 120 <code class="details" id="close">close()</code> 121 <pre>Close httplib2 connections.</pre> 122</div> 123 124<div class="method"> 125 <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code> 126 <pre>Creates a Group. 127 128Args: 129 body: object, The request body. 130 The object takes the form of: 131 132{ # 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. 133 "createTime": "A String", # Output only. The time when the `Group` was created. 134 "description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. 135 "displayName": "A String", # The display name of the `Group`. 136 "dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status. 137 "queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups. 138 { # Defines a query on a resource. 139 "query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')` 140 "resourceType": "A String", # Resource type for the Dynamic Group Query 141 }, 142 ], 143 "status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group. 144 "status": "A String", # Status of the dynamic group. 145 "statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. 146 }, 147 }, 148 "groupKey": { # 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. # Required. Immutable. The `EntityKey` of the `Group`. 149 "id": "A String", # The ID of the entity. For Google-managed entities, the `id` should 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's requirements. Must be unique within a `namespace`. 150 "namespace": "A 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}`. 151 }, 152 "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. 153 "a_key": "A String", 154 }, 155 "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`. 156 "parent": "A String", # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with "C" (for example, 'C046psxkn'). 157 "updateTime": "A String", # Output only. The time when the `Group` was last updated. 158} 159 160 initialGroupConfig: string, Optional. The initial configuration option for the `Group`. 161 Allowed values 162 INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used. 163 WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`. 164 EMPTY - An empty group is created without any initial owners. This can only be used by admins of the domain. 165 x__xgafv: string, V1 error format. 166 Allowed values 167 1 - v1 error format 168 2 - v2 error format 169 170Returns: 171 An object of the form: 172 173 { # This resource represents a long-running operation that is the result of a network API call. 174 "done": 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. 175 "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation. 176 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 177 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 178 { 179 "a_key": "", # Properties of the object. Contains field @type with type URL. 180 }, 181 ], 182 "message": "A String", # 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. 183 }, 184 "metadata": { # 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. 185 "a_key": "", # Properties of the object. Contains field @type with type URL. 186 }, 187 "name": "A String", # 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}`. 188 "response": { # 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`. 189 "a_key": "", # Properties of the object. Contains field @type with type URL. 190 }, 191}</pre> 192</div> 193 194<div class="method"> 195 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 196 <pre>Deletes a `Group`. 197 198Args: 199 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}`. (required) 200 x__xgafv: string, V1 error format. 201 Allowed values 202 1 - v1 error format 203 2 - v2 error format 204 205Returns: 206 An object of the form: 207 208 { # This resource represents a long-running operation that is the result of a network API call. 209 "done": 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. 210 "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation. 211 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 212 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 213 { 214 "a_key": "", # Properties of the object. Contains field @type with type URL. 215 }, 216 ], 217 "message": "A String", # 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. 218 }, 219 "metadata": { # 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. 220 "a_key": "", # Properties of the object. Contains field @type with type URL. 221 }, 222 "name": "A String", # 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}`. 223 "response": { # 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`. 224 "a_key": "", # Properties of the object. Contains field @type with type URL. 225 }, 226}</pre> 227</div> 228 229<div class="method"> 230 <code class="details" id="get">get(name, x__xgafv=None)</code> 231 <pre>Retrieves a `Group`. 232 233Args: 234 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}`. (required) 235 x__xgafv: string, V1 error format. 236 Allowed values 237 1 - v1 error format 238 2 - v2 error format 239 240Returns: 241 An object of the form: 242 243 { # 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. 244 "createTime": "A String", # Output only. The time when the `Group` was created. 245 "description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. 246 "displayName": "A String", # The display name of the `Group`. 247 "dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status. 248 "queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups. 249 { # Defines a query on a resource. 250 "query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')` 251 "resourceType": "A String", # Resource type for the Dynamic Group Query 252 }, 253 ], 254 "status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group. 255 "status": "A String", # Status of the dynamic group. 256 "statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. 257 }, 258 }, 259 "groupKey": { # 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. # Required. Immutable. The `EntityKey` of the `Group`. 260 "id": "A String", # The ID of the entity. For Google-managed entities, the `id` should 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's requirements. Must be unique within a `namespace`. 261 "namespace": "A 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}`. 262 }, 263 "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. 264 "a_key": "A String", 265 }, 266 "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`. 267 "parent": "A String", # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with "C" (for example, 'C046psxkn'). 268 "updateTime": "A String", # Output only. The time when the `Group` was last updated. 269}</pre> 270</div> 271 272<div class="method"> 273 <code class="details" id="getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</code> 274 <pre>Get Security Settings 275 276Args: 277 name: string, Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings` (required) 278 readMask: string, Field-level read mask of which fields to return. "*" returns all fields. If not specified, all fields will be returned. May only contain the following field: `member_restriction`. 279 x__xgafv: string, V1 error format. 280 Allowed values 281 1 - v1 error format 282 2 - v2 error format 283 284Returns: 285 An object of the form: 286 287 { # The definition of security settings. 288 "memberRestriction": { # The definition of MemberRestriction # The Member Restriction value 289 "evaluation": { # The evaluated state of this restriction. # The evaluated state of this restriction on a group. 290 "state": "A String", # Output only. The current state of the restriction 291 }, 292 "query": "A String", # Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&&`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 && member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3` 293 }, 294 "name": "A String", # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. 295}</pre> 296</div> 297 298<div class="method"> 299 <code class="details" id="list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</code> 300 <pre>Lists the `Group` resources under a customer or namespace. 301 302Args: 303 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`. 304 pageToken: string, The `next_page_token` value returned from a previous list request, if any. 305 parent: string, Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with "C" (for example, 'C046psxkn'). 306 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`. 307 Allowed values 308 VIEW_UNSPECIFIED - Default. Should not be used. 309 BASIC - Only basic resource information is returned. 310 FULL - All resource information is returned. 311 x__xgafv: string, V1 error format. 312 Allowed values 313 1 - v1 error format 314 2 - v2 error format 315 316Returns: 317 An object of the form: 318 319 { # Response message for ListGroups operation. 320 "groups": [ # Groups returned in response to list request. The results are not sorted. 321 { # 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. 322 "createTime": "A String", # Output only. The time when the `Group` was created. 323 "description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. 324 "displayName": "A String", # The display name of the `Group`. 325 "dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status. 326 "queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups. 327 { # Defines a query on a resource. 328 "query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')` 329 "resourceType": "A String", # Resource type for the Dynamic Group Query 330 }, 331 ], 332 "status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group. 333 "status": "A String", # Status of the dynamic group. 334 "statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. 335 }, 336 }, 337 "groupKey": { # 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. # Required. Immutable. The `EntityKey` of the `Group`. 338 "id": "A String", # The ID of the entity. For Google-managed entities, the `id` should 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's requirements. Must be unique within a `namespace`. 339 "namespace": "A 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}`. 340 }, 341 "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. 342 "a_key": "A String", 343 }, 344 "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`. 345 "parent": "A String", # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with "C" (for example, 'C046psxkn'). 346 "updateTime": "A String", # Output only. The time when the `Group` was last updated. 347 }, 348 ], 349 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results available for listing. 350}</pre> 351</div> 352 353<div class="method"> 354 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 355 <pre>Retrieves the next page of results. 356 357Args: 358 previous_request: The request for the previous page. (required) 359 previous_response: The response from the request for the previous page. (required) 360 361Returns: 362 A request object that you can call 'execute()' on to request the next 363 page. Returns None if there are no more items in the collection. 364 </pre> 365</div> 366 367<div class="method"> 368 <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code> 369 <pre>Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`. 370 371Args: 372 groupKey_id: string, The ID of the entity. For Google-managed entities, the `id` should 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's requirements. Must be unique within a `namespace`. 373 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}`. 374 x__xgafv: string, V1 error format. 375 Allowed values 376 1 - v1 error format 377 2 - v2 error format 378 379Returns: 380 An object of the form: 381 382 { # The response message for GroupsService.LookupGroupName. 383 "name": "A String", # The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`. 384}</pre> 385</div> 386 387<div class="method"> 388 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 389 <pre>Updates a `Group`. 390 391Args: 392 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}`. (required) 393 body: object, The request body. 394 The object takes the form of: 395 396{ # 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. 397 "createTime": "A String", # Output only. The time when the `Group` was created. 398 "description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. 399 "displayName": "A String", # The display name of the `Group`. 400 "dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status. 401 "queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups. 402 { # Defines a query on a resource. 403 "query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')` 404 "resourceType": "A String", # Resource type for the Dynamic Group Query 405 }, 406 ], 407 "status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group. 408 "status": "A String", # Status of the dynamic group. 409 "statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. 410 }, 411 }, 412 "groupKey": { # 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. # Required. Immutable. The `EntityKey` of the `Group`. 413 "id": "A String", # The ID of the entity. For Google-managed entities, the `id` should 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's requirements. Must be unique within a `namespace`. 414 "namespace": "A 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}`. 415 }, 416 "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. 417 "a_key": "A String", 418 }, 419 "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`. 420 "parent": "A String", # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with "C" (for example, 'C046psxkn'). 421 "updateTime": "A String", # Output only. The time when the `Group` was last updated. 422} 423 424 updateMask: string, Required. The names of fields to update. May only contain the following field names: `display_name`, `description`, `labels`. 425 x__xgafv: string, V1 error format. 426 Allowed values 427 1 - v1 error format 428 2 - v2 error format 429 430Returns: 431 An object of the form: 432 433 { # This resource represents a long-running operation that is the result of a network API call. 434 "done": 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. 435 "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation. 436 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 437 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 438 { 439 "a_key": "", # Properties of the object. Contains field @type with type URL. 440 }, 441 ], 442 "message": "A String", # 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. 443 }, 444 "metadata": { # 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. 445 "a_key": "", # Properties of the object. Contains field @type with type URL. 446 }, 447 "name": "A String", # 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}`. 448 "response": { # 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`. 449 "a_key": "", # Properties of the object. Contains field @type with type URL. 450 }, 451}</pre> 452</div> 453 454<div class="method"> 455 <code class="details" id="search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</code> 456 <pre>Searches for `Group` resources matching a specified query. 457 458Args: 459 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 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. 460 pageToken: string, The `next_page_token` value returned from a previous search request, if any. 461 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 == 'customers/{customer}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). The `customer` must begin with "C" (for example, 'C046psxkn'). 462 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`. 463 Allowed values 464 VIEW_UNSPECIFIED - Default. Should not be used. 465 BASIC - Only basic resource information is returned. 466 FULL - All resource information is returned. 467 x__xgafv: string, V1 error format. 468 Allowed values 469 1 - v1 error format 470 2 - v2 error format 471 472Returns: 473 An object of the form: 474 475 { # The response message for GroupsService.SearchGroups. 476 "groups": [ # The `Group` resources that match the search query. 477 { # 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. 478 "createTime": "A String", # Output only. The time when the `Group` was created. 479 "description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. 480 "displayName": "A String", # The display name of the `Group`. 481 "dynamicGroupMetadata": { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status. 482 "queries": [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups. 483 { # Defines a query on a resource. 484 "query": "A String", # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried). `user.name.value.equalsIgnoreCase('jOhn DoE')` 485 "resourceType": "A String", # Resource type for the Dynamic Group Query 486 }, 487 ], 488 "status": { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group. 489 "status": "A String", # Status of the dynamic group. 490 "statusTime": "A String", # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created. 491 }, 492 }, 493 "groupKey": { # 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. # Required. Immutable. The `EntityKey` of the `Group`. 494 "id": "A String", # The ID of the entity. For Google-managed entities, the `id` should 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's requirements. Must be unique within a `namespace`. 495 "namespace": "A 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}`. 496 }, 497 "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. 498 "a_key": "A String", 499 }, 500 "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`. 501 "parent": "A String", # 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}` for external- identity-mapped groups or `customers/{customer}` for Google Groups. The `customer` must begin with "C" (for example, 'C046psxkn'). 502 "updateTime": "A String", # Output only. The time when the `Group` was last updated. 503 }, 504 ], 505 "nextPageToken": "A String", # A continuation token to retrieve the next page of results, or empty if there are no more results available. 506}</pre> 507</div> 508 509<div class="method"> 510 <code class="details" id="search_next">search_next(previous_request, previous_response)</code> 511 <pre>Retrieves the next page of results. 512 513Args: 514 previous_request: The request for the previous page. (required) 515 previous_response: The response from the request for the previous page. (required) 516 517Returns: 518 A request object that you can call 'execute()' on to request the next 519 page. Returns None if there are no more items in the collection. 520 </pre> 521</div> 522 523<div class="method"> 524 <code class="details" id="updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</code> 525 <pre>Update Security Settings 526 527Args: 528 name: string, Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. (required) 529 body: object, The request body. 530 The object takes the form of: 531 532{ # The definition of security settings. 533 "memberRestriction": { # The definition of MemberRestriction # The Member Restriction value 534 "evaluation": { # The evaluated state of this restriction. # The evaluated state of this restriction on a group. 535 "state": "A String", # Output only. The current state of the restriction 536 }, 537 "query": "A String", # Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&&`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 && member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3` 538 }, 539 "name": "A String", # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. 540} 541 542 updateMask: string, Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`. 543 x__xgafv: string, V1 error format. 544 Allowed values 545 1 - v1 error format 546 2 - v2 error format 547 548Returns: 549 An object of the form: 550 551 { # This resource represents a long-running operation that is the result of a network API call. 552 "done": 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. 553 "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation. 554 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 555 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 556 { 557 "a_key": "", # Properties of the object. Contains field @type with type URL. 558 }, 559 ], 560 "message": "A String", # 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. 561 }, 562 "metadata": { # 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. 563 "a_key": "", # Properties of the object. Contains field @type with type URL. 564 }, 565 "name": "A String", # 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}`. 566 "response": { # 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`. 567 "a_key": "", # Properties of the object. Contains field @type with type URL. 568 }, 569}</pre> 570</div> 571 572</body></html>