• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">
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="#get">get(userId, x__xgafv=None)</a></code></p>
89<p class="firstline">Returns a user profile.</p>
90<h3>Method Details</h3>
91<div class="method">
92    <code class="details" id="get">get(userId, x__xgafv=None)</code>
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.
100
101Args:
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
107* the string literal `"me"`, indicating the requesting user (required)
108  x__xgafv: string, V1 error format.
109    Allowed values
110      1 - v1 error format
111      2 - v2 error format
112
113Returns:
114  An object of the form:
115
116    { # Global information for a user.
117    "name": { # Details of the user's name. # Name of the user.
118        #
119        # Read-only.
120      "fullName": "A String", # The user's full name formed by concatenating the first and last name
121          # values.
122          #
123          # Read-only.
124      "givenName": "A String", # The user's first name.
125          #
126          # Read-only.
127      "familyName": "A String", # The user's last name.
128          #
129          # Read-only.
130    },
131    "photoUrl": "A String", # URL of user's profile photo.
132        #
133        # Read-only.
134    "emailAddress": "A String", # Email address of the user.
135        #
136        # Read-only.
137    "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
138        # explicitly verified them as being a teacher. If the user is not a member of
139        # a G Suite for Education domain, than this field will always be false.
140        #
141        # Read-only
142    "id": "A String", # Identifier of the user.
143        #
144        # Read-only.
145    "permissions": [ # Global permissions of the user.
146        #
147        # Read-only.
148      { # Global user permission description.
149        "permission": "A String", # Permission value.
150      },
151    ],
152  }</pre>
153</div>
154
155</body></html>