Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0d561ef2b7642e281eb69a81167e45d98d1621a4 / . / docs / dyn / cloudsearch_v1.debug.identitysources.unmappedids.html
blob: a9ae6c40fef0817107d029f79e973c77b9ca7d21 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.debug.html">debug</a> . <a href="cloudsearch_v1.debug.identitysources.html">identitysources</a> . <a href="cloudsearch_v1.debug.identitysources.unmappedids.html">unmappedids</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]81 <code><a href="#list">list(parent, resolutionStatusCode=None, debugOptions_enableDebugging=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Lists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]92<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]93 <code class="details" id="list">list(parent, resolutionStatusCode=None, debugOptions_enableDebugging=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <pre>Lists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]95
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 parent: string, The name of the identity source, in the following format: identitysources/{source_id} (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]98 resolutionStatusCode: string, Limit users selection to this status.
99 Allowed values
100 CODE_UNSPECIFIED - Input-only value. Used to list all unmapped identities regardless of status.
101 NOT_FOUND - The unmapped identity was not found in IDaaS, and needs to be provided by the user.
102 IDENTITY_SOURCE_NOT_FOUND - The identity source associated with the identity was either not found or deleted.
103 IDENTITY_SOURCE_MISCONFIGURED - IDaaS does not understand the identity source, probably because the schema was modified in a non compatible way.
104 TOO_MANY_MAPPINGS_FOUND - The number of users associated with the external identity is too large.
105 INTERNAL_ERROR - Internal error.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]106 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
107 pageSize: integer, Maximum number of items to fetch in a request. Defaults to 100.
108 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
117 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]118 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;unmappedIdentities&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;externalIdentity&quot;: { # Reference to a user, group, or domain. # The resource name for an external user.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]122 &quot;userResourceName&quot;: &quot;A String&quot;, # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
123 &quot;groupResourceName&quot;: &quot;A String&quot;, # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
124 &quot;gsuitePrincipal&quot;: { # This principal is a GSuite user, group or domain.
125 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the customer.
126 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
127 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
128 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]130 &quot;resolutionStatusCode&quot;: &quot;A String&quot;, # The resolution status for the external identity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 },
132 ],
133 }</pre>
134</div>
135
136<div class="method">
137 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
138 <pre>Retrieves the next page of results.
139
140Args:
141 previous_request: The request for the previous page. (required)
142 previous_response: The response from the request for the previous page. (required)
143
144Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 page. Returns None if there are no more items in the collection.
147 </pre>
148</div>
149
150</body></html>