X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/c0b66870cafce4d75625e16b5b36bed8b58d7c8e..05428b719b804e68a17e07af0de00c0607d0be04:/doc/api/schema/User.html.textile.liquid diff --git a/doc/api/schema/User.html.textile.liquid b/doc/api/schema/User.html.textile.liquid index 461147c140..335b6c1097 100644 --- a/doc/api/schema/User.html.textile.liquid +++ b/doc/api/schema/User.html.textile.liquid @@ -6,38 +6,25 @@ title: User ... - - -A **User** represents... +A **User** represents a person who interacts with Arvados via an ApiClient. h2. Methods -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html - -API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/users@ - -h2. Creation - -h3. Prerequisites - -Prerequisites for creating a User. - -h3. Side effects - -Side effects of creating a User. +See "users":{{site.baseurl}}/api/methods/users.html -h2. Resources +h2. Resource Each User has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| |email|string||| +|username|string|The username used for the user's git repositories and virtual machine logins. Usernames must start with a letter, and contain only alphanumerics. When a new user is created, a default username is set from their e-mail address. Only administrators may change the username.|| |first_name|string||| |last_name|string||| |identity_url|string||| |is_admin|boolean||| -|prefs|Hash||| -|updated_at|datetime||| +|prefs|hash||| |default_owner_uuid|string||| |is_active|boolean||| +|writable_by|array|List of UUID strings identifying Groups and other Users that can modify this User object. This will include the user's owner_uuid and, for administrators and users requesting their own User object, the requesting user's UUID.||