Debian Codegraph @

docs/dyn/classroom_v1.userProfiles.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">
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">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#get">get(userId, x__xgafv=None)</a></code></p>
92 <p class="firstline">Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.</p>
93 <h3>Method Details</h3>
94 <div class="method">
95 <code class="details" id="close">close()</code>
96 <pre>Close httplib2 connections.</pre>
97 </div>
98
99 <div class="method">
100 <code class="details" id="get">get(userId, x__xgafv=None)</code>
101 <pre>Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.
102
103 Args:
104 userId: string, Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `&quot;me&quot;`, indicating the requesting user (required)
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110 Returns:
111 An object of the form:
112
113 { # Global information for a user.
114 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.
115 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
116 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
117 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
118 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
119 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
120 },
121 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
122 { # Global user permission description.
123 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
124 },
125 ],
126 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.
127 &quot;verifiedTeacher&quot;: True or False, # Represents whether a Google Workspace for Education user&#x27;s domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only
128 }</pre>
129 </div>
130
131 </body></html>