214 lines
6.2 KiB
HTML
214 lines
6.2 KiB
HTML
<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="sasportal_v1alpha1.html">SAS Portal API</a> . <a href="sasportal_v1alpha1.customers.html">customers</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="sasportal_v1alpha1.customers.deployments.html">deployments()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the deployments Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="sasportal_v1alpha1.customers.devices.html">devices()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the devices Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="sasportal_v1alpha1.customers.nodes.html">nodes()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the nodes Resource.</p>
|
|
|
|
<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="#get">get(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Returns a requested customer.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Returns a list of requested customers.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</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">Updates an existing customer.</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="get">get(name, x__xgafv=None)</code>
|
|
<pre>Returns a requested customer.
|
|
|
|
Args:
|
|
name: string, Required. The name of the customer. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Entity representing a SAS customer.
|
|
"displayName": "A String", # Required. Name of the organization that the customer entity represents.
|
|
"name": "A String", # Output only. Resource name of the customer.
|
|
"sasUserIds": [ # User IDs used by the devices belonging to this customer.
|
|
"A String",
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
|
|
<pre>Returns a list of requested customers.
|
|
|
|
Args:
|
|
pageSize: integer, The maximum number of customers to return in the response.
|
|
pageToken: string, A pagination token returned from a previous call to ListCustomers that indicates where this listing should continue from.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response for `ListCustomers`.
|
|
"customers": [ # The list of customers that match the request.
|
|
{ # Entity representing a SAS customer.
|
|
"displayName": "A String", # Required. Name of the organization that the customer entity represents.
|
|
"name": "A String", # Output only. Resource name of the customer.
|
|
"sasUserIds": [ # User IDs used by the devices belonging to this customer.
|
|
"A String",
|
|
],
|
|
},
|
|
],
|
|
"nextPageToken": "A String", # A pagination token returned from a previous call to ListCustomers that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>Updates an existing customer.
|
|
|
|
Args:
|
|
name: string, Output only. Resource name of the customer. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Entity representing a SAS customer.
|
|
"displayName": "A String", # Required. Name of the organization that the customer entity represents.
|
|
"name": "A String", # Output only. Resource name of the customer.
|
|
"sasUserIds": [ # User IDs used by the devices belonging to this customer.
|
|
"A String",
|
|
],
|
|
}
|
|
|
|
updateMask: string, Fields to be updated.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Entity representing a SAS customer.
|
|
"displayName": "A String", # Required. Name of the organization that the customer entity represents.
|
|
"name": "A String", # Output only. Resource name of the customer.
|
|
"sasUserIds": [ # User IDs used by the devices belonging to this customer.
|
|
"A String",
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |