blob: 99488688ce637dcefd2767a5ad9cb37ad480e46a [file] [edit]
<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="identitytoolkit_v2.html">Identity Toolkit API</a> . <a href="identitytoolkit_v2.projects.html">projects</a> . <a href="identitytoolkit_v2.projects.defaultSupportedIdpConfigs.html">defaultSupportedIdpConfigs</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, idpId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a default supported Idp configuration for an Identity Toolkit project.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a default supported Idp configuration for an Identity Toolkit project.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve a default supported Idp configuration for an Identity Toolkit project.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all default supported Idp configurations for an Identity Toolkit project.</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">Update a default supported Idp configuration for an Identity Toolkit project.</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, idpId=None, x__xgafv=None)</code>
<pre>Create a default supported Idp configuration for an Identity Toolkit project.
Args:
parent: string, The parent resource name where the config to be created, for example: &quot;projects/my-awesome-project&quot; (required)
body: object, The request body.
The object takes the form of:
{ # Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.
&quot;appleSignInConfig&quot;: { # Additional config for SignInWithApple. # Additional config for Apple-based projects.
&quot;bundleIds&quot;: [ # A list of Bundle ID&#x27;s usable by this project
&quot;A String&quot;,
],
&quot;codeFlowConfig&quot;: { # Additional config for Apple for code flow.
&quot;keyId&quot;: &quot;A String&quot;, # Key ID for the private key.
&quot;privateKey&quot;: &quot;A String&quot;, # Private key used for signing the client secret JWT.
&quot;teamId&quot;: &quot;A String&quot;, # Apple Developer Team ID.
},
},
&quot;clientId&quot;: &quot;A String&quot;, # OAuth client ID.
&quot;clientSecret&quot;: &quot;A String&quot;, # OAuth client secret.
&quot;enabled&quot;: True or False, # True if allows the user to sign in with the provider.
&quot;name&quot;: &quot;A String&quot;, # The name of the DefaultSupportedIdpConfig resource, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot;
}
idpId: string, The id of the Idp to create a config for. Call ListDefaultSupportedIdps for list of all default supported Idps.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.
&quot;appleSignInConfig&quot;: { # Additional config for SignInWithApple. # Additional config for Apple-based projects.
&quot;bundleIds&quot;: [ # A list of Bundle ID&#x27;s usable by this project
&quot;A String&quot;,
],
&quot;codeFlowConfig&quot;: { # Additional config for Apple for code flow.
&quot;keyId&quot;: &quot;A String&quot;, # Key ID for the private key.
&quot;privateKey&quot;: &quot;A String&quot;, # Private key used for signing the client secret JWT.
&quot;teamId&quot;: &quot;A String&quot;, # Apple Developer Team ID.
},
},
&quot;clientId&quot;: &quot;A String&quot;, # OAuth client ID.
&quot;clientSecret&quot;: &quot;A String&quot;, # OAuth client secret.
&quot;enabled&quot;: True or False, # True if allows the user to sign in with the provider.
&quot;name&quot;: &quot;A String&quot;, # The name of the DefaultSupportedIdpConfig resource, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot;
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete a default supported Idp configuration for an Identity Toolkit project.
Args:
name: string, The resource name of the config, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot; (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>Retrieve a default supported Idp configuration for an Identity Toolkit project.
Args:
name: string, The resource name of the config, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot; (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.
&quot;appleSignInConfig&quot;: { # Additional config for SignInWithApple. # Additional config for Apple-based projects.
&quot;bundleIds&quot;: [ # A list of Bundle ID&#x27;s usable by this project
&quot;A String&quot;,
],
&quot;codeFlowConfig&quot;: { # Additional config for Apple for code flow.
&quot;keyId&quot;: &quot;A String&quot;, # Key ID for the private key.
&quot;privateKey&quot;: &quot;A String&quot;, # Private key used for signing the client secret JWT.
&quot;teamId&quot;: &quot;A String&quot;, # Apple Developer Team ID.
},
},
&quot;clientId&quot;: &quot;A String&quot;, # OAuth client ID.
&quot;clientSecret&quot;: &quot;A String&quot;, # OAuth client secret.
&quot;enabled&quot;: True or False, # True if allows the user to sign in with the provider.
&quot;name&quot;: &quot;A String&quot;, # The name of the DefaultSupportedIdpConfig resource, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot;
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List all default supported Idp configurations for an Identity Toolkit project.
Args:
parent: string, The parent resource name, for example, &quot;projects/my-awesome-project&quot;. (required)
pageSize: integer, The maximum number of items to return.
pageToken: string, 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:
{ # Response for DefaultSupportedIdpConfigs
&quot;defaultSupportedIdpConfigs&quot;: [ # The set of configs.
{ # Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.
&quot;appleSignInConfig&quot;: { # Additional config for SignInWithApple. # Additional config for Apple-based projects.
&quot;bundleIds&quot;: [ # A list of Bundle ID&#x27;s usable by this project
&quot;A String&quot;,
],
&quot;codeFlowConfig&quot;: { # Additional config for Apple for code flow.
&quot;keyId&quot;: &quot;A String&quot;, # Key ID for the private key.
&quot;privateKey&quot;: &quot;A String&quot;, # Private key used for signing the client secret JWT.
&quot;teamId&quot;: &quot;A String&quot;, # Apple Developer Team ID.
},
},
&quot;clientId&quot;: &quot;A String&quot;, # OAuth client ID.
&quot;clientSecret&quot;: &quot;A String&quot;, # OAuth client secret.
&quot;enabled&quot;: True or False, # True if allows the user to sign in with the provider.
&quot;name&quot;: &quot;A String&quot;, # The name of the DefaultSupportedIdpConfig resource, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot;
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</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 &#x27;execute()&#x27; 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>Update a default supported Idp configuration for an Identity Toolkit project.
Args:
name: string, The name of the DefaultSupportedIdpConfig resource, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot; (required)
body: object, The request body.
The object takes the form of:
{ # Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.
&quot;appleSignInConfig&quot;: { # Additional config for SignInWithApple. # Additional config for Apple-based projects.
&quot;bundleIds&quot;: [ # A list of Bundle ID&#x27;s usable by this project
&quot;A String&quot;,
],
&quot;codeFlowConfig&quot;: { # Additional config for Apple for code flow.
&quot;keyId&quot;: &quot;A String&quot;, # Key ID for the private key.
&quot;privateKey&quot;: &quot;A String&quot;, # Private key used for signing the client secret JWT.
&quot;teamId&quot;: &quot;A String&quot;, # Apple Developer Team ID.
},
},
&quot;clientId&quot;: &quot;A String&quot;, # OAuth client ID.
&quot;clientSecret&quot;: &quot;A String&quot;, # OAuth client secret.
&quot;enabled&quot;: True or False, # True if allows the user to sign in with the provider.
&quot;name&quot;: &quot;A String&quot;, # The name of the DefaultSupportedIdpConfig resource, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot;
}
updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.
&quot;appleSignInConfig&quot;: { # Additional config for SignInWithApple. # Additional config for Apple-based projects.
&quot;bundleIds&quot;: [ # A list of Bundle ID&#x27;s usable by this project
&quot;A String&quot;,
],
&quot;codeFlowConfig&quot;: { # Additional config for Apple for code flow.
&quot;keyId&quot;: &quot;A String&quot;, # Key ID for the private key.
&quot;privateKey&quot;: &quot;A String&quot;, # Private key used for signing the client secret JWT.
&quot;teamId&quot;: &quot;A String&quot;, # Apple Developer Team ID.
},
},
&quot;clientId&quot;: &quot;A String&quot;, # OAuth client ID.
&quot;clientSecret&quot;: &quot;A String&quot;, # OAuth client secret.
&quot;enabled&quot;: True or False, # True if allows the user to sign in with the provider.
&quot;name&quot;: &quot;A String&quot;, # The name of the DefaultSupportedIdpConfig resource, for example: &quot;projects/my-awesome-project/defaultSupportedIdpConfigs/google.com&quot;
}</pre>
</div>
</body></html>