チームのユーザー アカウントの削除を自動化する

チームのユーザー アカウントが Google Workspace 組織により管理されている場合は、API を使用してチームのユーザー アカウントの削除を自動化しないでください。組織のユーザーによる AppSheet へのアクセスを制御するには、ユーザー向けに AppSheet を有効または無効にするをご覧ください。

 

アプリが 1 つ以上の AppSheet データベースに接続されている場合、チームメンバー間でデータベースを移行するで説明のとおり、アプリエディタを使用して、データベースを新しいオーナーに移行する必要があります。このステップは、この時点では API を使用して自動化できません。

ユーザーが組織を離れた場合は、移行のセクションで説明のとおり、AppSheet API を使用してそのユーザーのユーザー アカウントの削除を自動化し、アプリの所有権を移行して、ユーザー アカウントを削除できます。

注:

• チームは、Enterprise プランのアカウントでのみ使用できます。
• API を使用して、参照先のユーザー アカウントと同じチームに所属するには、チームルート権限または管理者権限が必要です。

アプリの所有権を移行する

チーム内のあるユーザー アカウントが所有するすべてのアプリの所有権を別のユーザー アカウントに移行するには、以下の API に対して POST リクエストを発行します。

https://{appsheet-region}/api/v2/admin/apps/transferall?oldOwnerId={id}&newOwnerId={id}

各要素の意味は次のとおりです。

変数	説明
{appsheet-region}	サポートされるデータ所在地のリージョンに基づいて API を呼び出すために使用されるドメイン。有効な値は次のとおりです。 グローバル: www.appsheet.com EU: eu.appsheet.com 注: api.appsheet.com ドメインはまだサポートされていますが、非推奨となりました。

クエリ パラメータ

以下をクエリ パラメータとして渡す必要があります。

クエリ パラメータ	説明
oldOwnerId	現在のオーナーのユーザー アカウント ID。
newOwnerId	すべてのアプリの割り当て先となるユーザー アカウント ID。 注: ユーザーは、同じチームのメンバーである必要があります。

ヘッダー

API を使用してチームを管理、モニタリングするで説明のとおり、AccessKey ヘッダーと UserId ヘッダーを渡す必要があります。

例

次に例を示します。

curl https://{appsheet-region}/api/v2/admin/apps/transferall?oldOwnerId=14853665&newOwnerId=14853667 \
  -X POST \
  -H "AccessKey: DcTx1-TFq3c-7ka6t-PcnnI-7d0dO-M4wTm-vWwx0-1KBte" \
  -H "UserId: 1234567"

成功すると、API 呼び出しにより、200 OK という応答が返されます。

ユーザー アカウントを削除する

注: ユーザー アカウントを削除すると、アカウントは復旧できなくなります。このアカウントが所有するアプリを削除したくない場合は、アカウントを削除する前にそれらを移行してください。

ユーザー アカウントを削除するには、以下の API に対して POST リクエストを発行します。

https://{appsheet-region}/api/v2/admin/users/delete?userId={id}

各要素の意味は次のとおりです。

変数	説明
{appsheet-region}	サポートされるデータ所在地のリージョンに基づいて API を呼び出すために使用されるドメイン。有効な値は次のとおりです。 グローバル: www.appsheet.com EU: eu.appsheet.com 注: api.appsheet.com ドメインはまだサポートされていますが、非推奨となりました。

クエリ パラメータ

以下をクエリ パラメータとして渡す必要があります。

クエリ パラメータ	説明
userId	削除したいユーザー アカウント ID。

ヘッダー

API を使用してチームを管理、モニタリングするで説明のとおり、AccessKey ヘッダーと UserId ヘッダーを渡す必要があります。

例

次に例を示します。

curl https://{appsheet-region}/api/v2/admin/users/delete?userId=14853665 \
  -X POST \
  -H "AccessKey: DcTx1-TFq3c-7ka6t-PcnnI-7d0dO-M4wTm-vWwx0-1KBte"
  -H "UserId: 1234567"

成功すると、API 呼び出しにより、200 OK という応答が返されます。