POST токен* - История изменений

IKuznetsov в 17:29, 2 января 2025

2025-01-02T17:29:36Z

← Предыдущая версия		Версия от 17:29, 2 января 2025
Строка 1:		Строка 1:
			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=PUT%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F-,%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20v2,-%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0 Токены v2] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D0%BE%D0%B3%D0%BE%D0%A8%D0%BB%D1%8E%D0%B7%D0%B0 Токены АктивногоШлюза] / POST токен*'''''

	Создает новый токен АктивногоШлюза.		Создает новый токен АктивногоШлюза.

Строка 90:		Строка 92:
	"seedToken": false,		"seedToken": false,
	"activeGateType": "ENVIRONMENT"		"activeGateType": "ENVIRONMENT"
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 136:		Строка 138:
	"token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",		"token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",
	"expirationDate": "2020-11-24T08:15:30.144Z"		"expirationDate": "2020-11-24T08:15:30.144Z"
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 153:		Строка 155:
	"seedToken": false,		"seedToken": false,
	"activeGateType": "ENVIRONMENT"		"activeGateType": "ENVIRONMENT"
	}'~~</code>~~		}'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 164:		Строка 166:
	"seedToken": false,		"seedToken": false,
	"activeGateType": "ENVIRONMENT"		"activeGateType": "ENVIRONMENT"
	}~~</code>~~		}

	==== Тело ответа ====		==== Тело ответа ====
Строка 171:		Строка 173:
	"token": "dt0g02.xyz789.987654321zyxwvutsrq",		"token": "dt0g02.xyz789.987654321zyxwvutsrq",
	"expirationDate": "2021-12-14T13:42:31.148Z"		"expirationDate": "2021-12-14T13:42:31.148Z"
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
	201		201

IKuznetsov в 09:12, 26 декабря 2024

2024-12-26T09:12:57Z

← Предыдущая версия		Версия от 09:12, 26 декабря 2024
Строка 6:		Строка 6:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code>
	\|-		\|-
Строка 85:		Строка 85:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"name": "myToken",		"name": "myToken",
	"expirationDate": "now+14d",		"expirationDate": "now+14d",
Строка 132:		Строка 132:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"id": "dt0g02.4KWZO5EF",		"id": "dt0g02.4KWZO5EF",
	"token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",		"token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",
Строка 144:		Строка 144:

	==== Curl ====		==== Curl ====
	<~~code>~~curl --request GET \		<curl --request GET \
	--url <nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens</nowiki> \		--url <nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens</nowiki> \
	--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 159:		Строка 159:

	==== Тело запроса ====		==== Тело запроса ====
	<~~code>~~{		<{
	"name": "REST test",		"name": "REST test",
	"expirationDate": "now+14d",		"expirationDate": "now+14d",
Строка 167:		Строка 167:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"id": "dt0g02.xyz789",		"id": "dt0g02.xyz789",
	"token": "dt0g02.xyz789.987654321zyxwvutsrq",		"token": "dt0g02.xyz789.987654321zyxwvutsrq",

ENetrebin: Новая страница: «Создает новый токен АктивногоШлюза. Токен будет принадлежать пользователю, которому пр...»

2022-10-25T14:14:07Z

Новая страница: «Создает новый токен АктивногоШлюза. Токен будет принадлежать пользователю, которому пр...»

Новая страница

Создает новый токен АктивногоШлюза.

Токен будет принадлежать пользователю, которому принадлежит токен, используемый для аутентификации вызова.

Запрос создает и использует <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Создание токенов АктивногоШлюза ( <code>activeGateTokenManagement.create</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|ActiveGateTokenCreate
|Тело JSON запроса. Содержит параметры нового токена АктивногоШлюза.
|body
|требуется
|}

=== Объекты тела запроса ===

==== Объект <code>ActiveGateTokenCreate</code> ====
Параметры нового токена АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|name
|string
|Имя токена.
|требуется
|-
|expirationDate
|string
|Срок действия токена.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минуты
** <code>h</code>: часы
** <code>d</code>: дни
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, срок действия токена никогда не истекает.
|по желанию
|-
|seedToken
|boolean
|Токен является начальным токеном ( <code>true</code>) или отдельным токеном ( <code>false</code>).

Мы рекомендуем использовать индивидуальный токен (false).
|по желанию
|-
|activeGateType
|string
|Тип АктивногоШлюза, для которого действителен токен.

Элемент может содержать эти значения

* <code>ENVIRONMENT</code>
* <code>CLUSTER</code>
|требуется
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"name": "myToken",
"expirationDate": "now+14d",
"seedToken": false,
"activeGateType": "ENVIRONMENT"
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|ActiveGateTokenCreated
|Успех. Токен создан. Тело ответа содержит секрет токена.
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|}

=== Объекты тела ответа ===

==== Объект <code>ActiveGateTokenCreated</code> ====
Недавно созданный токен АктивногоШлюза.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
|-
|token
|string
|Секрет токена.
|-
|expirationDate
|string
|Дата истечения срока действия токена в формате ISO 8601 ( <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).
|}

=== JSON-модель тела ответа ===
<code>{
"id": "dt0g02.4KWZO5EF",
"token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",
"expirationDate": "2020-11-24T08:15:30.144Z"
}</code>

== Пример ==
В этом примере запрос создает новый токен АктивногоШлюза для среды АктивногоШлюза. Токен действителен в течение двух недель (14 дней) с момента создания.

Маркер API передается в заголовке авторизации .

==== Curl ====
<code>curl --request GET \
--url <nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--header 'Content-Type: application/json' \
--data '{
"name": "REST test",
"expirationDate": "now+14d",
"seedToken": false,
"activeGateType": "ENVIRONMENT"
}'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens</nowiki></code>

==== Тело запроса ====
<code>{
"name": "REST test",
"expirationDate": "now+14d",
"seedToken": false,
"activeGateType": "ENVIRONMENT"
}</code>

==== Тело ответа ====
<code>{
"id": "dt0g02.xyz789",
"token": "dt0g02.xyz789.987654321zyxwvutsrq",
"expirationDate": "2021-12-14T13:42:31.148Z"
}</code>

==== Код ответа ====
201