blob: 12ef9a1ae94977a3efce7458039c90d617a672ac [file] [log] [blame]
<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="iap_v1.html">Cloud Identity-Aware Proxy API</a> . <a href="iap_v1.projects.html">projects</a> . <a href="iap_v1.projects.brands.html">brands</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="iap_v1.projects.brands.identityAwareProxyClients.html">identityAwareProxyClients()</a></code>
</p>
<p class="firstline">Returns the identityAwareProxyClients Resource.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Constructs a new OAuth brand for the project if one does not exist.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the OAuth brand of the project.</p>
<p class="toc_element">
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the existing brands for the project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Constructs a new OAuth brand for the project if one does not exist.
The created brand is &quot;internal only&quot;, meaning that OAuth clients created
under it only accept requests from users who belong to the same G Suite
organization as the project. The brand is created in an un-reviewed status.
NOTE: The &quot;internal only&quot; status can be manually changed in the Google
Cloud console. Requires that a brand does not already exist for the
project, and that the specified support email is owned by the caller.
Args:
parent: string, Required. GCP Project number/id under which the brand is to be created.
In the following format: projects/{project_number/id}. (required)
body: object, The request body.
The object takes the form of:
{ # OAuth brand data.
# NOTE: Only contains a portion of the data that describes a brand.
&quot;orgInternalOnly&quot;: True or False, # Output only. Whether the brand is only intended for usage inside the
# G Suite organization only.
&quot;applicationTitle&quot;: &quot;A String&quot;, # Application name displayed on OAuth consent screen.
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier of the brand.
# NOTE: GCP project number achieves the same brand identification purpose as
# only one brand per project can be created.
&quot;supportEmail&quot;: &quot;A String&quot;, # Support email displayed on the OAuth consent screen.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # OAuth brand data.
# NOTE: Only contains a portion of the data that describes a brand.
&quot;orgInternalOnly&quot;: True or False, # Output only. Whether the brand is only intended for usage inside the
# G Suite organization only.
&quot;applicationTitle&quot;: &quot;A String&quot;, # Application name displayed on OAuth consent screen.
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier of the brand.
# NOTE: GCP project number achieves the same brand identification purpose as
# only one brand per project can be created.
&quot;supportEmail&quot;: &quot;A String&quot;, # Support email displayed on the OAuth consent screen.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves the OAuth brand of the project.
Args:
name: string, Required. Name of the brand to be fetched.
In the following format: projects/{project_number/id}/brands/{brand}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # OAuth brand data.
# NOTE: Only contains a portion of the data that describes a brand.
&quot;orgInternalOnly&quot;: True or False, # Output only. Whether the brand is only intended for usage inside the
# G Suite organization only.
&quot;applicationTitle&quot;: &quot;A String&quot;, # Application name displayed on OAuth consent screen.
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier of the brand.
# NOTE: GCP project number achieves the same brand identification purpose as
# only one brand per project can be created.
&quot;supportEmail&quot;: &quot;A String&quot;, # Support email displayed on the OAuth consent screen.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
<pre>Lists the existing brands for the project.
Args:
parent: string, Required. GCP Project number/id.
In the following format: projects/{project_number/id}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListBrands.
&quot;brands&quot;: [ # Brands existing in the project.
{ # OAuth brand data.
# NOTE: Only contains a portion of the data that describes a brand.
&quot;orgInternalOnly&quot;: True or False, # Output only. Whether the brand is only intended for usage inside the
# G Suite organization only.
&quot;applicationTitle&quot;: &quot;A String&quot;, # Application name displayed on OAuth consent screen.
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier of the brand.
# NOTE: GCP project number achieves the same brand identification purpose as
# only one brand per project can be created.
&quot;supportEmail&quot;: &quot;A String&quot;, # Support email displayed on the OAuth consent screen.
},
],
}</pre>
</div>
</body></html>