| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="gmailpostmastertools_v2.html">Gmail Postmaster Tools API</a> . <a href="gmailpostmastertools_v2.domains.html">domains</a> . <a href="gmailpostmastertools_v2.domains.users.html">users</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">[Developer Preview](https://developers.google.com/workspace/preview): Creates a user, who has access to a domain. Returns INVALID_ARGUMENT if a user is not provided.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">[Developer Preview](https://developers.google.com/workspace/preview): Deletes a user from a domain. Returns NOT_FOUND if the user does not exist.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">[Developer Preview](https://developers.google.com/workspace/preview): Retrieves detailed information about a user that has access to a domain. Returns NOT_FOUND if the user does not exist.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">[Developer Preview](https://developers.google.com/workspace/preview): Lists the users that have access to a domain.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">[Developer Preview](https://developers.google.com/workspace/preview): Updates a user for a domain. Only Owners and Admins can execute this RPC, only a user's domain permission will be allowed to be updated. Returns NOT_FOUND if the user does not exist. Returns INVALID_ARGUMENT if a permission is not provided or is PERMISSION_UNSPECIFIED, NONE, or OWNER.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>[Developer Preview](https://developers.google.com/workspace/preview): Creates a user, who has access to a domain. Returns INVALID_ARGUMENT if a user is not provided. |
| |
| Args: |
| parent: string, Required. The parent resource where this user will be created. Format: domains/{domain} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # [Developer Preview](https://developers.google.com/workspace/preview): Request message for CreateUser. |
| "permission": "A String", # Optional. Specifies the permission level to give the user for the specified domain. If not specified, the default value for this field is READER. |
| "userId": "A String", # Required. The user to create. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # [Developer Preview](https://developers.google.com/workspace/preview): Information about a user's access to a domain. |
| "accessGranter": "A String", # Output only. The user that added the current user. |
| "createTime": "A String", # Output only. The time the user was granted access. |
| "name": "A String", # Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address. |
| "permission": "A String", # The permission level that the user has for the specified domain. |
| "user": "A String", # The user's email address. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>[Developer Preview](https://developers.google.com/workspace/preview): Deletes a user from a domain. Returns NOT_FOUND if the user does not exist. |
| |
| Args: |
| name: string, Required. The resource name of the user to delete. Format: domains/{domain}/users/{user} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>[Developer Preview](https://developers.google.com/workspace/preview): Retrieves detailed information about a user that has access to a domain. Returns NOT_FOUND if the user does not exist. |
| |
| Args: |
| name: string, Required. The resource name of the user to retrieve. Format: `domains/{domain}/users/{user}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # [Developer Preview](https://developers.google.com/workspace/preview): Information about a user's access to a domain. |
| "accessGranter": "A String", # Output only. The user that added the current user. |
| "createTime": "A String", # Output only. The time the user was granted access. |
| "name": "A String", # Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address. |
| "permission": "A String", # The permission level that the user has for the specified domain. |
| "user": "A String", # The user's email address. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>[Developer Preview](https://developers.google.com/workspace/preview): Lists the users that have access to a domain. |
| |
| Args: |
| parent: string, Required. The parent resource name for which to list users. Format: `domains/{domain}` (required) |
| pageSize: integer, Optional. Requested page size. Server may return fewer users than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200. |
| pageToken: string, Optional. The next_page_token value returned from a previous List request, if any. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # [Developer Preview](https://developers.google.com/workspace/preview): Response message for ListUsers. |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| "users": [ # The users that have access to the domain. |
| { # [Developer Preview](https://developers.google.com/workspace/preview): Information about a user's access to a domain. |
| "accessGranter": "A String", # Output only. The user that added the current user. |
| "createTime": "A String", # Output only. The time the user was granted access. |
| "name": "A String", # Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address. |
| "permission": "A String", # The permission level that the user has for the specified domain. |
| "user": "A String", # The user's email address. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>[Developer Preview](https://developers.google.com/workspace/preview): Updates a user for a domain. Only Owners and Admins can execute this RPC, only a user's domain permission will be allowed to be updated. Returns NOT_FOUND if the user does not exist. Returns INVALID_ARGUMENT if a permission is not provided or is PERMISSION_UNSPECIFIED, NONE, or OWNER. |
| |
| Args: |
| name: string, Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # [Developer Preview](https://developers.google.com/workspace/preview): Information about a user's access to a domain. |
| "accessGranter": "A String", # Output only. The user that added the current user. |
| "createTime": "A String", # Output only. The time the user was granted access. |
| "name": "A String", # Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address. |
| "permission": "A String", # The permission level that the user has for the specified domain. |
| "user": "A String", # The user's email address. |
| } |
| |
| updateMask: string, The list of fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # [Developer Preview](https://developers.google.com/workspace/preview): Information about a user's access to a domain. |
| "accessGranter": "A String", # Output only. The user that added the current user. |
| "createTime": "A String", # Output only. The time the user was granted access. |
| "name": "A String", # Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address. |
| "permission": "A String", # The permission level that the user has for the specified domain. |
| "user": "A String", # The user's email address. |
| }</pre> |
| </div> |
| |
| </body></html> |
