blob: cc4d4498b13b8172c54ddae9fd635f41f4f8029e [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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="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="#get">get(userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080079<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 or if no profile exists with the requested ID or for access errors.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -070080<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="get">get(userId, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080083 <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 or if no profile exists with the requested ID or for access errors.
Takashi Matsuo06694102015-09-11 13:55:40 -070084
85Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080086 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 `"me"`, indicating the requesting user (required)
Takashi Matsuo06694102015-09-11 13:55:40 -070087 x__xgafv: string, V1 error format.
88
89Returns:
90 An object of the form:
91
92 { # Global information for a user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080093 "permissions": [ # Global permissions of the user. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -070094 { # Global user permission description.
95 "permission": "A String", # Permission value.
96 },
97 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080098 "photoUrl": "A String", # URL of user's profile photo. Read-only.
99 "emailAddress": "A String", # Email address of the user. Read-only.
100 "id": "A String", # Identifier of the user. Read-only.
101 "name": { # Details of the user's name. # Name of the user. Read-only.
102 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
103 "givenName": "A String", # The user's first name. Read-only.
104 "familyName": "A String", # The user's last name. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700105 },
106 }</pre>
107</div>
108
109</body></html>