Reorganizing API documentation to support new navbar (refs #1651).
[arvados.git] / doc / api / User.textile
1 ---
2 layout: default
3 navsection: api
4 navmenu: Schema
5 title: "Resource: User"
6 navorder: 101
7 ---
8
9 h1. User
10
11 A **User** represents...
12
13 h2. Methods
14
15 See "REST methods for working with Arvados resources":methods.html
16
17 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/user@
18
19 h2. Creation
20
21 h3. Prerequisites
22
23 Prerequisites for creating a User.
24
25 h3. Side effects
26
27 Side effects of creating a User.
28
29 h2. Resources
30
31 Each User has, in addition to the usual "attributes of Arvados resources":resources.html:
32
33 table(table table-bordered table-condensed).
34 |*Attribute*|*Type*|*Description*|*Example*|
35 |email|string|||
36 |first_name|string|||
37 |last_name|string|||
38 |identity_url|string|||
39 |is_admin|boolean|||
40 |prefs|Hash|||
41 |updated_at|datetime|||
42 |default_owner_uuid|string|||
43 |is_active|boolean|||