X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b91db14a4dced9d6ea124e86be3c796e6f2c8e8c..60418cbc557779898c50052af088f44f699ae157:/doc/user/reference/api-tokens.html.textile.liquid diff --git a/doc/user/reference/api-tokens.html.textile.liquid b/doc/user/reference/api-tokens.html.textile.liquid index 317e7a026d..6afc20bf4f 100644 --- a/doc/user/reference/api-tokens.html.textile.liquid +++ b/doc/user/reference/api-tokens.html.textile.liquid @@ -3,48 +3,30 @@ layout: default navsection: userguide title: "Getting an API token" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -The Arvados API token is a secret key that enables the @arv@ command line client to access Arvados with the proper permissions. +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -Access the Arvados Workbench using this link: "https://{{ site.arvados_workbench_host }}/":https://{{ site.arvados_workbench_host }}/ (Replace @{{ site.arvados_api_host }}@ with the hostname of your local Arvados instance if necessary.) +The Arvados API token is a secret key that enables the Arvados command line tools to authenticate themselves. -Open a shell on the system where you want to use the Arvados client. This may be your local workstation, or "an Arvados virtual machine accessed with SSH":{{site.baseurl}}/user/getting_started/ssh-access.html. +Access the Arvados Workbench using this link: "{{site.arvados_workbench_host}}/":{{site.arvados_workbench_host}}/ (Replace the hostname portion with the hostname of your local Arvados instance if necessary.) -Click on the user icon in the upper right corner to access the user settings menu. Click on the menu item *Manage API tokens* to go to the "Api client authorizations" page. +Open a shell on the system where you want to use the Arvados client. This may be your local workstation, or an Arvados virtual machine accessed with "Webshell":{{site.baseurl}}/user/getting_started/vm-login-with-webshell.html or SSH (instructions for "Unix":{{site.baseurl}}/user/getting_started/ssh-access-unix.html#login or "Windows":{{site.baseurl}}/user/getting_started/ssh-access-windows.html#login). -h2. The easy way +In the Arvados Workbench, click on the dropdown menu icon in the upper right corner of the top navigation menu to access the user settings menu, and click on the menu item *Current token*, which lists your current token and instructions to set up your environment. -For your convenience, the "Api client authorizations" page on Workbench provides a *Help* tab that includes a command you may copy and paste directly into the shell. It will look something like this: +h2. Setting environment variables -bc. ### Pasting the following lines at a shell prompt will allow Arvados SDKs -### to authenticate to your account, you@example.com -read ARVADOS_API_TOKEN < in the upper right corner of the top navigation menu, includes a command you may copy and paste directly into the shell. It will look something as the following. -* The @read@ command reads text input until @EOF@ (designated by @< -
$ export ARVADOS_API_HOST={{ site.arvados_api_host }}
-$ export ARVADOS_API_TOKEN=2jv9346o3966345u7ueuim7a1zaaoueo3w90tzq3gx0es7j1ld
-
- +bc. HISTIGNORE=$HISTIGNORE:'export ARVADOS_API_TOKEN=*' +export ARVADOS_API_TOKEN=2jv9346o396exampledonotuseexampledonotuseexes7j1ld +export ARVADOS_API_HOST={{ site.arvados_api_host }} +unset ARVADOS_API_HOST_INSECURE -* @ARVADOS_API_HOST@ tells @arv@ which host to connect to. -* @ARVADOS_API_TOKEN@ is the secret key used by the Arvados API server to authenticate access. Its value is the text you copied from the *api_token* column on the Workbench. - -If you are connecting to a development instance with a unverified/self-signed SSL certificate, set this variable to skip SSL validation: - - -
$ export ARVADOS_API_HOST_INSECURE=1
-
-
+* The @export@ command puts a local shell variable into the environment that will be inherited by child processes such as the @arv@ client. h2. settings.conf