X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/14a6eb786a0d01e86ccae7645e880661caf6f0cb..5b554bbe0b9104e8a34b87d5570cbf87f0308bce:/doc/api/methods/users.html.textile.liquid?ds=sidebyside diff --git a/doc/api/methods/users.html.textile.liquid b/doc/api/methods/users.html.textile.liquid index 4c33f2afe8..a4d4aade9b 100644 --- a/doc/api/methods/users.html.textile.liquid +++ b/doc/api/methods/users.html.textile.liquid @@ -127,7 +127,7 @@ table(table table-bordered table-condensed). 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 +137,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,10 +147,43 @@ 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: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path|| + +h3. merge + +Transfer ownership of data from the "old" user account to the "new" user account. When @redirect_to_new_user@ is @true@ this also causes logins to the "old" account to be redirected to the "new" account. The "old" user account that was redirected becomes invisible in user listings. + +See "Merge user accounts":{{site.baseurl}}/admin/link-accounts.html , "Reassign user data ownership":{{site.baseurl}}/admin/reassign-ownership.html and "Linking alternate login accounts":{{site.baseurl}}/user/topics/link-accounts.html for examples of how this method is used. + +Must supply either @new_user_token@ (the currently authorized user will be the "old" user), or both @new_user_uuid@ and @old_user_uuid@ (the currently authorized user must be an admin). + +Arguments: + +table(table table-bordered table-condensed). +|_. Argument |_. Type |_. Description |_. Location |_. Example | +|new_user_token|string|A valid token for the "new" user|query|| +|new_user_uuid|uuid|The uuid of the "new" account|query|| +|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||