API: APIキーの概要とよくある質問

APIキーを作成できるのは誰ですか？

ドメインプロパティのAPIキー設定では、ドメイン内でAPIキーがサポートされるかどうか、およびサポートされる場合、誰が作成できるかを制御します。 APIキーが有効化されている場合、管理者は自身および他のユーザー向けにAPIキーを作成できます。 「APIキー作成の制限」 がfalseの場合、すべてのユーザーは自身のユーザーアカウントに対してAPIキーを作成できます。

APIキーの作成と管理

ご自身のユーザー向けにAPIキーを作成または管理するには、ページ上部のプロフィールボタンをクリックし、ユーザープロフィールを選択して、APIキータブをクリックしてください。 別のユーザー用のAPIキーを作成または管理するには、左側のナビゲーションパネルで［ホーム］をクリックし、対象ユーザーのドメインを選択した後、テーブル内で該当ユーザーを探してください。 詳細をクリックし、次にAPIキータブをクリックします。

1. APIキータブで、 [APIキーを作成 ]をクリックします。
2. キーの名前と 説明を入力します。
3. 有効期限ポリシーを選択し、「 追加」 を選択します。
4. 公開鍵に注意。 Show を選択すると秘密鍵が表示されます。 シークレットキーは、APIキーの作成時にのみ表示できます。 このキーは、プログラム認証の際に必要となります。 シークレットキーは安全な場所に保管してください。
5. 以下のオプションのいずれかを選択します：
   • 完了ユーザーページに戻り、後ほど環境へのAPIキーアクセスを許可してください。
   • アクセス権の付与: ユーザーが既にアクセス権を持つ環境の一覧から選択し、次に 「次へ」 をクリックします。 APIキーに対して1つ以上のロールを選択してください。 Nextを選択し、 Grant Accessを選択します。

1. API キータブで、次のいずれかのオプションを選択してください：
   • キーペアの表示: 公開鍵と有効期限を表示または非表示にします（このオプションはプロファイル表示でのみ利用可能です）。
   • アクセス権の付与: ユーザーが既にアクセス権を持つ環境の一覧から選択し、次に 「次へ」 をクリックします。 APIキーに対して1つ以上のロールを選択してください。 Nextを選択し、 Grant Accessを選択します。
   • 無効にする： キーを無効にする。
2. APIキーをクリックすると、そのAPIキーの詳細ペインが表示されます：
   • プロパティ - APIキーの名前、ローテーションポリシー、説明を表示します。 編集をクリックして、これらの値のいずれかを変更します。
   • キーペア - APIキーに関連付けられたキーペアとその有効期限を表示します。 キーペアを追加するには、＋をクリックします。キーペアを削除するには、行の先頭にあるチェックボックスを選択し、削除をクリックします。
   • アクセス - APIキーに関連付けられた環境アクセスを表示し、アクセス権の変更および取り消しオプションを提供します。

スクリプトやプログラムでAPIキーを使用するには、以下のトピックを参照してください：

• APIキーによる認証
• cURL 例

APIキーFAQ

これはドメインのプロパティで設定可能です。

これはドメインのプロパティで設定可能です。

APIキーが利用可能な環境と役割はどのようなものですか？

APIキーには、親ユーザーがユーザードメイン内の任意の環境に対して持つ環境およびロールへのアクセス権が付与される場合があります。 セキュリティ上の理由により、APIキーは親ユーザーのドメインに属さない環境へのアクセス権を付与できません。

1つのユーザー（親ユーザー）アカウントに対して複数のAPIキーを作成することができ、各APIキーは2つのキー・ペアを持つことができます。 すでに有効期限が切れていたり、明示的に無効化または削除されていない限り、すべての鍵は有効である。 これらの機能により、同じAPIキーの新しいキー・ペアを使用して、中断することなくスクリプトを更新したり、その他の定期的なタスクを実行したりすることができる。 スクリプトを更新した後、未使用および期限切れのキー・ペアを削除できる。

はい。

はい、APIキーはすべての監査レポートに含まれています。

セッションの暗号化にはどのようなパラメータが使われますか？

https TLS1.2AES256