Contents

ヌーラボアカウントAPI とは

ヌーラボアカウントAPIとはなんですか？

ヌーラボアカウントAPIは、ユーザープロビジョニングを行うためのSCIM APIです。SCIM 2.0に準拠しています。SCIM（System for Cross-domain Identity Management）は、異なるドメイン間でユーザーID情報のやり取りを自動化するための標準規格です。

ヌーラボアカウントAPIで何が出来ますか？

ヌーラボアカウントAPIでは以下が行えます。

  • 組織に所属するアカウント情報の取得
  • 管理対象アカウントの追加・更新・削除

詳細については各APIを参照してください。

ヌーラボアカウントAPIを利用できる組織

以下の条件を満たした組織の管理者がヌーラボアカウントAPIを利用できます。

  • Nulab Passを契約している
  • ユーザープロビジョニングを有効にしている

ヌーラボアカウントAPIで操作可能なアカウント

アカウント一覧の取得とアカウント情報の取得は、組織のすべてのアカウントに対して可能です。

アカウントの更新とアカウントの削除は、アップデートした管理対象アカウント、または2023年1月16日以降に作成した管理対象アカウントに対して可能です。管理対象ではないアカウントやアップデートが必要な管理対象アカウントに対してはできません。

ヌーラボアカウントAPIによるアカウントの追加・更新・削除

基本的な仕様や注意事項は管理対象アカウントの作成・編集・削除と同様です。

アカウントの追加をすると新しい管理対象アカウントが作成されます。 ヌーラボアカウントAPIで追加・更新されたアカウントは「プロビジョニングされた管理対象アカウント」と表示されます。

URL

ヌーラボアカウントAPIを利用するには、組織ごとに発行されるSCIM URLにアクセスしてください。

SCIM URLは組織設定のユーザープロビジョニングで確認できます。

https://api.apps.nulab.com/spaces/{YOUR_SPACE_KEY}/scim/v2/

例）https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/

リクエストヘッダー

Content-Typeヘッダーに “application/scim+json” を指定してください。

Content-Type: application/scim+json

認証

API Key方式で認証します。詳しくは認証と認可を参照してください。

監査ログ

ヌーラボアカウントAPIで行った管理対象アカウントの追加・更新・削除の操作は監査ログに出力されます。その際にoperation_user_nameが「User provisioning」となります。