Skip to content

Commit 445c081

Browse files
authored
DOC-781 | Access tokens (#743)
* WIP * WIP Access token examples * Complete API description, add release notes * [skip ci] Automatic commit of generated files from CircleCI
1 parent 2eac9ac commit 445c081

File tree

20 files changed

+1512
-34
lines changed

20 files changed

+1512
-34
lines changed

site/content/3.12/components/tools/arangodb-shell/examples.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ command-line options:
1515
- `--server.database <string>`: name of the database to connect to
1616
- `--server.endpoint <string>`: endpoint to connect to
1717
- `--server.username <string>`: database username
18-
- `--server.password <string>`: password to use when connecting
18+
- `--server.password <string>`: password or access token to use when connecting
1919
- `--server.authentication <bool>`: whether or not to use authentication
2020

2121
For example, to connect to an ArangoDB server on IP `192.168.173.13` on port
@@ -26,7 +26,9 @@ arangosh --server.endpoint tcp://192.168.173.13:8530 --server.username foo --ser
2626
```
2727

2828
_arangosh_ then displays a password prompt and tries to connect to the
29-
server after the password is entered.
29+
server after the password is entered. You can also use an access token instead
30+
of a password (but make sure `--server.username` is set to the same user name as
31+
encoded in the access token).
3032

3133
{{< warning >}}
3234
At signs `@` in startup option arguments need to be escaped as `@@`.

site/content/3.12/components/tools/arangodump/examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ following startup options:
2727

2828
- `--server.endpoint <string>`: endpoint to connect to
2929
- `--server.username <string>`: username
30-
- `--server.password <string>`: password to use (omit this and you'll be prompted for the
31-
password)
30+
- `--server.password <string>`: password or access token to use
31+
(omit this and you'll be prompted for the password)
3232
- `--server.authentication <bool>`: whether or not to use authentication
3333

3434
If you want to connect to a different database or dump all databases you can additionally

site/content/3.12/components/tools/arangoexport/examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ or use authentication, you can use the following command-line options:
2525
- `--server.database <string>`: the name of the database to connect to
2626
- `--server.endpoint <string>`: the endpoint to connect to
2727
- `--server.username <string>`: the username
28-
- `--server.password <string>`: the password to use (omit this to get prompted
29-
for the password)
28+
- `--server.password <string>`: password or access token to use
29+
(omit this and you'll be prompted for the password)
3030
- `--server.authentication <bool>`: whether or not to use authentication
3131

3232
Here is an example of exporting data from a non-standard endpoint, using a dedicated

site/content/3.12/components/tools/arangoimport/examples-json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ By default, the endpoint `tcp://127.0.0.1:8529` is used. If you want to
209209
specify a different endpoint, you can use the `--server.endpoint` option. You
210210
probably want to specify a database user and password as well. You can do so by
211211
using the options `--server.username` and `--server.password`. If you do not
212-
specify a password, you are prompted for one.
212+
specify a password (or access token), you are prompted for one.
213213

214214
```
215215
arangoimport --server.endpoint tcp://127.0.0.1:8529 --server.username root ...

site/content/3.12/components/tools/arangoinspect/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ arangoinspect --server.endpoint tcp://127.0.0.1:8529
3131
This starts the tool with a prompt for the JWT secret and tries to connect
3232
to the specified ArangoDB server. You have to type the secret as is used for
3333
the `arangod` option `--server.jwt-secret`. For non-cluster deployments,
34-
you may authenticate with a user name and password instead:
34+
you may authenticate with a user name and password (or access token) instead:
3535

3636
```
3737
arangoinspect --server.ask-jwt-secret false --server.username "root" --server.password "foobar"

site/content/3.12/components/tools/arangorestore/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ following startup options:
2525

2626
- `--server.endpoint <string>`: endpoint to connect to
2727
- `--server.username <string>`: username
28-
- `--server.password <string>`: password to use
28+
- `--server.password <string>`: password or access token to use
2929
(omit this and you'll be prompted for the password)
3030
- `--server.authentication <bool>`: whether or not to use authentication
3131

0 commit comments

Comments
 (0)