Выполнение запросов API с проверкой подлинности с помощью приложения в рабочем процессе Actions

Сведения о проверке подлинности Actions

Если необходимо выполнить запросы API с проверкой подлинности в рабочем процессе Actions или выполнить пользовательское действие, требующее маркера, следует использовать встроенный _TOKEN , если это возможно. _TOKEN Однако доступ к ресурсам может получить только в репозитории рабочего процесса. Если вам нужно получить доступ к дополнительным ресурсам, таким как ресурсы в организации или другом репозитории, можно использовать App. Дополнительные сведения о том, почему можно использовать App для personal access token, см. в разделе Создание приложений .

Проверка подлинности с помощью App

Чтобы использовать App для выполнения запросов API с проверкой подлинности, необходимо зарегистрировать App, сохранить учетные данные приложения и установить приложение. После этого вы можете использовать приложение для создания маркера доступа к установке, который можно использовать для выполнения запросов API с проверкой подлинности в рабочем процессе Actions. Маркер доступа к установке также можно передать пользовательскому действию, требующего маркера.

1. Зарегистрируйте App. Предоставьте App регистрации необходимых разрешений для доступа к нужным ресурсам. Дополнительные сведения см. в разделе [AUTOTITLE и Регистрация приложения ](/apps/creating--apps/setting-up-a--app/choosing-permissions-for-a--app).

2. Сохраните идентификатор приложения App в виде переменной конфигурации Actions. Идентификатор приложения можно найти на странице параметров приложения. Идентификатор приложения отличается от идентификатора клиента. Дополнительные сведения о переходе на страницу параметров для Appсм. в разделе Изменение регистрации приложения . Дополнительные сведения о хранении переменных конфигурации см. в разделе Хранение сведений в переменных.

3. Создайте закрытый ключ для приложения. Храните содержимое получившегося файла как секрет. (Храните все содержимое файла, включая -----BEGIN RSA PRIVATE KEY----- и -----END RSA PRIVATE KEY-----.) Дополнительные сведения см. в разделе Управление закрытыми ключами для приложений . Дополнительные сведения о хранении секретов см. в разделе Использование секретов в Actions.

4. Установите App в учетной записи пользователя или организации и предоставьте ему доступ к любым репозиториям, к которым требуется получить доступ к рабочему процессу. Дополнительные сведения см. в разделе Установка собственного приложения .

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

   Для этого можно использовать действие , как показано в следующем примере. Если вы предпочитаете не использовать это действие, можно вилировать и изменить actions/create--app-token действие или создать скрипт, чтобы рабочий процесс создавал маркер установки вручную. Дополнительные сведения см. в разделе Проверка подлинности в качестве установки приложения .

   В следующем примере рабочий процесс использует actions/create--app-token действие для создания маркера доступа к установке. Затем рабочий процесс использует маркер для выполнения запроса API через CLI.

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

on:
  workflow_dis:
jobs:
  demo_app_authentication:
    runs-on: ubuntu-latest
    steps:
      - name: Generate a token
        id: generate-token
        uses: actions/create--app-token@v2
        with:
          app-id: ${{ vars.APP_ID }}
          private-key: ${{ secrets.APP_PRIVATE_KEY }}

      - name: Use the token
        env:
          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
        run: |
          gh api octocat

on:
  workflow_dis:
jobs:
  demo_app_authentication:
    runs-on: ubuntu-latest
    steps:
      - name: Generate a token
        id: generate-token
        uses: actions/create--app-token@v2
        with:
          app-id: ${{ vars.APP_ID }}
          private-key: ${{ secrets.APP_PRIVATE_KEY }}

      - name: Use the token
        env:
          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
        run: |
          gh api octocat