doc/user/api-tokens.md

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Getting an API token
   5 navorder: 1
   6 ---
   7
   8 # Getting an API token
   9
  10 > Needs a line or two to the effect of "an API token is a secret key that
  11 > enables the command line client to access arvados with the proper
  12 > permissions".
  13
  14 Open a browser and point it to the Workbench URL for your site. It
  15 will look something like this:
  16
  17 `https://workbench.{{ site.arvados_api_host }}/`
  18
  19 Log in, if you haven't done that already.
  20
  21 Click the "API tokens" link.
  22
  23 > Need to indicate that "API Tokens" is underneath "Access"
  24
  25 At the top of the "API tokens" page, you will see a few lines like this.
  26
  27     ### Pasting the following lines at a shell prompt will allow Arvados SDKs
  28     ### to authenticate to your account, youraddress@example.com
  29
  30     read ARVADOS_API_TOKEN <<EOF
  31     2jv9kd1o39t0pcfu7aueem7a1zjxhak73w90tzq3gx0es7j1ld
  32     EOF
  33     export ARVADOS_API_TOKEN ARVADOS_API_HOST=qr1hi.arvadosapi.com
  34
  35 Paste those lines into your terminal window to set up your
  36 terminal. This effectively copies your credentials from your browser
  37 to your terminal session.
  38
  39 Now, `arv -h user current` will display your account info in JSON
  40 format.
  41
  42 > What does `-h` mean?
  43
  44 Optionally, copy those lines to your .bashrc file so you don't have to
  45 repeat this process each time you log in.
  46
  47 ### SSL + development mode
  48
  49 > This section should go somewhere else, it is confusing to a new user.
  50
  51 If you are using a local development server with a self-signed
  52 certificate, you might need to bypass certificate verification. Don't
  53 do this if you are using a production service.
  54
  55     export ARVADOS_API_HOST_INSECURE=yes
  56