APIキーにオーナーと用途がわかる名前を付ける

クライアントと用途がわかる検索可能な64文字以内のキー名を付け、名前を変更する必要がある場合は認証情報を安全に置き換えます。

最終確認日

スクリーンショットは英語版の画面です。

APIキーの名前は認証情報とともに保存される検索可能なラベルです。dosyaは名前をオーナー、環境、用途のフィールドに分解しません。同じ名前を複数使用できます。

4つのパネルに、クライアントと用途を示す命名規則の選択、64文字以内の名前の入力、検索によるマスク済みの行の特定、名前が実態に合わなくなった場合のキーの置き換えが表示されています。
4つのパネルに、クライアントと用途を示す命名規則の選択、64文字以内の名前の入力、検索によるマスク済みの行の特定、名前が実態に合わなくなった場合のキーの置き換えが表示されています。 スクリーンショットを原寸で開く。

わかりやすい命名規則を選ぶ

プロフィール → API(APIキー)の新しいAPIキーダイアログの用途欄には「例:rclone バックアップ」と表示されます。e.g. rclone backupも名前の例です。rclone-prod-opsのように、client-environment-ownerやclient-purposeを使うと便利です。これは運用上のルールであり、サーバーが強制する形式ではありません。

手順

  1. 認証情報を使用する1つのアプリケーション、環境、担当チームまたは担当者を特定してください。
  2. 区別に必要な情報を含む簡潔な名前を作成してください。シークレット、顧客データ、一時的なチケット番号は含めないでください。
  3. 用途に入力し、64文字以内に収めてください。
  4. 権限と制限を設定し、キーを生成を押して、一度だけ表示されるdos_…の値を名前とは別に保存してください。
  5. APIキーの一覧に戻り、名前またはプレフィックスで検索を使って新しい行を確実に特定できることを確認してください。
  6. 後で名前が実態に合わなくなった場合は、同じ設定で正しい名前のキーを作成し、クライアントを移行してから古いキーを無効化してください。

入力の検証と識別

APIが返すエラーはName is requiredとName must be 64 characters or lessです。Web画面の補足には**後で識別するためのラベルです。**と表示されます。名前は認証に使う値ではなく、一意である必要もありません。

一覧にはマスクされたフィンガープリントが表示され、名前または保存されたプレフィックスで検索できます。既存の名前は直接編集できません。置き換えると別のシークレットが作成されるため、クライアントを更新してから古いキーを無効化してください。

アカウントには最大20件のAPIキーを保持できます。無料プランでは3件までです。有効期限が切れた行も削除するまで件数に含まれます。

期待される結果

認証情報を見せることなく、名前とマスクされたフィンガープリントで行を識別できます。キーをローテーションまたは無効化する前に、使用しているクライアントを特定できます。

「APIキーにオーナーと用途がわかる名前を付ける」の参考画面。Get API KeyとView SDKsのリンクがあるdosya REST APIの概要ページ。
「APIキーにオーナーと用途がわかる名前を付ける」の参考画面。Get API KeyとView SDKsのリンクがあるdosya REST APIの概要ページ。 スクリーンショットを原寸で開く。

関連ガイド

この記事は役に立ちましたか?

評価の結果を読み込んでいます…

投票すると、回答を変更できるように、必要な投票用Cookieが最長180日間保存されます。

質問と回答

このガイドの手順について質問できます。質問は確認後に公開されます。

公開の質問には、アカウントの詳細、認証情報、非公開ファイルを含めないでください。これらについては 非公開サポート をご利用ください。

質問を読み込んでいます…

    dosyaアカウントにサインインすると、質問を投稿できます。

    やり直す前に結果を確認

    操作をもう一度確認する必要があるときは、次の共通の確認事項をご利用ください。