9.3. Personal Access Token の管理
Personal Access Token を使用すると、パスワードを使用せずに、API リクエストを認証できます。Personal Access Token の有効期限を設定できます。有効期限が切れる前に、有効期限が切れると判断した場合は、トークンを取り消すことができます。
9.3.1. Personal Access Token の作成
この手順を使用して、Personal Access Token を作成します。
手順
- Satellite Web UI で、Administer > Users に移動します。
- Personal Access Token を作成するユーザーを選択します。
- Personal Access Tokens タブで、Add Personal Access Token をクリックします。
- Personal Access Token の Name を入力します。
- オプション: Expires 日付を選択して、有効期限を設定します。有効期限を設定しない場合、Personal Access Token は、取り消されないかぎり、期限切れになりません。
Submit をクリックします。Personal Access Tokens タブで、Personal Access Token を使用できるようになりました。
重要ページを離れるか、新しい Personal Access Token を作成すると、再びアクセスできなくなるため、Personal Access Token を必ず保存してください。Copy to clipboard をクリックして、Personal Access Token をコピーできます。
検証
Satellite Server に API リクエストを送信し、Personal Access Token で認証します。
# curl https://satellite.example.com/api/status --user My_Username:My_Personal_Access_Token
ステータス
200
のレスポンスを受け取る必要があります。次に例を示します。{"satellite_version":"6.15.0","result":"ok","status":200,"version":"3.5.1.10","api_version":2}
Personal Access Tokens タブに戻ると、Personal Access Token の横に更新された Last Used 時刻が表示されます。
9.3.2. Personal Access Token の取り消し
この手順を使用して、有効期限が切れる前に、Personal Access Token を取り消します。
手順
- Satellite Web UI で、Administer > Users に移動します。
- Personal Access Token を取り消すユーザーを選択します。
- Personal Access Tokens タブで、取り消す Personal Access Token を見つけます。
- 取り消す Personal Access Token の横にある Actions 列の 取り消し をクリックします。
検証
Satellite Server に API リクエストを送信し、失効した Personal Access Token で認証を試みます。
# curl https://satellite.example.com/api/status --user My_Username:My_Personal_Access_Token
次のエラーメッセージが表示されます。
{ "error": {"message":"Unable to authenticate user My_Username"} }