Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Apigee предоставляет следующие удобные утилиты для создания и передачи токенов доступа и обновления OAuth2. Вы используете эти токены для аутентификации в вызовах Edge API с помощью OAuth (включая рабочие процессы SAML и LDAP):
-
acurl
(1) : обеспечивает удобную оболочку для стандартной командыcurl
. Создает HTTP-запросы к Edge API, получает токены доступа и обновления изget_token
и передает токен доступа в Edge API. -
get_token
(1) : обменивает ваши учетные данные Apigee на токены доступа и обновления, которые вы можете использовать для вызова Edge API.
Обе эти утилиты обменивают учетные данные вашей учетной записи Apigee (имя пользователя и пароль или пароль) на токены OAuth2.
Токены, созданные утилитами Apigee, соответствуют спецификации OAuth 2.0 Authorization Framework .
Использование утилит Apigee для получения токенов или доступа к серверу аутентификации для Edge API не является обязательным. Вы можете реализовать свои собственные схемы для генерации токенов доступа OAuth2 и отправлять их в своих запросах к Edge API.
Установите acurl и get_token
Apigee предоставляет ZIP-файл, содержащий acurl
(1) , get_token
(1) и сценарий установки.
Чтобы установить acurl
и get_token
:
- Создайте каталог установки на своем компьютере или используйте каталог
usr/local/bin
по умолчанию. - Загрузите установочный ZIP-файл с Apigee:
curl https://login.apigee.com/resources/scripts/sso-cli/ssocli-bundle.zip -O
- Разархивируйте загруженный файл.
- Выполните скрипт установки:
sudo ./install -b /usr/local/bin
Опция
-b
указывает расположение исполняемых файлов. Если вы не укажете эту опцию, сценарий установки установит утилиты в/usr/local/bin
. - Протестируйте установки:
acurl -h
get_token -h
Если установка прошла успешно, эти команды возвращают текст справки для утилит.
Срок действия токена
acurl
и get_token
генерируют токены со следующей длительностью:
- Срок действия токенов доступа истекает через 12 часов.
- Срок действия токенов обновления истекает через 30 дней.
В результате после успешного выполнения вызова API с помощью acurl
или get_token
вы можете продолжать использовать пару токенов в течение 30 дней. По истечении срока действия необходимо повторно ввести свои учетные данные и получить новые токены.
Установите конечную точку единого входа
Прежде чем сделать первый вызов, вы должны установить конечную точку сервера авторизации для Edge API, который вы хотите использовать с acurl
и get_token
.
В терминале установите для переменной среды SSO_LOGIN_URL
конечную точку вашего сервера авторизации. Например:
- Для клиентов Cloud без зоны:
export SSO_LOGIN_URL=https://login.apigee.com
- Для клиентов Cloud с зоной:
export SSO_LOGIN_URL=https://zone_name.login.apigee.com
- Для клиентов частного облака обратитесь к своему администратору для получения соответствующей конечной точки единого входа.
Используйте одноразовый код доступа (требуется для SAML).
Когда вы выполняете вызов API с помощью acurl
или get_token
, вы должны пройти аутентификацию в утилите, чтобы получить пару токенов. Вы можете сделать это, передав имя пользователя, пароль и код MFA вашей учетной записи Apigee. Однако, если вы используете SAML IDP или не хотите использовать свой пароль, вместо этого вы можете получить одноразовый код-пароль.
Чтобы получить одноразовый пароль:
- Введите следующий URL-адрес в браузере:
- Для клиентов Cloud без зоны:
https://login.apigee.com/passcode
- Для клиентов Cloud с зоной:
https://zone_name.login.apigee.com/passcode
- Для клиентов частного облака обратитесь к своему администратору для получения соответствующей конечной точки единого входа.
- Для клиентов Cloud без зоны:
- Войдите в свою учетную запись Apigee.
- Скопируйте 6-значный пароль.
- Используйте
acurl
илиget_token
с опцией-p
и передайте код доступа, как в следующем примере:get_token -p 1a2b3c
Просмотреть свои токены
Когда вы успешно выполняете acurl
или get_token
, утилиты создают файл данных в ~/.sso-cli
, который содержит токены и другие метаданные.
Чтобы просмотреть токены, вы можете использовать следующую команду:
get_token -v
Эта команда отображает декодированные утверждения токена, например:
Decoded token claims: { "jti": "8018507e-9f34-4a90-bf97-ff226a06b19b", "sub": "858217a9-01a1-4111-8525-75ca555f5d5c", "scope": [ "scim.emails.read", "scim.me", "openid", "password.write", "approvals.me", "scim.ids.read", "oauth.approvals" ], "client_id": "edgecli", "cid": "edgecli", "azp": "edgecli", "grant_type": "password", "user_id": "858217a9-01a1-4111-8525-75ca555f5d5c", "origin": "usergrid", "user_name": "myusername@google.com", "email": "myusername@google.com", "auth_time": 1597444772, "al": 0, "rev_sig": "6271c527", "iat": 1597444772, "exp": 1597487972, "iss": "https://login.apigee.com", "zid": "uaa", "aud": [ "edgecli", "scim.emails", "scim", "openid", "password", "approvals", "scim.ids", "oauth" ] } Current timestamp: 1597444983 Existing access token is still valid
(1) Авторские права принадлежат Google LLC, 2023 г.
Инструменты acurl
и get_token
доступны как «Программное обеспечение» в соответствии с соглашением, регулирующим использование вами Google Cloud Platform, включая Условия для конкретных услуг, доступные по адресу https://cloud.google.com/terms/service-terms .