Skip to content

Commit 4b9e153

Browse files
orange13github-actions[bot]
authored andcommitted
(docs) Add documentation ydb get auth (#28930)
(cherry picked from commit 9bade1e)
1 parent b12eded commit 4b9e153

File tree

2 files changed

+71
-0
lines changed

2 files changed

+71
-0
lines changed
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Получение токена аутентификации
2+
3+
С помощью подкоманды `auth get-token` вы можете получить токен аутентификации на основе параметров аутентификации, указанных в профиле, переменных окружения или параметрах командной строки.
4+
5+
Общий вид команды:
6+
7+
```bash
8+
{{ ydb-cli }} [global options...] auth get-token [options...]
9+
```
10+
11+
* `global options`[глобальные параметры](commands/global-options.md).
12+
* `options`[параметры подкоманды](#options).
13+
14+
Посмотрите описание команды получения токена:
15+
16+
```bash
17+
{{ ydb-cli }} auth get-token --help
18+
```
19+
20+
## Параметры подкоманды {#options}
21+
22+
Параметр | Описание
23+
---|---
24+
`-f, --force` | Вывести токен без запроса подтверждения.
25+
`--timeout` | Время ожидания ответа клиента в миллисекундах. После истечения этого времени нет смысла ждать результат.
26+
27+
## Примеры {#examples}
28+
29+
{% include [ydb-cli-profile](../../_includes/ydb-cli-profile.md) %}
30+
31+
### Получение токена с подтверждением {#with-prompt}
32+
33+
По умолчанию команда запрашивает подтверждение перед выводом токена, так как токен будет выведен в консоль:
34+
35+
```bash
36+
{{ ydb-cli }} -p quickstart auth get-token
37+
```
38+
39+
Результат:
40+
41+
```text
42+
Caution: Your auth token will be printed to console. Use "--force" ("-f") option to print without prompting.
43+
Do you want to proceed? (y/N): y
44+
t1.eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
45+
```
46+
47+
### Получение токена без подтверждения {#without-prompt}
48+
49+
Для автоматизации или использования в скриптах используйте опцию `--force` для вывода токена без запроса подтверждения:
50+
51+
```bash
52+
{{ ydb-cli }} -p quickstart auth get-token --force
53+
```
54+
55+
Результат:
56+
57+
```text
58+
t1.eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
59+
```
60+
61+
### Использование в скриптах {#in-scripts}
62+
63+
Команда может быть использована для получения токена в скриптах:
64+
65+
```bash
66+
TOKEN=$({{ ydb-cli }} -p quickstart auth get-token --force)
67+
echo "Token: $TOKEN"
68+
```
69+

ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,8 @@ items:
120120
href: commands/discovery-list.md
121121
- name: Проверка аутентификации
122122
href: commands/discovery-whoami.md
123+
- name: Получение токена аутентификации
124+
href: auth-get-token.md
123125
- name: Просмотр параметров соединения
124126
href: commands/config-info.md
125127
- name: Вывод версии YDB CLI

0 commit comments

Comments
 (0)