Токены и аутентификация (API): различия между версиями

Версия от 10:34, 3 декабря 2021

Чтобы пройти аутентификацию для использования Ключ-АСТРОМ API, вам понадобится действующий токен доступа или действительный токен личного доступа . Доступ к API детализирован, что означает, что вам также потребуются соответствующие разрешения, назначенные токену. См. описание каждого запроса, чтобы узнать, какие разрешения требуются для его использования.

Формат токена

Ключ-АСТРОМ использует уникальный формат токенов, состоящий из трех компонентов, разделенных точками (.). Например:
dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM

dt0c01 - Префикс для идентификации токена.
ST2...7YN - Открытая часть токена. 24-значный открытый идентификатор токена. Это значение можно безопасно отображать в пользовательском интерфейсе и использовать для ведения журнала.
G3D...RZM - Секретная часть токена. 64-символьная секретная часть токена, которую можно рассматривать как пароль, поэтому она не отображается в веб-интерфейсе Ключ-АСТРОМ (после первоначального создания) и не сохраняется в файлах журнала.

Создание токена

Токен API

Чтобы сгенерировать токен доступа

В меню Ключ-АСТРОМ выберите маркеры доступа.
Выберите Создать новый токен .
Введите имя для вашего токена.
Выберите необходимые разрешения для токена.
Выберите «Создать» .
Скопируйте сгенерированный токен в буфер обмена. Сохраните токен в диспетчере паролей для использования в будущем.

Вы можете получить доступ к своему токену только один раз после его создания.

Вы можете назначить несколько разрешений для одного токена или вы можете сгенерировать несколько токенов, каждый с разными уровнями доступа, и использовать их соответствующим образом - проверьте политики безопасности вашей организации, чтобы получить наилучшие рекомендации.

В качестве альтернативы вы можете использовать POST запрос (токен) к API токенов аутентификации для создания токена.

Ключ-АСТРОМ не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.

Токен персонального доступа

Для создания токена личного доступа

Выберите меню пользователя в правом верхнем углу страницы.
Выберите токены личного доступа .
Выберите Создать новый токен .
Введите имя для вашего токена.
Выберите необходимые разрешения для токена.
Выберите «Создать» .
Скопируйте сгенерированный токен в буфер обмена. Сохраните токен в диспетчере паролей для использования в будущем.

Вы можете получить доступ к своему токену только один раз после его создания.

Вы можете назначить несколько разрешений одному токену или сгенерировать несколько токенов, каждый с разными разрешениями - проверьте политики безопасности вашей организации, чтобы получить наилучшие рекомендации. Вы можете сгенерировать до пяти токенов личного доступа.

В качестве альтернативы вы можете использовать POST запрос (токен) к API токенов аутентификации для создания токена личного доступа.

Ключ-АСТРОМ не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.

Разрешения токена

Токен API

Ключ-АСТРОМ предоставляет следующие разрешения для токенов API. Вы можете установить их в пользовательском интерфейсе, как описано выше, или через API токенов аутентификации. Некоторые области доступны только через API.

API v2
Имя	Значение API	Описание
Чтение метрик	metrics.read	Предоставляет доступ к GET-запросам Metrics API v2 .
Запись метрик	metrics.write	Предоставляет доступ к удалению пользовательской метрики для запроса к Metrics API v2.

@@ Строка 18: / Строка 18: @@
 # Введите имя для вашего токена.
 # Выберите необходимые разрешения для токена.
-# Выберите « Создать» .
+# Выберите «Создать» .
 # Скопируйте сгенерированный токен в буфер обмена. Сохраните токен в диспетчере паролей для использования в будущем.<br>
 '''Вы можете получить доступ к своему токену только один раз после его создания.'''
@@ Строка 36: / Строка 36: @@
 # Введите имя для вашего токена.
 # Выберите необходимые разрешения для токена.
-# Выберите « Создать» .
+# Выберите «Создать» .
 # Скопируйте сгенерированный токен в буфер обмена. Сохраните токен в диспетчере паролей для использования в будущем.<br>
 '''Вы можете получить доступ к своему токену только один раз после его создания.'''
@@ Строка 45: / Строка 45: @@
 Ключ-АСТРОМ не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.
+== Разрешения токена ==
+=== Токен API ===
+Ключ-АСТРОМ предоставляет следующие разрешения для токенов API. Вы можете установить их в пользовательском интерфейсе, как описано выше, или через [[API токенов аутентификации]]. Некоторые области доступны только через API.<br>
+{| class="wikitable"
+|+API v2
+!Имя
+!Значение API
+!Описание
+|-
+|Чтение метрик
+|metrics.read
+|Предоставляет доступ к GET-запросам [[Metrics API v2]] .
+|-
+|Запись метрик
+|metrics.write
+|Предоставляет доступ к [[удалению пользовательской метрики]] для запроса к Metrics API v2.
+|}