blob: af5941cc183de45015fc9f611cc38ebd9c2b57a5 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
78 <code><a href="#list">list(parent, pageSize=None, resolutionStatusCode=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Lists unmapped user identities for an identity source.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="list">list(parent, pageSize=None, resolutionStatusCode=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code>
86 <pre>Lists unmapped user identities for an identity source.
87
Dan O'Mearadd494642020-05-01 07:42:23 -070088**Note:** This API requires an admin account to execute.
89
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070090Args:
91 parent: string, The name of the identity source, in the following format:
92identitysources/{source_id} (required)
93 pageSize: integer, Maximum number of items to fetch in a request.
94Defaults to 100.
95 resolutionStatusCode: string, Limit users selection to this status.
96 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
97Otherwise, ignore this field.
98 pageToken: string, The next_page_token value returned from a previous List request, if any.
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 {
108 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
109 # more results in the list.
110 "unmappedIdentities": [
111 {
112 "externalIdentity": { # Reference to a user, group, or domain. # The resource name for an external user.
113 "userResourceName": "A String", # This principal is a user identified using an external identity.
114 # The name field must specify the user resource name with this format:
115 # identitysources/{source_id}/users/{ID}
116 "groupResourceName": "A String", # This principal is a group identified using an external identity.
117 # The name field must specify the group resource name with this format:
118 # identitysources/{source_id}/groups/{ID}
119 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
120 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
121 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
122 # customer.
123 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
124 },
125 },
126 "resolutionStatusCode": "A String", # The resolution status for the external identity.
127 },
128 ],
129 }</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
134 <pre>Retrieves the next page of results.
135
136Args:
137 previous_request: The request for the previous page. (required)
138 previous_response: The response from the request for the previous page. (required)
139
140Returns:
141 A request object that you can call 'execute()' on to request the next
142 page. Returns None if there are no more items in the collection.
143 </pre>
144</div>
145
146</body></html>