パーソナル アクセス キー

パーソナル アクセス キーは、ローカル開発ツールでの認証方法として推奨されています。パーソナル アクセス キーの働きはAPIキーと似ていますが、アカウント内の特定のユーザーに結び付けられています。パーソナル アクセス キーはローカル開発ツールでのみ動作します。

パーソナル アクセス キーと他の認証方式との比較

APIキーなどの実装と比較したパーソナル アクセス キーのメリットを考える場合、APIキーは実質的にスーパー管理者の権限が付与されています。パーソナル アクセス キーは、ポータル内の個々のユーザーの権限に限定されています。ユーザーにスーパー管理者の権限が付与されている場合は、機能的な違いは感じられません。しかし、個々の開発者をアカウントから削除することが必要になった場合、アカウント側でユーザーを無効にすると、該当するユーザーのローカル開発機能が無効になるという利点があります。

パーソナル アクセス キーはアカウント内の個々のユーザーに結び付けられているため、分かりやすく情報を表示できます。例えば、パーソナル アクセス キーを使用していて、開発者がローカル開発ツール経由でファイルを変更またはアップロードした場合、アプリ内の変更をこのユーザーに結び付けることができます。これにより、チームで作業しやすくなり、誰が何をしたかを容易に把握できるようになります。

パーソナル アクセス キーは、ユーザーと直接ではなく、特定のHubSpotアカウント内の個々のユーザーに結び付けられています。つまり、ローカル開発ツールを使用する際には、開発ツールを使用するアカウントごとに新しいパーソナル アクセス キーを生成する必要があります。これはアカウントのセキュリティーレイヤーとして機能し、仮に悪意のある人物がアクセスキーを入手しても、影響の範囲は特定のポータルの特定ユーザーに限定されます。

OAuth2との類似点

背後でパーソナル アクセス キーは、OAuth2のように機能します。パーソナル アクセス キーを生成する際には、そのキーに付与する権限を選択します。1つのHubSpotアカウントあたり、1ユーザーについて1つのアクセスキーのみ保持できます。アクセスキーを生成したら、「HubSpot Local Development Tools」(HubSpotローカル開発ツール)という名前のHubSpotアカウントにアプリが接続されます。このファーストパーティーHubSpotアプリは、パーソナル アクセス キーを使用する際のローカル開発ツールの認証に役立ちます。このアプリを切断すると、作成済みの全てのアクセスキーが即座に削除され、ローカル開発ツールはこのアクセスキーを使用して接続することができなくなります。新しいキーを生成して、hubspot.config.ymlファイルを更新することが必要になります。

personalcmsaccesskey

資格情報を保護する

パーソナル アクセス キーは、アカウントパスワードと同じように保護してください。他の人とは共有しないでください。入手した人物が本来のユーザーに成りすまして、自由に操作できてしまいます。

ローカル開発ツールでのパーソナル アクセス キーの使用

パーソナル アクセス キーは、ローカル開発ツールで使用することを意図して導入されました。

ローカル開発ツールの利用を開始する

パーソナルCMSアクセスキーを表示する。

ローカル開発ツールの認証に使用する場合のhubspot.config.ymlファイルの例を示します。

defaultPortal: production portals: - name: production portalId: <portalId> authType: personalaccesskey personalAccessKey: >- CJDVnLanLRICEQIYyLu8LyDh9E4opf1GMhkAxGuU5XN_O2O2QhX0khw7cwIkPkBRHye-OfIADgLBAAADAIADAAAAAAAAAAJCGQC8a5TlhtSU8T-2mVLxOBpxS18aM42oGKk auth: tokenInfo: accessToken: >- CJDVnLanLRICEQIYyLu8LyDh9E4opf1GMhkAxGuU5XN_O2O2QhX0khw7cwIkPkBRHye-OfIADgLBAAADAIADAAAAAAAAAAJCGQC8a5TlhtSU8T-2mVLxOBpxS18aM42oGKk expiresAt: '2020-01-01T00:00:00.000Z'

参考になりましたか?
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。