Об acurl и get_token

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

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 .

Использование утилит Apigee для получения токенов или доступа к серверу аутентификации для Edge API является необязательным. Вы можете реализовать собственные схемы для генерации токенов доступа OAuth2 и отправки их в запросах к Edge API.

Установите acurl и get_token.

Apigee предоставляет ZIP-файл, содержащий acurl (1) , get_token (1) и скрипт установки.

Для установки acurl и get_token :

  1. Создайте каталог установки на вашем компьютере или используйте каталог usr/local/bin по умолчанию.
  2. Загрузите установочный ZIP-файл с сайта Apigee: 
    curl https://login.apigee.com/resources/scripts/sso-cli/ssocli-bundle.zip -O
  3. Распакуйте загруженный файл.
  4. Выполните скрипт установки:
    sudo ./install -b /usr/local/bin

    Параметр -b указывает местоположение исполняемых файлов. Если этот параметр не указан, скрипт установки установит утилиты в /usr/local/bin .

  5. Проверьте установку:
        acurl -h
    get_token -h

    В случае успешной установки эти команды вернут текст справки для утилит.

Срок действия токена истекает

acurl и get_token генерируют токены со следующей длительностью:

  • Срок действия токенов доступа истекает через 12 часов.
  • Срок действия токенов обновления составляет 30 дней.

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

Настройте конечную точку SSO.

Перед первым вызовом необходимо указать конечную точку сервера авторизации для API Edge, который вы хотите использовать с acurl и get_token .

В терминале установите переменную среды SSO_LOGIN_URL на конечную точку вашего сервера авторизации. Например:

  • Для облачных клиентов, не имеющих зоны: 
    export SSO_LOGIN_URL=https://login.apigee.com
  • Для облачных клиентов с зоной: 
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • Для клиентов, использующих частное облако, обратитесь к своему администратору за информацией о соответствующей точке входа для единого входа (SSO).

Используйте одноразовый пароль (требуется для SAML).

При выполнении вызова API с помощью acurl или get_token вам необходимо пройти аутентификацию в утилите, чтобы получить пару токенов. Это можно сделать, передав имя пользователя, пароль и код многофакторной аутентификации (MFA) вашей учетной записи Apigee. Однако, если вы используете SAML IDP или не хотите использовать свой пароль, вы можете получить одноразовый код доступа.

Чтобы получить одноразовый пароль:

  1. Введите следующий URL-адрес в браузере:
    • Для облачных клиентов, не имеющих зоны: 
      https://login.apigee.com/passcode
    • Для облачных клиентов с зоной: 
      https://zone_name.login.apigee.com/passcode
    • Для клиентов, использующих частное облако, обратитесь к своему администратору за информацией о соответствующей точке входа для единого входа (SSO).
  2. Войдите в свою учетную запись Apigee.
  3. Скопируйте 6-символьный пароль.
  4. Используйте 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) Авторское право 2023 Google LLC
Инструменты acurl и get_token предоставляются в качестве «программного обеспечения» в соответствии с соглашением, регулирующим использование вами платформы Google Cloud Platform, включая Условия предоставления услуг, доступные по адресу https://cloud.google.com/terms/service-terms .