Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / classroom_v1.userProfiles.html
blob: d717b2851c7bca36ab4471e03fa5c382d9654f30 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.userProfiles.html">userProfiles</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]78 <code><a href="classroom_v1.userProfiles.guardianInvitations.html">guardianInvitations()</a></code>
79</p>
80<p class="firstline">Returns the guardianInvitations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="classroom_v1.userProfiles.guardians.html">guardians()</a></code>
84</p>
85<p class="firstline">Returns the guardians Resource.</p>
86
87<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]88 <code><a href="#get">get(userId, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]89<p class="firstline">Returns a user profile.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]90<h3>Method Details</h3>
91<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]92 <code class="details" id="get">get(userId, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]93 <pre>Returns a user profile.
94
95This method returns the following error codes:
96
97* `PERMISSION_DENIED` if the requesting user is not permitted to access
98this user profile, if no profile exists with the requested ID, or for
99access errors.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]100
101Args:
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]102 userId: string, Identifier of the profile to return. The identifier can be one of the
103following:
104
105* the numeric identifier for the user
106* the email address of the user
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]107* the string literal `&quot;me&quot;`, indicating the requesting user (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]108 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112
113Returns:
114 An object of the form:
115
116 { # Global information for a user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]117 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]118 #
119 # Read-only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]120 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo.
121 #
122 # Read-only.
123 &quot;permissions&quot;: [ # Global permissions of the user.
124 #
125 # Read-only.
126 { # Global user permission description.
127 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
128 },
129 ],
130 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user.
131 #
132 # Read-only.
133 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name.
134 #
135 # Read-only.
136 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name.
137 #
138 # Read-only.
139 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]140 # values.
141 #
142 # Read-only.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]143 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]144 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]145 #
146 # Read-only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]147 &quot;verifiedTeacher&quot;: True or False, # Represents whether a G Suite for Education user&#x27;s domain administrator has
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 # explicitly verified them as being a teacher. If the user is not a member of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]149 # a G Suite for Education domain, than this field is always false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 #
151 # Read-only
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152 }</pre>
153</div>
154
155</body></html>