Skip to main content
POST
Deactivate or delete an identity-provider directory user

承認

Authorization
string
header
必須

For authenticated requests, set the Authorization: Bearer your_api_key parameter in the header.
You can create and manage your API Keys by visiting the API Keys tab in the Settings page of your organization in Assist SaaS Manager

パスパラメータ

organizationId
number
必須
workspaceId
number
必須

ボディ

application/json
uniqueKey
string
必須

Unique key of the aggregated identity-provider directory account to deprovision.

例:

"user@example.com"

mode
enum<string>
必須

Deprovision mode. 'deactivate' blocks sign-in but retains the account and its app assignments; 'delete' removes the directory user and every app assignment it grants.

利用可能なオプション:
deactivate,
delete
例:

"deactivate"

unassignApps
boolean
デフォルト:false

Only meaningful with mode 'deactivate': when true, also unassigns the user from every IdP-managed app they are assigned to (one unassignment per app). Ignored for 'delete', which already removes all assignments by deleting the directory user.

workflowRunId
string

Optional workflow run id for automation correlation.

レスポンス

requestId
string
必須
read-only
例:

"1"

最終更新日 2026年10月7日