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> . <a href="cloudidentity_v1.groups.memberships.html">memberships</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Creates a Membership.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a Membership.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Retrieves a Membership.</p> |
| 86 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(parent, pageSize=None, view=None, pageToken=None, x__xgafv=None)</a></code></p> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 88 | <p class="firstline">Lists Memberships within a Group.</p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 93 | <code><a href="#lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Looks up [resource</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 97 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <pre>Creates a Membership. |
| 99 | |
| 100 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | Group to create Membership within. Format: `groups/{group_id}`, where |
| 103 | `group_id` is the unique ID assigned to the Group. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 105 | The object takes the form of: |
| 106 | |
| 107 | { # Resource representing a Membership within a Group |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 108 | "roles": [ # Roles for a member within the Group. |
| 109 | # |
| 110 | # Currently supported MembershipRoles: `"MEMBER"`. |
| 111 | { # Resource representing a role within a Membership. |
| 112 | "name": "A String", # MembershipRole in string format. |
| 113 | # |
| 114 | # Currently supported MembershipRoles: `"MEMBER"`. |
| 115 | }, |
| 116 | ], |
| 117 | "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 118 | # Membership in the format: `groups/{group_id}/memberships/{member_id}`, |
| 119 | # where group_id is the unique ID assigned to the Group to which Membership |
| 120 | # belongs to, and member_id is the unique ID assigned to the member |
| 121 | # |
| 122 | # Must be left blank while creating a Membership. |
| 123 | "updateTime": "A String", # Output only. Last updated timestamp of the Membership. Output only. |
| 124 | "createTime": "A String", # Output only. Creation timestamp of the Membership. Output only. |
| 125 | "preferredMemberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while |
| 126 | # creating a Membership, read-only afterwards. |
| 127 | # |
| 128 | # Currently allowed entity types: `Users`, `Groups`. |
| 129 | # isolation for IDs. A single ID can be reused across namespaces but the |
| 130 | # combination of a namespace and an ID must be unique. |
| 131 | "id": "A String", # The ID of the entity within the given namespace. The ID must be unique |
| 132 | # within its namespace. |
| 133 | "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 134 | # within its namespace. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 135 | # |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 136 | # Namespaces are currently only created as part of IdentitySource creation |
| 137 | # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 138 | # created corresponding to every Identity Source `identity_source_id`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 139 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 140 | } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 141 | |
| 142 | x__xgafv: string, V1 error format. |
| 143 | Allowed values |
| 144 | 1 - v1 error format |
| 145 | 2 - v2 error format |
| 146 | |
| 147 | Returns: |
| 148 | An object of the form: |
| 149 | |
| 150 | { # This resource represents a long-running operation that is the result of a |
| 151 | # network API call. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "response": { # The normal response of the operation in case of success. If the original |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 153 | # method returns no data on success, such as `Delete`, the response is |
| 154 | # `google.protobuf.Empty`. If the original method is standard |
| 155 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 156 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 157 | # is the original method name. For example, if the original method name |
| 158 | # is `TakeSnapshot()`, the inferred response type is |
| 159 | # `TakeSnapshotResponse`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 161 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 162 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 163 | # If `true`, the operation is completed, and either `error` or `response` is |
| 164 | # available. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 166 | # contains progress information and common metadata such as create time. |
| 167 | # Some services might not provide such metadata. Any method that returns a |
| 168 | # long-running operation should document the metadata type, if any. |
| 169 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 170 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 171 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 172 | # originally returns it. If you use the default HTTP mapping, the |
| 173 | # `name` should be a resource name ending with `operations/{unique_id}`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 182 | # message types for APIs to use. |
| 183 | { |
| 184 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 185 | }, |
| 186 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 187 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 188 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 189 | # user-facing error message should be localized and sent in the |
| 190 | # google.rpc.Status.details field, or localized by the client. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 191 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 192 | }</pre> |
| 193 | </div> |
| 194 | |
| 195 | <div class="method"> |
| 196 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 197 | <pre>Deletes a Membership. |
| 198 | |
| 199 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 200 | name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 201 | Membership to be deleted. |
| 202 | |
| 203 | Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is |
| 204 | the unique ID assigned to the Group to which Membership belongs to, and |
| 205 | member_id is the unique ID assigned to the member. (required) |
| 206 | x__xgafv: string, V1 error format. |
| 207 | Allowed values |
| 208 | 1 - v1 error format |
| 209 | 2 - v2 error format |
| 210 | |
| 211 | Returns: |
| 212 | An object of the form: |
| 213 | |
| 214 | { # This resource represents a long-running operation that is the result of a |
| 215 | # network API call. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 216 | "response": { # The normal response of the operation in case of success. If the original |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 217 | # method returns no data on success, such as `Delete`, the response is |
| 218 | # `google.protobuf.Empty`. If the original method is standard |
| 219 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 220 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 221 | # is the original method name. For example, if the original method name |
| 222 | # is `TakeSnapshot()`, the inferred response type is |
| 223 | # `TakeSnapshotResponse`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 224 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 225 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 226 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 227 | # If `true`, the operation is completed, and either `error` or `response` is |
| 228 | # available. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 235 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 236 | # originally returns it. If you use the default HTTP mapping, the |
| 237 | # `name` should be a resource name ending with `operations/{unique_id}`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 238 | "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. |
| 239 | # different programming environments, including REST APIs and RPC APIs. It is |
| 240 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 241 | # three pieces of data: error code, error message, and error details. |
| 242 | # |
| 243 | # You can find out more about this error model and how to work with it in the |
| 244 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 245 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 246 | # message types for APIs to use. |
| 247 | { |
| 248 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 249 | }, |
| 250 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 251 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 252 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 253 | # user-facing error message should be localized and sent in the |
| 254 | # google.rpc.Status.details field, or localized by the client. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 255 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 256 | }</pre> |
| 257 | </div> |
| 258 | |
| 259 | <div class="method"> |
| 260 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 261 | <pre>Retrieves a Membership. |
| 262 | |
| 263 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 264 | name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 265 | Membership to be retrieved. |
| 266 | |
| 267 | Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is |
| 268 | the unique id assigned to the Group to which Membership belongs to, and |
| 269 | `member_id` is the unique ID assigned to the member. (required) |
| 270 | x__xgafv: string, V1 error format. |
| 271 | Allowed values |
| 272 | 1 - v1 error format |
| 273 | 2 - v2 error format |
| 274 | |
| 275 | Returns: |
| 276 | An object of the form: |
| 277 | |
| 278 | { # Resource representing a Membership within a Group |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 279 | "roles": [ # Roles for a member within the Group. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 280 | # |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 281 | # Currently supported MembershipRoles: `"MEMBER"`. |
| 282 | { # Resource representing a role within a Membership. |
| 283 | "name": "A String", # MembershipRole in string format. |
| 284 | # |
| 285 | # Currently supported MembershipRoles: `"MEMBER"`. |
| 286 | }, |
| 287 | ], |
| 288 | "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 289 | # Membership in the format: `groups/{group_id}/memberships/{member_id}`, |
| 290 | # where group_id is the unique ID assigned to the Group to which Membership |
| 291 | # belongs to, and member_id is the unique ID assigned to the member |
| 292 | # |
| 293 | # Must be left blank while creating a Membership. |
| 294 | "updateTime": "A String", # Output only. Last updated timestamp of the Membership. Output only. |
| 295 | "createTime": "A String", # Output only. Creation timestamp of the Membership. Output only. |
| 296 | "preferredMemberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while |
| 297 | # creating a Membership, read-only afterwards. |
| 298 | # |
| 299 | # Currently allowed entity types: `Users`, `Groups`. |
| 300 | # isolation for IDs. A single ID can be reused across namespaces but the |
| 301 | # combination of a namespace and an ID must be unique. |
| 302 | "id": "A String", # The ID of the entity within the given namespace. The ID must be unique |
| 303 | # within its namespace. |
| 304 | "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 305 | # within its namespace. |
| 306 | # |
| 307 | # Namespaces are currently only created as part of IdentitySource creation |
| 308 | # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 309 | # created corresponding to every Identity Source `identity_source_id`. |
| 310 | }, |
| 311 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 312 | </div> |
| 313 | |
| 314 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 315 | <code class="details" id="list">list(parent, pageSize=None, view=None, pageToken=None, x__xgafv=None)</code> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 316 | <pre>Lists Memberships within a Group. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 317 | |
| 318 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 319 | parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 320 | Group to list Memberships within. |
| 321 | |
| 322 | Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to |
| 323 | the Group. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 324 | pageSize: integer, The default page size is 200 (max 1000) for the BASIC view, and 50 |
| 325 | (max 500) for the FULL view. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 326 | view: string, Membership resource view to be returned. Defaults to View.BASIC. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 327 | pageToken: string, The next_page_token value returned from a previous list request, if any. |
| 328 | x__xgafv: string, V1 error format. |
| 329 | Allowed values |
| 330 | 1 - v1 error format |
| 331 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 332 | |
| 333 | Returns: |
| 334 | An object of the form: |
| 335 | |
| 336 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 337 | "memberships": [ # List of Memberships. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 338 | { # Resource representing a Membership within a Group |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 339 | "roles": [ # Roles for a member within the Group. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 340 | # |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 341 | # Currently supported MembershipRoles: `"MEMBER"`. |
| 342 | { # Resource representing a role within a Membership. |
| 343 | "name": "A String", # MembershipRole in string format. |
| 344 | # |
| 345 | # Currently supported MembershipRoles: `"MEMBER"`. |
| 346 | }, |
| 347 | ], |
| 348 | "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
| 349 | # Membership in the format: `groups/{group_id}/memberships/{member_id}`, |
| 350 | # where group_id is the unique ID assigned to the Group to which Membership |
| 351 | # belongs to, and member_id is the unique ID assigned to the member |
| 352 | # |
| 353 | # Must be left blank while creating a Membership. |
| 354 | "updateTime": "A String", # Output only. Last updated timestamp of the Membership. Output only. |
| 355 | "createTime": "A String", # Output only. Creation timestamp of the Membership. Output only. |
| 356 | "preferredMemberKey": { # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # Required. Immutable. EntityKey of the entity to be added as the member. Must be set while |
| 357 | # creating a Membership, read-only afterwards. |
| 358 | # |
| 359 | # Currently allowed entity types: `Users`, `Groups`. |
| 360 | # isolation for IDs. A single ID can be reused across namespaces but the |
| 361 | # combination of a namespace and an ID must be unique. |
| 362 | "id": "A String", # The ID of the entity within the given namespace. The ID must be unique |
| 363 | # within its namespace. |
| 364 | "namespace": "A String", # Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 365 | # within its namespace. |
| 366 | # |
| 367 | # Namespaces are currently only created as part of IdentitySource creation |
| 368 | # from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
| 369 | # created corresponding to every Identity Source `identity_source_id`. |
| 370 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 371 | }, |
| 372 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 373 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 374 | # more results available for listing. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 375 | }</pre> |
| 376 | </div> |
| 377 | |
| 378 | <div class="method"> |
| 379 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 380 | <pre>Retrieves the next page of results. |
| 381 | |
| 382 | Args: |
| 383 | previous_request: The request for the previous page. (required) |
| 384 | previous_response: The response from the request for the previous page. (required) |
| 385 | |
| 386 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 387 | A request object that you can call 'execute()' on to request the next |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 388 | page. Returns None if there are no more items in the collection. |
| 389 | </pre> |
| 390 | </div> |
| 391 | |
| 392 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 393 | <code class="details" id="lookup">lookup(parent, memberKey_namespace=None, memberKey_id=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 394 | <pre>Looks up [resource |
| 395 | name](https://cloud.google.com/apis/design/resource_names) of a Membership |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 396 | within a Group by member's EntityKey. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 397 | |
| 398 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 399 | parent: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 400 | Group to lookup Membership within. |
| 401 | |
| 402 | Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to |
| 403 | the Group. (required) |
| 404 | memberKey_namespace: string, Namespaces provide isolation for IDs, so an ID only needs to be unique |
| 405 | within its namespace. |
| 406 | |
| 407 | Namespaces are currently only created as part of IdentitySource creation |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 408 | from Admin Console. A namespace `"identitysources/{identity_source_id}"` is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 409 | created corresponding to every Identity Source `identity_source_id`. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 410 | memberKey_id: string, The ID of the entity within the given namespace. The ID must be unique |
| 411 | within its namespace. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 412 | x__xgafv: string, V1 error format. |
| 413 | Allowed values |
| 414 | 1 - v1 error format |
| 415 | 2 - v2 error format |
| 416 | |
| 417 | Returns: |
| 418 | An object of the form: |
| 419 | |
| 420 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 421 | "name": "A String", # [Resource name](https://cloud.google.com/apis/design/resource_names) of the |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 422 | # Membership being looked up. |
| 423 | # |
| 424 | # Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is |
| 425 | # the unique ID assigned to the Group to which Membership belongs to, and |
| 426 | # `member_id` is the unique ID assigned to the member. |
| 427 | }</pre> |
| 428 | </div> |
| 429 | |
| 430 | </body></html> |