Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / db5a0ed106aff656a031a99ad64780ffd88c8425 / . / docs / dyn / computeaccounts_alpha.linux.html
blob: 2f78ca334d9a3a8d8149b68e675bd5b0586c71ac [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[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="computeaccounts_alpha.html">Compute Accounts API</a> . <a href="computeaccounts_alpha.linux.html">linux</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance)</a></code></p>
79<p class="firstline">Returns a list of authorized public keys for a specific user account.</p>
80<p class="toc_element">
81 <code><a href="#getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None, user=None)</a></code></p>
82<p class="firstline">Retrieves a list of user accounts for an instance within a specific project.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance)</code>
86 <pre>Returns a list of authorized public keys for a specific user account.
87
88Args:
89 project: string, Project ID for this request. (required)
90 zone: string, Name of the zone for this request. (required)
91 user: string, The user account for which you want to get a list of authorized public keys. (required)
92 instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
93
94Returns:
95 An object of the form:
96
97 {
98 "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
99 "keys": [ # [Output Only] The list of authorized public keys in SSH format.
100 "A String",
101 ],
102 },
103 }</pre>
104</div>
105
106<div class="method">
107 <code class="details" id="getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None, user=None)</code>
108 <pre>Retrieves a list of user accounts for an instance within a specific project.
109
110Args:
111 project: string, Project ID for this request. (required)
112 zone: string, Name of the zone for this request. (required)
113 instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
114 orderBy: string, A parameter
115 filter: string, Filter expression for filtering listed resources.
116 maxResults: integer, Maximum count of results to be returned.
117 pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
118 user: string, If provided, the user requesting the views. If left blank, the system is requesting the views, instead of a particular user.
119
120Returns:
121 An object of the form:
122
123 {
124 "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
125 "kind": "computeaccounts#linuxAccountViews", # [Output Only] Type of the resource. Always computeaccounts#linuxAccountViews for Linux resources.
126 "userViews": [ # [Output Only] A list of all users within a project.
127 { # A detailed view of a Linux user account.
128 "username": "A String", # [Output Only] The username of the account.
129 "shell": "A String", # [Output Only] The path to the login shell for this account.
130 "uid": 42, # [Output Only] User ID.
131 "gid": 42, # [Output Only] User's default group ID.
132 "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
133 "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
134 },
135 ],
136 "groupViews": [ # [Output Only] A list of all groups within a project.
137 { # A detailed view of a Linux group.
138 "groupName": "A String", # [Output Only] Group name.
139 "gid": 42, # [Output Only] The Group ID.
140 "members": [ # [Output Only] List of user accounts that belong to the group.
141 "A String",
142 ],
143 },
144 ],
145 },
146 }</pre>
147</div>
148
149</body></html>