X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/cd4a811b896da640e5b8ddca7e515f19085932d4..332b0d1b4a9095f4e43893ec741f901b74b36ceb:/doc/api/methods/users.html.textile.liquid diff --git a/doc/api/methods/users.html.textile.liquid b/doc/api/methods/users.html.textile.liquid index cde189d6ff..5861ddbf76 100644 --- a/doc/api/methods/users.html.textile.liquid +++ b/doc/api/methods/users.html.textile.liquid @@ -112,22 +112,9 @@ table(table table-bordered table-condensed). {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path|| |user|object|The new attributes.|query|| -h3(#update_uuid). update_uuid - -Change the UUID of an existing user, updating all database references accordingly. - -This method can only be used by an admin user. It should only be used when the affected user is idle. New references to the affected user that are established _while the update_uuid operation is in progress_ might not be migrated as expected. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The current UUID of the user in question.|path|@zzzzz-tpzed-12345abcde12345@| -{background:#ccffcc}.|new_uuid|string|The desired new UUID. It is an error to use a UUID belonging to an existing user.|query|@zzzzz-tpzed-abcde12345abcde@| - h3. setup -Set up a user. Adds the user to the "All users" group. Enables the user to invoke @activate@. See "user management":{{site.baseurl}}/admin/activation.html for details. +Set up a user. Adds the user to the "All users" group. Enables the user to invoke @activate@. See "user management":{{site.baseurl}}/admin/user-management.html for details. Arguments: @@ -137,7 +124,7 @@ table(table table-bordered table-condensed). h3. activate -Check that a user has is set up and has signed all the user agreements. If so, activate the user. Users can invoke this for themselves. See "user agreements":{{site.baseurl}}/admin/activation.html#user_agreements for details. +Check that a user has is set up and has signed all the user agreements. If so, activate the user. Users can invoke this for themselves. See "user agreements":{{site.baseurl}}/admin/user-management.html#user_agreements for details. Arguments: @@ -147,7 +134,7 @@ table(table table-bordered table-condensed). h3. unsetup -Remove the user from the "All users" group and deactivate the user. See "user management":{{site.baseurl}}/admin/activation.html for details. +Remove the user from the "All users" group and deactivate the user. See "user management":{{site.baseurl}}/admin/user-management.html for details. Arguments: @@ -172,3 +159,18 @@ table(table table-bordered table-condensed). |old_user_uuid|uuid|The uuid of the "old" account|query|| |new_owner_uuid|uuid|The uuid of a project to which objects owned by the "old" user will be reassigned.|query|| |redirect_to_new_user|boolean|If true, also redirect login and reassign authorization credentials from "old" user to the "new" user|query|| + +h3. authenticate + +Create a new API token based on username/password credentials. Returns an "API client authorization":api_client_authorizations.html object containing the API token, or an "error object.":../requests.html#errors + +Valid credentials are determined by the choice of "configured login backend.":{{site.baseurl}}/install/setup-login.html + +Note: this endpoint cannot be used with login backends that use web-based third party authentication, such as Google or OpenID Connect. + +Arguments: + +table(table table-bordered table-condensed). +|_. Argument |_. Type |_. Description |_. Location |_. Example | +{background:#ccffcc}.|username|string|The username.|body|| +{background:#ccffcc}.|password|string|The password.|body||