AmplitudeでSCIMプロビジョニングを設定する

Amplitudeのユーザー管理APIは、パブリックAPIを通じてプロビジョニングとグループ管理のためのプログラムソリューションを提供します。この API を使用して大規模な組織を管理したり、プロビジョニングを ID プロバイダーなどの他のツールと統合したりできます。

ユーザー管理 API は SCIM 2.0 標準に準拠しています。ユーザー、保留中のユーザー、および権限グループに対する作成、取得、更新、および削除の各API呼び出しをサポートしています。

SCIM API のテクニカルガイドと仕様については、SCIM API ガイドを参照してください。このガイドは、開発者が SCIM API をテストしたり、Amplitude SCIM API を呼び出すスクリプトを開発したり、単発リクエストを作成したりするのに役立ちます。

始める前に

User Management APIは、権限グループと連携して機能します。

SCIM プロビジョニングを使用して ID プロバイダーまたは SSO ソリューションとの統合を計画している場合は、そのツール内でも SCIM が有効になっていることを確認してください。

AmplitudeでSCIMプロビジョニングを有効にする

組織にSCIMプロビジョニングが含まれている場合、組織の設定メニューの_アクセスとSSO設定_セクションにある_プロビジョニング設定_にあります。

_SCIMプロビジョニングを有効にする_トグルを_有効_に設定します。次に、「SCIM キーを生成」をクリックして、SCIM API へのリクエストを認証するために使用されるアクセストークンを生成します。

セキュリティ上の理由から、Amplitudeは有効にした場合にのみSCIMキーを表示します。キーにアクセスできなくなった場合は、[SCIM キーを再生成] をクリックします。新しいキーを記録しておいてください。 SCIMキーを生成または再生成すると、変更はすぐに適用され、Amplitudeはページ上の他の変更が保存されていない場合でも、すべてのAPI呼び出しで古いキーを拒否します。

サポートされているフィールド

Amplitudeは、SCIMコアグループスキーマのすべてのフィールドと、コアユーザースキーマの以下のフィールドをサポートしています。


SCIMユーザー属性	特別な注意事項
`userName`	`email`と同じです。
`givenName`	表示名を作成するために`familyName`の先頭に追加されます。
`familyName`	表示名を作成するために`givenName`の末尾に追加されます。
`email`	1つの電子メールのみが許可されます。
`active`	`active`は招待されたユーザーと参加したユーザーに当てはまります。

Okta を使用して SCIM アプリケーションを設定

Oktaでは、Amplitude SCIM APIが以下の機能を提供します。

ユーザー/グループのインポート：Amplitude組織内のユーザーとグループにアクセスし、Okta内で新規ユーザーを追加したり既存ユーザーを更新したりします。
新規ユーザーの作成：ユーザーまたはグループをアプリケーションに割り当てると、Amplitudeはユーザーを組織に招待し、サインアップを完了させるための招待メールを送信します。
ユーザー属性の更新：OktaからAmplitudeへのプロファイルの同期を維持するために使用されます。
ユーザーの無効化：Oktaアプリケーションからユーザー割り当てを削除すると、AmplitudeはAmplitude組織からユーザーを削除します。
プッシュグループ：Amplitudeで新しいグループを作成し、それらをAmplitude内のグループにリンクします。

Oktaの連携

OktaプロビジョニングをAmplitudeと連携する最良の方法は、Okta連携ネットワーク内にあるAmplitudeアプリケーションを使用することです。Oktaプロビジョニングを統合するには：

Okta連携カタログで、_アプリケーション_に移動し、Amplitudeアプリケーションを見つけます。連携を作成するには、Amplitudeの_一般設定_セクションで利用可能な組織IDを使用してください。
連携を作成した後、Amplitudeへのプロビジョニングコールを設定して認証します。_プロビジョニング_タブに移動し、_API連携の設定_をクリックします。
APIトークンを入力します。このトークンは、Amplitudeが提供するSCIMキーと同じです。フィールドにトークンを入力し、保存_をクリックします。これで、アプリケーションの「インポート」_、「割り当て」、「プッシュグループ」タブでユーザープロビジョニングアクションにアクセスできるようになります。
Okta が接続を検証した後、Okta が Amplitude に送信できるプロビジョニングアクションを選択します。 _プロビジョニング_タブの_To App（アプリケーション先）_セクションで、ニーズに合う任意の機能をチェックしてください。可能な限り利用可能なすべての機能を選択することで、AmplitudeのユーザーレコードがOktaディレクトリと密接に一致するようになります。

手動設定 (SAML)

ご使用の SSO で SAML サポートが必要な場合は、「Okta を使用して Amplitude のシングルサインオン（SSO）を設定する」で説明されている手動設定を使用してください。

トラブルシューティング

Amplitudeはユーザーに対し、Amplitudeでの初回サインアップ時に姓と名の提供を求めていますが、ユーザーは初回サインアップ前に組織への参加招待を受け取ることがあります。保留中のユーザーがいずれのAmplitude組織にも所属していない状態でユーザーのインポートを使用する場合、SCIM APIはそのユーザーの名と姓にプレースホルダ値NO_GIVEN_NAMEおよびNO_FAMILY_NAMEを使用します。

認証の問題は、ID プロバイダーのアプリケーションと Amplitude の SCIM API との間で発生することがあります。たとえば、これはOkta内でSCIM接続をテストする場合に発生することがあります。SCIM認証のトラブルシューティングを行うには:

_アクセスとSSO設定_タブで、SCIMを有効にしてください。SCIMを有効にする場合は、設定を保存してください。
_SCIMキーを再生成_をクリックし、キーの再生成を確認します。これにより、古いキーはすぐに無効になります。
新しいキー値をコピーし、設定を再テストしてください。プロバイダーとの連携以外で独自のリクエストを作成するには、SCIM API ガイドを参照してください。

これは役に立ちましたか？