SCIM と Quip を連携する方法

この記事では、SCIM インテグレーションと Quip に関する次の情報を説明します。

• 背景
• SCIM の API アクセスの認証
• アカウントの作成、削除、編集
• API コールのテスト

背景

ドキュメントによれば、System for Cross-domain Identity Management (SCIM) 仕様は、クラウドベースのアプリケーションやサービスでユーザー ID の管理を容易にするように設計されています。SCIM を Quip サイトに統合すると、ID サービス (Active Directory や OneLogin など) で従業員のアクセスを変更でき、その変更が従業員の Quip アカウントに反映されます。

具体的には、次のプロセスを自動化できます。

1. アカウント作成:ID プロバイダーを通じて新しい従業員の企業認証情報を作成すると、その従業員の新しい Quip アカウントが作成されます。
2. アカウントの無効化:ID プロバイダーを通じて従業員の企業認証情報を無効にすると、その従業員の Quip アカウントも自動的に無効になります。

完全な SCIM ドキュメントはこちらから入手できます。
 

API アクセスの認証

認証トークンは Quip Enterprise のお客様のみがご利用いただけます。

認証トークンを取得するには以下にアクセスしてください。
{yourcompany}.quip.com/business/admin/scim
必ず {yourcompany} を Quip サイトの実際のサブドメインに置き換えてください。

注意:

• SCIM API へのすべてのリクエストには、Authorization ヘッダーとしてトークンを含める必要があります。
• このページにアクセスできるのは、会社の Quip サイトの管理者だけです。

アカウントの作成、削除、編集

アカウントの作成

ID サービスで新しい従業員の認証情報を作成するときに、Quip API を使用してそのユーザーの新しい Quip アカウントを自動的に設定できます。

scim.quip.com/Users に POST コールを行い、ユーザーを説明する JSON ディクショナリを送信します。その従業員の新しい一意の Quip ユーザー ID を含む JSON が Quip から返されます。

コールの例:

 

ユーザー ID の取得

各 Quip アカウントのユーザー ID は、API 経由でアカウントアクションをトリガーするための主キー属性です。したがって、実際にこれらのアクションを実行する前にはまず、API を呼び出して、関連付けられているユーザー ID とメールアドレスと共に、既存のすべての Quip アカウントのリストを取得する必要があります。

これを行うには、適切な属性パラメーターを使用して scim.quip.com/Users に GET コールを実行します。これにより、Quip インスタンス内のすべてのユーザーと共に、メールアドレスとユーザー ID (他のシステムと Quip 間のリンクになります) が返されます。

コールの例:


応答の例:


これで各ユーザーに Quip ユーザー ID が関連付けられるため、そのユーザーのアカウントに対して追加のコールを行うことができます。
 

メールアドレスによるユーザー ID の取得

フィルターを使用して、返されるユーザーを制限できます。たとえば、「emails」フィールドの「eq」フィルターは、そのメールアドレスを持つユーザー (存在する場合) のみを返します。

コールの例:

 

ユーザー名またはメールアドレスの更新

ユーザー名またはメールアドレスを更新するには、新しい名前とメールアドレスを以下への PUT で発行します。
scim.quip.com/User/{ユーザーの Quip ID]
ここで、{ユーザーの Quip ID} はもちろんユーザーの実際の ID です。

コールの例:

 

アカウントの無効化

ユーザーの Quip アカウントを無効化するには、以下に対する DELETE コールを実行します。
scim.quip.com/Users/{ユーザーの Quip ID}
ここで、{ユーザーの Quip ID} はもちろんユーザーの実際の ID です。

コールの例:


注意:「DELETE」コールではユーザーの Quip アカウントは削除されず、無効化されるだけです。ユーザーは Quip へのすべてのアクセス権を失い、ログインできなくなりますが、データが削除されたり失われたりすることはなく、他のユーザーと共有したコンテンツは引き続きそれらのユーザーと共有されます。
 

無効化されているアカウントの再有効化

以前に無効化したアカウントを再有効化するには、以下への PUT でアクティブフラグを「True」に設定します。
scim.quip.com/User/{ユーザーの Quip ID]
ここで、{ユーザーの Quip ID} はもちろんユーザーの実際の ID です。

コールの例:

 

アクティブユーザーセッションの無効化

上述の手順に従ってアカウントを無効化し、すぐに再有効化することで、これを実現できます。

 

API コールのテスト

SCIM 経由でアカウントの変更を自動化する前に、Quip インスタンス内 (サンドボックス環境ではなく) のダミーユーザーでこれらのコールをテストすることをお勧めします。手順は次のとおりです。

1. 一意のメールアドレスを含むテストユーザーを ID 管理システムに作成します。
2. scim.quip.com/Users に POST コールを実行して、その従業員に固有の新しい Quip ユーザー ID を受け取ります。
3. 新しく作成されたアカウントがアクティブであることが確認されたら、scim.quip.com/Users/[QuipUserID] に対して DELETE コールを実行し、その従業員の Quip アカウントを無効化します。