blob: 31cf220f5ee376c33f692745d502446bc96cf6e3 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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> . <a href="cloudidentity_v1.groups.memberships.html">memberships</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080078 <code><a href="#checkTransitiveMembership">checkTransitiveMembership(parent, query=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Check a potential member for membership in a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.</p>
80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070081 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070085<p class="firstline">Creates a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<p class="toc_element">
87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070088<p class="firstline">Deletes a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<p class="toc_element">
90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070091<p class="firstline">Retrieves a `Membership`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080093 <code><a href="#getMembershipGraph">getMembershipGraph(parent, query=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Get a membership graph of just a member or both a member and a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.</p>
95<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080096 <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070097<p class="firstline">Lists the `Membership`s within a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800102 <code><a href="#lookup">lookup(parent, memberKey_id=None, memberKey_namespace=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700103<p class="firstline">Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700104<p class="toc_element">
105 <code><a href="#modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Modifies the `MembershipRole`s of a `Membership`.</p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800107<p class="toc_element">
108 <code><a href="#searchTransitiveGroups">searchTransitiveGroups(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
109<p class="firstline">Search transitive groups of a member. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.</p>
110<p class="toc_element">
111 <code><a href="#searchTransitiveGroups_next">searchTransitiveGroups_next(previous_request, previous_response)</a></code></p>
112<p class="firstline">Retrieves the next page of results.</p>
113<p class="toc_element">
114 <code><a href="#searchTransitiveMemberships">searchTransitiveMemberships(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
115<p class="firstline">Search transitive memberships of a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.</p>
116<p class="toc_element">
117 <code><a href="#searchTransitiveMemberships_next">searchTransitiveMemberships_next(previous_request, previous_response)</a></code></p>
118<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700119<h3>Method Details</h3>
120<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800121 <code class="details" id="checkTransitiveMembership">checkTransitiveMembership(parent, query=None, x__xgafv=None)</code>
122 <pre>Check a potential member for membership in a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.
123
124Args:
125 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to check the transitive membership in. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group to which the Membership belongs to. (required)
126 query: string, Required. A CEL expression that MUST include member specification. This is a `required` field. Certain groups are uniquely identified by both a &#x27;member_key_id&#x27; and a &#x27;member_key_namespace&#x27;, which requires an additional query input: &#x27;member_key_namespace&#x27;. Example query: `member_key_id == &#x27;member_key_id_value&#x27;`
127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
135 { # The response message for MembershipsService.CheckTransitiveMembership.
136 &quot;hasMembership&quot;: True or False, # Response does not include the possible roles of a member since the behavior of this rpc is not all-or-nothing unlike the other rpcs. So, it may not be possible to list all the roles definitively, due to possible lack of authorization in some of the paths.
137}</pre>
138</div>
139
140<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141 <code class="details" id="close">close()</code>
142 <pre>Close httplib2 connections.</pre>
143</div>
144
145<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700146 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700147 <pre>Creates a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700148
149Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700150 parent: string, Required. The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700151 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700152 The object takes the form of:
153
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700154{ # A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a &quot;member&quot;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800155 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
156 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
157 &quot;preferredMemberKey&quot;: { # 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 member.
158 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s requirements. Must be unique within a `namespace`.
159 &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}.
160 },
161 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.
162 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800163 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
164 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
165 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800166 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800167 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800168 ],
169 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
170 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
171}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700172
173 x__xgafv: string, V1 error format.
174 Allowed values
175 1 - v1 error format
176 2 - v2 error format
177
178Returns:
179 An object of the form:
180
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700181 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800182 &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.
183 &quot;error&quot;: { # 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.
184 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
185 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
186 {
187 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
188 },
189 ],
190 &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.
191 },
192 &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.
193 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
194 },
195 &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}`.
196 &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`.
197 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
198 },
199}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700200</div>
201
202<div class="method">
203 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700204 <pre>Deletes a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700205
206Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700207 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700208 x__xgafv: string, V1 error format.
209 Allowed values
210 1 - v1 error format
211 2 - v2 error format
212
213Returns:
214 An object of the form:
215
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700216 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800217 &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.
218 &quot;error&quot;: { # 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.
219 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
220 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
221 {
222 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
223 },
224 ],
225 &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.
226 },
227 &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.
228 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
229 },
230 &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}`.
231 &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`.
232 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
233 },
234}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700235</div>
236
237<div class="method">
238 <code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700239 <pre>Retrieves a `Membership`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700240
241Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700242 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700243 x__xgafv: string, V1 error format.
244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
247
248Returns:
249 An object of the form:
250
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700251 { # A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a &quot;member&quot;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800252 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
253 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
254 &quot;preferredMemberKey&quot;: { # 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 member.
255 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s requirements. Must be unique within a `namespace`.
256 &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}.
257 },
258 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.
259 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800260 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
261 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
262 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800263 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
264 },
265 ],
266 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
267 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
268}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269</div>
270
271<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800272 <code class="details" id="getMembershipGraph">getMembershipGraph(parent, query=None, x__xgafv=None)</code>
273 <pre>Get a membership graph of just a member or both a member and a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.
274
275Args:
276 parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group to which the Membership belongs to. group_id can be a wildcard collection id &quot;-&quot;. When a group_id is specified, the membership graph will be constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be returned. (required)
277 query: string, Required. A CEL expression that MUST include member specification AND label(s). Certain groups are uniquely identified by both a &#x27;member_key_id&#x27; and a &#x27;member_key_namespace&#x27;, which requires an additional query input: &#x27;member_key_namespace&#x27;. Example query: `member_key_id == &#x27;member_key_id_value&#x27; &amp;&amp; in labels`
278 x__xgafv: string, V1 error format.
279 Allowed values
280 1 - v1 error format
281 2 - v2 error format
282
283Returns:
284 An object of the form:
285
286 { # This resource represents a long-running operation that is the result of a network API call.
287 &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.
288 &quot;error&quot;: { # 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.
289 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
290 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
291 {
292 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
293 },
294 ],
295 &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.
296 },
297 &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.
298 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
299 },
300 &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}`.
301 &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`.
302 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
303 },
304}</pre>
305</div>
306
307<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800308 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700309 <pre>Lists the `Membership`s within a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700310
311Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700312 parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. (required)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800313 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`.
314 pageToken: string, The `next_page_token` value returned from a previous search request, if any.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700315 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700316 Allowed values
317 VIEW_UNSPECIFIED - Default. Should not be used.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700318 BASIC - Only basic resource information is returned.
319 FULL - All resource information is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700320 x__xgafv: string, V1 error format.
321 Allowed values
322 1 - v1 error format
323 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700324
325Returns:
326 An object of the form:
327
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700328 { # The response message for MembershipsService.ListMemberships.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800329 &quot;memberships&quot;: [ # The `Membership`s under the specified `parent`.
330 { # A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a &quot;member&quot;.
331 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
332 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
333 &quot;preferredMemberKey&quot;: { # 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 member.
334 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s requirements. Must be unique within a `namespace`.
335 &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}.
336 },
337 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.
338 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800339 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
340 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
341 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800342 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800343 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800344 ],
345 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
346 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
347 },
348 ],
349 &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.
350}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700351</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700362 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700363 page. Returns None if there are no more items in the collection.
364 </pre>
365</div>
366
367<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800368 <code class="details" id="lookup">lookup(parent, memberKey_id=None, memberKey_namespace=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700369 <pre>Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370
371Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700372 parent: string, Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700373 memberKey_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&#x27;s requirements. Must be unique within a `namespace`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800374 memberKey_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}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 x__xgafv: string, V1 error format.
376 Allowed values
377 1 - v1 error format
378 2 - v2 error format
379
380Returns:
381 An object of the form:
382
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700383 { # The response message for MembershipsService.LookupMembershipName.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800384 &quot;name&quot;: &quot;A String&quot;, # The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Membership`. Must be of the form `groups/{group_id}/memberships/{membership_id}`.
385}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700386</div>
387
388<div class="method">
389 <code class="details" id="modifyMembershipRoles">modifyMembershipRoles(name, body=None, x__xgafv=None)</code>
390 <pre>Modifies the `MembershipRole`s of a `Membership`.
391
392Args:
393 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` whose roles are to be modified. Must be of the form `groups/{group_id}/memberships/{membership_id}`. (required)
394 body: object, The request body.
395 The object takes the form of:
396
397{ # The request message for MembershipsService.ModifyMembershipRoles.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800398 &quot;addRoles&quot;: [ # The `MembershipRole`s to be added. Adding or removing roles in the same request as updating roles is not supported. Must not be set if `update_roles_params` is set.
399 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800400 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
401 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
402 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800403 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
404 },
405 ],
406 &quot;removeRoles&quot;: [ # The `name`s of the `MembershipRole`s to be removed. Adding or removing roles in the same request as updating roles is not supported. It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to delete a `Membership`, call MembershipsService.DeleteMembership instead. Must not contain `MEMBER`. Must not be set if `update_roles_params` is set.
407 &quot;A String&quot;,
408 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800409 &quot;updateRolesParams&quot;: [ # The `MembershipRole`s to be updated. Updating roles in the same request as adding or removing roles is not supported. Must not be set if either `add_roles` or `remove_roles` is set.
410 { # The details of an update to a `MembershipRole`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700411 &quot;fieldMask&quot;: &quot;A String&quot;, # The fully-qualified names of fields to update. May only contain the field `expiry_detail.expire_time`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800412 &quot;membershipRole&quot;: { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`. # The `MembershipRole`s to be updated. Only `MEMBER` `MembershipRole` can currently be updated.
413 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
414 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
415 },
416 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
417 },
418 },
419 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800420}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700421
422 x__xgafv: string, V1 error format.
423 Allowed values
424 1 - v1 error format
425 2 - v2 error format
426
427Returns:
428 An object of the form:
429
430 { # The response message for MembershipsService.ModifyMembershipRoles.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800431 &quot;membership&quot;: { # A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a &quot;member&quot;. # The `Membership` resource after modifying its `MembershipRole`s.
432 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was created.
433 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.
434 &quot;preferredMemberKey&quot;: { # 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 member.
435 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s requirements. Must be unique within a `namespace`.
436 &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}.
437 },
438 &quot;roles&quot;: [ # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.
439 { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800440 &quot;expiryDetail&quot;: { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value.
441 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
442 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800443 &quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800444 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800445 ],
446 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
447 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Membership` was last updated.
448 },
449}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700450</div>
451
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800452<div class="method">
453 <code class="details" id="searchTransitiveGroups">searchTransitiveGroups(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code>
454 <pre>Search transitive groups of a member. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.
455
456Args:
457 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is always &#x27;-&#x27; as this API will search across all groups for a given member. (required)
458 pageSize: integer, The default page size is 200 (max 1000).
459 pageToken: string, The next_page_token value returned from a previous list request, if any.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700460 query: string, Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match (&#x27;in&#x27;) is supported on labels. Identity-mapped groups are uniquely identified by both a `member_key_id` and a `member_key_namespace`, which requires an additional query input: `member_key_namespace`. Example query: `member_key_id == &#x27;member_key_id_value&#x27; &amp;&amp; in labels`
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800461 x__xgafv: string, V1 error format.
462 Allowed values
463 1 - v1 error format
464 2 - v2 error format
465
466Returns:
467 An object of the form:
468
469 { # The response message for MembershipsService.SearchTransitiveGroups.
470 &quot;memberships&quot;: [ # List of transitive groups satisfying the query.
471 { # Message representing a transitive group of a user or a group.
472 &quot;displayName&quot;: &quot;A String&quot;, # Display name for this group.
473 &quot;group&quot;: &quot;A String&quot;, # Resource name for this group.
474 &quot;groupKey&quot;: { # 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. # Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace.
475 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s requirements. Must be unique within a `namespace`.
476 &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}.
477 },
478 &quot;labels&quot;: { # Labels for Group resource.
479 &quot;a_key&quot;: &quot;A String&quot;,
480 },
481 &quot;relationType&quot;: &quot;A String&quot;, # The relation between the member and the transitive group.
482 &quot;roles&quot;: [ # Membership roles of the member for the group.
483 { # Message representing the role of a TransitiveMembership.
484 &quot;role&quot;: &quot;A String&quot;, # TransitiveMembershipRole in string format. Currently supported TransitiveMembershipRoles: `&quot;MEMBER&quot;`, `&quot;OWNER&quot;`, and `&quot;MANAGER&quot;`.
485 },
486 ],
487 },
488 ],
489 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results available for listing.
490}</pre>
491</div>
492
493<div class="method">
494 <code class="details" id="searchTransitiveGroups_next">searchTransitiveGroups_next(previous_request, previous_response)</code>
495 <pre>Retrieves the next page of results.
496
497Args:
498 previous_request: The request for the previous page. (required)
499 previous_response: The response from the request for the previous page. (required)
500
501Returns:
502 A request object that you can call &#x27;execute()&#x27; on to request the next
503 page. Returns None if there are no more items in the collection.
504 </pre>
505</div>
506
507<div class="method">
508 <code class="details" id="searchTransitiveMemberships">searchTransitiveMemberships(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
509 <pre>Search transitive memberships of a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.
510
511Args:
512 parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. (required)
513 pageSize: integer, The default page size is 200 (max 1000).
514 pageToken: string, The next_page_token value returned from a previous list request, if any.
515 x__xgafv: string, V1 error format.
516 Allowed values
517 1 - v1 error format
518 2 - v2 error format
519
520Returns:
521 An object of the form:
522
523 { # The response message for MembershipsService.SearchTransitiveMemberships.
524 &quot;memberships&quot;: [ # List of transitive members satisfying the query.
525 { # Message representing a transitive membership of a group.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700526 &quot;member&quot;: &quot;A String&quot;, # Resource name for this member.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800527 &quot;preferredMemberKey&quot;: [ # Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace.
528 { # 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.
529 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s requirements. Must be unique within a `namespace`.
530 &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}.
531 },
532 ],
533 &quot;relationType&quot;: &quot;A String&quot;, # The relation between the group and the transitive member.
534 &quot;roles&quot;: [ # The membership role details (i.e name of role and expiry time).
535 { # Message representing the role of a TransitiveMembership.
536 &quot;role&quot;: &quot;A String&quot;, # TransitiveMembershipRole in string format. Currently supported TransitiveMembershipRoles: `&quot;MEMBER&quot;`, `&quot;OWNER&quot;`, and `&quot;MANAGER&quot;`.
537 },
538 ],
539 },
540 ],
541 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results.
542}</pre>
543</div>
544
545<div class="method">
546 <code class="details" id="searchTransitiveMemberships_next">searchTransitiveMemberships_next(previous_request, previous_response)</code>
547 <pre>Retrieves the next page of results.
548
549Args:
550 previous_request: The request for the previous page. (required)
551 previous_response: The response from the request for the previous page. (required)
552
553Returns:
554 A request object that you can call &#x27;execute()&#x27; on to request the next
555 page. Returns None if there are no more items in the collection.
556 </pre>
557</div>
558
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700559</body></html>