1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="authorizedbuyersmarketplace_v1.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1.buyers.clients.html">clients</a> . <a href="authorizedbuyersmarketplace_v1.buyers.clients.users.html">users</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.</p> 86<p class="toc_element"> 87 <code><a href="#deactivate">deactivate(name, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.</p> 89<p class="toc_element"> 90 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Retrieves an existing client user.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists all client users for a specified client.</p> 98<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<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code> 104 <pre>Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state. 105 106Args: 107 name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required) 108 body: object, The request body. 109 The object takes the form of: 110 111{ # Request message for activating a client user. 112} 113 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client. 123 "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client. 124 "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}` 125 "state": "A String", # Output only. The state of the client user. 126}</pre> 127</div> 128 129<div class="method"> 130 <code class="details" id="close">close()</code> 131 <pre>Close httplib2 connections.</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 136 <pre>Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active. 137 138Args: 139 parent: string, Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required) 140 body: object, The request body. 141 The object takes the form of: 142 143{ # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client. 144 "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client. 145 "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}` 146 "state": "A String", # Output only. The state of the client user. 147} 148 149 x__xgafv: string, V1 error format. 150 Allowed values 151 1 - v1 error format 152 2 - v2 error format 153 154Returns: 155 An object of the form: 156 157 { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client. 158 "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client. 159 "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}` 160 "state": "A String", # Output only. The state of the client user. 161}</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="deactivate">deactivate(name, body=None, x__xgafv=None)</code> 166 <pre>Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state. 167 168Args: 169 name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required) 170 body: object, The request body. 171 The object takes the form of: 172 173{ # Request message for deactivating a client user. 174} 175 176 x__xgafv: string, V1 error format. 177 Allowed values 178 1 - v1 error format 179 2 - v2 error format 180 181Returns: 182 An object of the form: 183 184 { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client. 185 "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client. 186 "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}` 187 "state": "A String", # Output only. The state of the client user. 188}</pre> 189</div> 190 191<div class="method"> 192 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 193 <pre>Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated. 194 195Args: 196 name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required) 197 x__xgafv: string, V1 error format. 198 Allowed values 199 1 - v1 error format 200 2 - v2 error format 201 202Returns: 203 An object of the form: 204 205 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`. 206}</pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="get">get(name, x__xgafv=None)</code> 211 <pre>Retrieves an existing client user. 212 213Args: 214 name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required) 215 x__xgafv: string, V1 error format. 216 Allowed values 217 1 - v1 error format 218 2 - v2 error format 219 220Returns: 221 An object of the form: 222 223 { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client. 224 "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client. 225 "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}` 226 "state": "A String", # Output only. The state of the client user. 227}</pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 232 <pre>Lists all client users for a specified client. 233 234Args: 235 parent: string, Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required) 236 pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied. 237 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method. 238 x__xgafv: string, V1 error format. 239 Allowed values 240 1 - v1 error format 241 2 - v2 error format 242 243Returns: 244 An object of the form: 245 246 { # Response message for the list method. 247 "clientUsers": [ # The returned list of client users. 248 { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client. 249 "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client. 250 "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}` 251 "state": "A String", # Output only. The state of the client user. 252 }, 253 ], 254 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results. 255}</pre> 256</div> 257 258<div class="method"> 259 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 260 <pre>Retrieves the next page of results. 261 262Args: 263 previous_request: The request for the previous page. (required) 264 previous_response: The response from the request for the previous page. (required) 265 266Returns: 267 A request object that you can call 'execute()' on to request the next 268 page. Returns None if there are no more items in the collection. 269 </pre> 270</div> 271 272</body></html>