トークン
ユーザーはJSON Web Token (JWT) を取得するために、ScrewdriverのAPIへ(ユーザーまたはパイプラインスコープの)アクセストークンを渡すことができます。JWTはScrewdriverのAPIへさらなるリクエストを作成する時のAuthorizationヘッダーとして使用できます。
ビルドもJWTを$SD_TOKEN
という名前の環境変数で生成します。
ユーザーアクセストークン
ユーザーアクセストークンは、特定のユーザーに紐付きます。 ユーザーアクセストークンを生成するには:
-
任意のページの右上の角で、ユーザー名をクリックします。その後、ユーザー設定をクリックします。
-
トークンの名前と説明を入力します。
-
Addをクリックしてトークンを生成します。
-
トークンをクリップボードにコピーします。セキュリティ上の理由から、このページを離れた後はトークンを再度見ることはできません。
オプション
トークンの作成後、Refreshボタンを押して新しいトークンを生成したり、削除したりできます。
パイプラインアクセストークン
パイプラインアクセストークンは、Screwdriverのパイプラインに紐付きます。 パイプラインアクセストークンを生成するには:
-
Screwdriverのパイプラインページで、パイプライン名の下にあるSecretsタブをクリックします。
-
アクセストークンのところに、トークンの名前と説明を入力します。
-
Addをクリックしてトークンを生成します。
-
トークンをクリップボードにコピーします。セキュリティ上の理由から、このページを離れた後はトークンを再度見ることはできません。
アクセストークンを使う
新しく生成したトークンを認証するために、https://${API_URL}/v4/auth/token?api_token=${YOUR_TOKEN_VALUE}
へGETリクエストを送ります。するとtokenのフィールドを持ったJSONオブジェクトが返ってきます。このtokenフィールドの値が、ScrewdriverのAPIへリクエストを送る時のAuthorization headerとして使えるJSON Web Tokenとなります。このJWTは12時間の有効期限があり、その後は再度認証を行う必要があります。
詳しくはAPIドキュメントをご覧ください。