Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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="#create">create(body, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Creates a Group.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Deletes a Group.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Retrieves a Group.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None, view=None)</a></code></p> |
| 93 | <p class="firstline">List groups within a customer or a domain.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">Looks up [resource</p> |
| 100 | <p class="toc_element"> |
| 101 | <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> |
| 102 | <p class="firstline">Updates a Group.</p> |
| 103 | <p class="toc_element"> |
| 104 | <code><a href="#search">search(pageSize=None, pageToken=None, query=None, x__xgafv=None, view=None)</a></code></p> |
| 105 | <p class="firstline">Searches for Groups.</p> |
| 106 | <p class="toc_element"> |
| 107 | <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p> |
| 108 | <p class="firstline">Retrieves the next page of results.</p> |
| 109 | <h3>Method Details</h3> |
| 110 | <div class="method"> |
| 111 | <code class="details" id="create">create(body, x__xgafv=None)</code> |
| 112 | <pre>Creates a Group. |
| 113 | |
| 114 | Args: |
| 115 | body: object, The request body. (required) |
| 116 | The object takes the form of: |
| 117 | |
| 118 | { # Resource representing a Group. |
| 119 | "updateTime": "A String", # The time when the Group was last updated. |
| 120 | # Output only. |
| 121 | "displayName": "A String", # The Group's display name. |
| 122 | "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 123 | # Group in the format: `groups/{group_id}`, where group_id is the unique ID |
| 124 | # assigned to the Group. |
| 125 | # |
| 126 | # Must be left blank while creating a Group. |
| 127 | "parent": "A String", # The entity under which this Group resides in Cloud Identity resource |
| 128 | # hierarchy. Must be set when creating a Group, read-only afterwards. |
| 129 | # |
| 130 | # Currently allowed types: `identitysources`. |
| 131 | "labels": { # `Required`. Labels for Group resource. |
| 132 | # For creating Groups under a namespace, set label key to |
| 133 | # 'labels/system/groups/external' and label value as empty. |
| 134 | "a_key": "A String", |
| 135 | }, |
| 136 | "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the Group. |
| 137 | # |
| 138 | # Must be set when creating a Group, read-only afterwards. |
| 139 | # isolation for IDs. A single ID can be reused across namespaces but the |
| 140 | # combination of a namespace and an ID must be unique. |
| 141 | "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 142 | # within its namespace. |
| 143 | # |
| 144 | # Namespaces are currently only created as part of IdentitySource creation |
| 145 | # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 146 | # created corresponding to every Identity Source `identity_source_id`. |
| 147 | "id": "A String", # The ID of the entity within the given namespace. The ID must be unique |
| 148 | # within its namespace. |
| 149 | }, |
| 150 | "createTime": "A String", # The time when the Group was created. |
| 151 | # Output only. |
| 152 | "description": "A String", # An extended description to help users determine the purpose of a Group. For |
| 153 | # example, you can include information about who should join the Group, the |
| 154 | # types of messages to send to the Group, links to FAQs about the Group, or |
| 155 | # related Groups. Maximum length is 4,096 characters. |
| 156 | } |
| 157 | |
| 158 | x__xgafv: string, V1 error format. |
| 159 | Allowed values |
| 160 | 1 - v1 error format |
| 161 | 2 - v2 error format |
| 162 | |
| 163 | Returns: |
| 164 | An object of the form: |
| 165 | |
| 166 | { # This resource represents a long-running operation that is the result of a |
| 167 | # network API call. |
| 168 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 169 | # contains progress information and common metadata such as create time. |
| 170 | # Some services might not provide such metadata. Any method that returns a |
| 171 | # long-running operation should document the metadata type, if any. |
| 172 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 173 | }, |
| 174 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 175 | # different programming environments, including REST APIs and RPC APIs. It is |
| 176 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 177 | # three pieces of data: error code, error message, and error details. |
| 178 | # |
| 179 | # You can find out more about this error model and how to work with it in the |
| 180 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 181 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 182 | # user-facing error message should be localized and sent in the |
| 183 | # google.rpc.Status.details field, or localized by the client. |
| 184 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 185 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 186 | # message types for APIs to use. |
| 187 | { |
| 188 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 189 | }, |
| 190 | ], |
| 191 | }, |
| 192 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 193 | # If `true`, the operation is completed, and either `error` or `response` is |
| 194 | # available. |
| 195 | "response": { # The normal response of the operation in case of success. If the original |
| 196 | # method returns no data on success, such as `Delete`, the response is |
| 197 | # `google.protobuf.Empty`. If the original method is standard |
| 198 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 199 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 200 | # is the original method name. For example, if the original method name |
| 201 | # is `TakeSnapshot()`, the inferred response type is |
| 202 | # `TakeSnapshotResponse`. |
| 203 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 204 | }, |
| 205 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 206 | # originally returns it. If you use the default HTTP mapping, the |
| 207 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 208 | }</pre> |
| 209 | </div> |
| 210 | |
| 211 | <div class="method"> |
| 212 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 213 | <pre>Deletes a Group. |
| 214 | |
| 215 | Args: |
| 216 | name: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 217 | Group in the format: `groups/{group_id}`, where `group_id` is the unique ID |
| 218 | assigned to the Group. (required) |
| 219 | x__xgafv: string, V1 error format. |
| 220 | Allowed values |
| 221 | 1 - v1 error format |
| 222 | 2 - v2 error format |
| 223 | |
| 224 | Returns: |
| 225 | An object of the form: |
| 226 | |
| 227 | { # This resource represents a long-running operation that is the result of a |
| 228 | # network API call. |
| 229 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 230 | # contains progress information and common metadata such as create time. |
| 231 | # Some services might not provide such metadata. Any method that returns a |
| 232 | # long-running operation should document the metadata type, if any. |
| 233 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 234 | }, |
| 235 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 236 | # different programming environments, including REST APIs and RPC APIs. It is |
| 237 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 238 | # three pieces of data: error code, error message, and error details. |
| 239 | # |
| 240 | # You can find out more about this error model and how to work with it in the |
| 241 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 242 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 243 | # user-facing error message should be localized and sent in the |
| 244 | # google.rpc.Status.details field, or localized by the client. |
| 245 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 246 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 247 | # message types for APIs to use. |
| 248 | { |
| 249 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 250 | }, |
| 251 | ], |
| 252 | }, |
| 253 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 254 | # If `true`, the operation is completed, and either `error` or `response` is |
| 255 | # available. |
| 256 | "response": { # The normal response of the operation in case of success. If the original |
| 257 | # method returns no data on success, such as `Delete`, the response is |
| 258 | # `google.protobuf.Empty`. If the original method is standard |
| 259 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 260 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 261 | # is the original method name. For example, if the original method name |
| 262 | # is `TakeSnapshot()`, the inferred response type is |
| 263 | # `TakeSnapshotResponse`. |
| 264 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 265 | }, |
| 266 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 267 | # originally returns it. If you use the default HTTP mapping, the |
| 268 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 269 | }</pre> |
| 270 | </div> |
| 271 | |
| 272 | <div class="method"> |
| 273 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 274 | <pre>Retrieves a Group. |
| 275 | |
| 276 | Args: |
| 277 | name: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 278 | Group in the format: `groups/{group_id}`, where `group_id` is the unique ID |
| 279 | assigned to the Group. (required) |
| 280 | x__xgafv: string, V1 error format. |
| 281 | Allowed values |
| 282 | 1 - v1 error format |
| 283 | 2 - v2 error format |
| 284 | |
| 285 | Returns: |
| 286 | An object of the form: |
| 287 | |
| 288 | { # Resource representing a Group. |
| 289 | "updateTime": "A String", # The time when the Group was last updated. |
| 290 | # Output only. |
| 291 | "displayName": "A String", # The Group's display name. |
| 292 | "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 293 | # Group in the format: `groups/{group_id}`, where group_id is the unique ID |
| 294 | # assigned to the Group. |
| 295 | # |
| 296 | # Must be left blank while creating a Group. |
| 297 | "parent": "A String", # The entity under which this Group resides in Cloud Identity resource |
| 298 | # hierarchy. Must be set when creating a Group, read-only afterwards. |
| 299 | # |
| 300 | # Currently allowed types: `identitysources`. |
| 301 | "labels": { # `Required`. Labels for Group resource. |
| 302 | # For creating Groups under a namespace, set label key to |
| 303 | # 'labels/system/groups/external' and label value as empty. |
| 304 | "a_key": "A String", |
| 305 | }, |
| 306 | "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the Group. |
| 307 | # |
| 308 | # Must be set when creating a Group, read-only afterwards. |
| 309 | # isolation for IDs. A single ID can be reused across namespaces but the |
| 310 | # combination of a namespace and an ID must be unique. |
| 311 | "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 312 | # within its namespace. |
| 313 | # |
| 314 | # Namespaces are currently only created as part of IdentitySource creation |
| 315 | # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 316 | # created corresponding to every Identity Source `identity_source_id`. |
| 317 | "id": "A String", # The ID of the entity within the given namespace. The ID must be unique |
| 318 | # within its namespace. |
| 319 | }, |
| 320 | "createTime": "A String", # The time when the Group was created. |
| 321 | # Output only. |
| 322 | "description": "A String", # An extended description to help users determine the purpose of a Group. For |
| 323 | # example, you can include information about who should join the Group, the |
| 324 | # types of messages to send to the Group, links to FAQs about the Group, or |
| 325 | # related Groups. Maximum length is 4,096 characters. |
| 326 | }</pre> |
| 327 | </div> |
| 328 | |
| 329 | <div class="method"> |
| 330 | <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None, view=None)</code> |
| 331 | <pre>List groups within a customer or a domain. |
| 332 | |
| 333 | Args: |
| 334 | parent: string, `Required`. May be made Optional in the future. |
| 335 | Customer ID to list all groups from. |
| 336 | pageToken: string, The next_page_token value returned from a previous list request, if any. |
| 337 | x__xgafv: string, V1 error format. |
| 338 | Allowed values |
| 339 | 1 - v1 error format |
| 340 | 2 - v2 error format |
| 341 | pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50 |
| 342 | (max 500) for the FULL view. |
| 343 | view: string, Group resource view to be returned. Defaults to [View.BASIC](). |
| 344 | |
| 345 | Returns: |
| 346 | An object of the form: |
| 347 | |
| 348 | { # Response message for ListGroups operation. |
| 349 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 350 | # more results available for listing. |
| 351 | "groups": [ # Groups returned in response to list request. |
| 352 | # The results are not sorted. |
| 353 | { # Resource representing a Group. |
| 354 | "updateTime": "A String", # The time when the Group was last updated. |
| 355 | # Output only. |
| 356 | "displayName": "A String", # The Group's display name. |
| 357 | "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 358 | # Group in the format: `groups/{group_id}`, where group_id is the unique ID |
| 359 | # assigned to the Group. |
| 360 | # |
| 361 | # Must be left blank while creating a Group. |
| 362 | "parent": "A String", # The entity under which this Group resides in Cloud Identity resource |
| 363 | # hierarchy. Must be set when creating a Group, read-only afterwards. |
| 364 | # |
| 365 | # Currently allowed types: `identitysources`. |
| 366 | "labels": { # `Required`. Labels for Group resource. |
| 367 | # For creating Groups under a namespace, set label key to |
| 368 | # 'labels/system/groups/external' and label value as empty. |
| 369 | "a_key": "A String", |
| 370 | }, |
| 371 | "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the Group. |
| 372 | # |
| 373 | # Must be set when creating a Group, read-only afterwards. |
| 374 | # isolation for IDs. A single ID can be reused across namespaces but the |
| 375 | # combination of a namespace and an ID must be unique. |
| 376 | "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 377 | # within its namespace. |
| 378 | # |
| 379 | # Namespaces are currently only created as part of IdentitySource creation |
| 380 | # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 381 | # created corresponding to every Identity Source `identity_source_id`. |
| 382 | "id": "A String", # The ID of the entity within the given namespace. The ID must be unique |
| 383 | # within its namespace. |
| 384 | }, |
| 385 | "createTime": "A String", # The time when the Group was created. |
| 386 | # Output only. |
| 387 | "description": "A String", # An extended description to help users determine the purpose of a Group. For |
| 388 | # example, you can include information about who should join the Group, the |
| 389 | # types of messages to send to the Group, links to FAQs about the Group, or |
| 390 | # related Groups. Maximum length is 4,096 characters. |
| 391 | }, |
| 392 | ], |
| 393 | }</pre> |
| 394 | </div> |
| 395 | |
| 396 | <div class="method"> |
| 397 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 398 | <pre>Retrieves the next page of results. |
| 399 | |
| 400 | Args: |
| 401 | previous_request: The request for the previous page. (required) |
| 402 | previous_response: The response from the request for the previous page. (required) |
| 403 | |
| 404 | Returns: |
| 405 | A request object that you can call 'execute()' on to request the next |
| 406 | page. Returns None if there are no more items in the collection. |
| 407 | </pre> |
| 408 | </div> |
| 409 | |
| 410 | <div class="method"> |
| 411 | <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code> |
| 412 | <pre>Looks up [resource |
| 413 | name](https://cloud.google.com/apis/design/resource_names) of a Group by |
| 414 | its EntityKey. |
| 415 | |
| 416 | Args: |
| 417 | groupKey_id: string, The ID of the entity within the given namespace. The ID must be unique |
| 418 | within its namespace. |
| 419 | groupKey_namespace: string, Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 420 | within its namespace. |
| 421 | |
| 422 | Namespaces are currently only created as part of IdentitySource creation |
| 423 | from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 424 | created corresponding to every Identity Source `identity_source_id`. |
| 425 | x__xgafv: string, V1 error format. |
| 426 | Allowed values |
| 427 | 1 - v1 error format |
| 428 | 2 - v2 error format |
| 429 | |
| 430 | Returns: |
| 431 | An object of the form: |
| 432 | |
| 433 | { |
| 434 | "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 435 | # Group in the format: `groups/{group_id}`, where `group_id` is the unique ID |
| 436 | # assigned to the Group. |
| 437 | }</pre> |
| 438 | </div> |
| 439 | |
| 440 | <div class="method"> |
| 441 | <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> |
| 442 | <pre>Updates a Group. |
| 443 | |
| 444 | Args: |
| 445 | name: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 446 | Group in the format: `groups/{group_id}`, where group_id is the unique ID |
| 447 | assigned to the Group. |
| 448 | |
| 449 | Must be left blank while creating a Group. (required) |
| 450 | body: object, The request body. (required) |
| 451 | The object takes the form of: |
| 452 | |
| 453 | { # Resource representing a Group. |
| 454 | "updateTime": "A String", # The time when the Group was last updated. |
| 455 | # Output only. |
| 456 | "displayName": "A String", # The Group's display name. |
| 457 | "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 458 | # Group in the format: `groups/{group_id}`, where group_id is the unique ID |
| 459 | # assigned to the Group. |
| 460 | # |
| 461 | # Must be left blank while creating a Group. |
| 462 | "parent": "A String", # The entity under which this Group resides in Cloud Identity resource |
| 463 | # hierarchy. Must be set when creating a Group, read-only afterwards. |
| 464 | # |
| 465 | # Currently allowed types: `identitysources`. |
| 466 | "labels": { # `Required`. Labels for Group resource. |
| 467 | # For creating Groups under a namespace, set label key to |
| 468 | # 'labels/system/groups/external' and label value as empty. |
| 469 | "a_key": "A String", |
| 470 | }, |
| 471 | "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the Group. |
| 472 | # |
| 473 | # Must be set when creating a Group, read-only afterwards. |
| 474 | # isolation for IDs. A single ID can be reused across namespaces but the |
| 475 | # combination of a namespace and an ID must be unique. |
| 476 | "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 477 | # within its namespace. |
| 478 | # |
| 479 | # Namespaces are currently only created as part of IdentitySource creation |
| 480 | # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 481 | # created corresponding to every Identity Source `identity_source_id`. |
| 482 | "id": "A String", # The ID of the entity within the given namespace. The ID must be unique |
| 483 | # within its namespace. |
| 484 | }, |
| 485 | "createTime": "A String", # The time when the Group was created. |
| 486 | # Output only. |
| 487 | "description": "A String", # An extended description to help users determine the purpose of a Group. For |
| 488 | # example, you can include information about who should join the Group, the |
| 489 | # types of messages to send to the Group, links to FAQs about the Group, or |
| 490 | # related Groups. Maximum length is 4,096 characters. |
| 491 | } |
| 492 | |
| 493 | updateMask: string, Editable fields: `display_name`, `description` |
| 494 | x__xgafv: string, V1 error format. |
| 495 | Allowed values |
| 496 | 1 - v1 error format |
| 497 | 2 - v2 error format |
| 498 | |
| 499 | Returns: |
| 500 | An object of the form: |
| 501 | |
| 502 | { # This resource represents a long-running operation that is the result of a |
| 503 | # network API call. |
| 504 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 505 | # contains progress information and common metadata such as create time. |
| 506 | # Some services might not provide such metadata. Any method that returns a |
| 507 | # long-running operation should document the metadata type, if any. |
| 508 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 509 | }, |
| 510 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 511 | # different programming environments, including REST APIs and RPC APIs. It is |
| 512 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 513 | # three pieces of data: error code, error message, and error details. |
| 514 | # |
| 515 | # You can find out more about this error model and how to work with it in the |
| 516 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 517 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 518 | # user-facing error message should be localized and sent in the |
| 519 | # google.rpc.Status.details field, or localized by the client. |
| 520 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 521 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 522 | # message types for APIs to use. |
| 523 | { |
| 524 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 525 | }, |
| 526 | ], |
| 527 | }, |
| 528 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 529 | # If `true`, the operation is completed, and either `error` or `response` is |
| 530 | # available. |
| 531 | "response": { # The normal response of the operation in case of success. If the original |
| 532 | # method returns no data on success, such as `Delete`, the response is |
| 533 | # `google.protobuf.Empty`. If the original method is standard |
| 534 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 535 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 536 | # is the original method name. For example, if the original method name |
| 537 | # is `TakeSnapshot()`, the inferred response type is |
| 538 | # `TakeSnapshotResponse`. |
| 539 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 540 | }, |
| 541 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 542 | # originally returns it. If you use the default HTTP mapping, the |
| 543 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 544 | }</pre> |
| 545 | </div> |
| 546 | |
| 547 | <div class="method"> |
| 548 | <code class="details" id="search">search(pageSize=None, pageToken=None, query=None, x__xgafv=None, view=None)</code> |
| 549 | <pre>Searches for Groups. |
| 550 | |
| 551 | Args: |
| 552 | pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50 |
| 553 | (max 500) for the FULL view. |
| 554 | pageToken: string, The next_page_token value returned from a previous search request, if any. |
| 555 | query: string, `Required`. Query string for performing search on groups. Users can search |
| 556 | on parent and label attributes of groups. |
| 557 | EXACT match ('==') is supported on parent, and CONTAINS match ('in') is |
| 558 | supported on labels. |
| 559 | x__xgafv: string, V1 error format. |
| 560 | Allowed values |
| 561 | 1 - v1 error format |
| 562 | 2 - v2 error format |
| 563 | view: string, Group resource view to be returned. Defaults to [View.BASIC](). |
| 564 | |
| 565 | Returns: |
| 566 | An object of the form: |
| 567 | |
| 568 | { |
| 569 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 570 | # more results available for specified query. |
| 571 | "groups": [ # List of Groups satisfying the search query. |
| 572 | { # Resource representing a Group. |
| 573 | "updateTime": "A String", # The time when the Group was last updated. |
| 574 | # Output only. |
| 575 | "displayName": "A String", # The Group's display name. |
| 576 | "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 577 | # Group in the format: `groups/{group_id}`, where group_id is the unique ID |
| 578 | # assigned to the Group. |
| 579 | # |
| 580 | # Must be left blank while creating a Group. |
| 581 | "parent": "A String", # The entity under which this Group resides in Cloud Identity resource |
| 582 | # hierarchy. Must be set when creating a Group, read-only afterwards. |
| 583 | # |
| 584 | # Currently allowed types: `identitysources`. |
| 585 | "labels": { # `Required`. Labels for Group resource. |
| 586 | # For creating Groups under a namespace, set label key to |
| 587 | # 'labels/system/groups/external' and label value as empty. |
| 588 | "a_key": "A String", |
| 589 | }, |
| 590 | "groupKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # EntityKey of the Group. |
| 591 | # |
| 592 | # Must be set when creating a Group, read-only afterwards. |
| 593 | # isolation for IDs. A single ID can be reused across namespaces but the |
| 594 | # combination of a namespace and an ID must be unique. |
| 595 | "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 596 | # within its namespace. |
| 597 | # |
| 598 | # Namespaces are currently only created as part of IdentitySource creation |
| 599 | # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 600 | # created corresponding to every Identity Source `identity_source_id`. |
| 601 | "id": "A String", # The ID of the entity within the given namespace. The ID must be unique |
| 602 | # within its namespace. |
| 603 | }, |
| 604 | "createTime": "A String", # The time when the Group was created. |
| 605 | # Output only. |
| 606 | "description": "A String", # An extended description to help users determine the purpose of a Group. For |
| 607 | # example, you can include information about who should join the Group, the |
| 608 | # types of messages to send to the Group, links to FAQs about the Group, or |
| 609 | # related Groups. Maximum length is 4,096 characters. |
| 610 | }, |
| 611 | ], |
| 612 | }</pre> |
| 613 | </div> |
| 614 | |
| 615 | <div class="method"> |
| 616 | <code class="details" id="search_next">search_next(previous_request, previous_response)</code> |
| 617 | <pre>Retrieves the next page of results. |
| 618 | |
| 619 | Args: |
| 620 | previous_request: The request for the previous page. (required) |
| 621 | previous_response: The response from the request for the previous page. (required) |
| 622 | |
| 623 | Returns: |
| 624 | A request object that you can call 'execute()' on to request the next |
| 625 | page. Returns None if there are no more items in the collection. |
| 626 | </pre> |
| 627 | </div> |
| 628 | |
| 629 | </body></html> |