identity

Get Bulk User Job

Fetch status/progress of a bulk user action job. Admin only.

get/api/identity/{team_key}/users/bulk-jobs/{job_key}

Request

  • Base URL
    https://api.superit.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

team_keystring required
job_keystring required

Response

Successful Response

jobKeystring required
action'export_users' | 'export_invite_links' | 'link_m365' | 'link_psa' | 'delete' | 'password_reset' | 'send_invite' | 'add_tags' | 'remove_tags' | 'psa_import' | 'change_role' required

Actions that can run as a bulk job against selected users.

statusstring required
totalItemsinteger required
processedItemsinteger required
successCountinteger required
skipCountinteger required
errorCountinteger required
progressPercentinteger required
isFinishedboolean required
errorMessagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.