3.3. Personal Access Token 認証の概要

手順

1. Satellite Web UI で、Administer > Users に移動します。
2. Personal Access Token を作成するユーザーを選択します。
3. Personal Access Tokens タブで、Add Personal Access Token をクリックします。
4. Personal Access Token の Name を入力します。
5. オプション: Expires 日付を選択して、有効期限を設定します。有効期限を設定しない場合、Personal Access Token は、取り消されないかぎり、期限切れになりません。

6. Submit をクリックします。Personal Access Tokens タブで、Personal Access Token を使用できるようになりました。

   重要

   ページを離れるか、新しい Personal Access Token を作成すると、再びアクセスできなくなるため、Personal Access Token を必ず保存してください。Copy to clipboard をクリックして、Personal Access Token をコピーできます。

検証

1. Satellite サーバーに API リクエストを送信し、Personal Access Token で認証します。

   # curl https://satellite.example.com/api/status --user My_Username:My_Personal_Access_Token

2. ステータス 200 のレスポンスを受け取る必要があります。次に例を示します。

   {"satellite_version":"6.12.0","result":"ok","status":200,"version":"3.5.1.10","api_version":2}

   Personal Access Tokens タブに戻ると、Personal Access Token の横に更新された Last Used 時刻が表示されます。

手順

1. Satellite Web UI で、Administer > Users に移動します。
2. Personal Access Token を取り消すユーザーを選択します。
3. Personal Access Tokens タブで、取り消す Personal Access Token を見つけます。
4. 取り消す Personal Access Token の横にある Actions 列の 取り消し をクリックします。

検証

1. Satellite サーバーに API リクエストを送信し、失効した Personal Access Token で認証を試みます。

   # curl https://satellite.example.com/api/status --user My_Username:My_Personal_Access_Token

2. 次のエラーメッセージが表示されます。

   {
     "error": {"message":"Unable to authenticate user My_Username"}
   }