Bulk Job API
Bulk jobs are a fast
and efficient way to update existing agent and supervisor usernames to SSO usernames.
You can use the Bulk
Job API to return a CSV template with records for agents and supervisors who are not enabled for SSO.
You can also use the Bulk
Job API to list the bulk jobs currently defined in the database, define new
bulk jobs, and view or delete records of existing bulk jobs.
Creates one bulk job.
Permanently deletes one bulk job.
Returns one bulk job using the URL
Returns the ssomigration CSV template as a file attachment. The template includes the first 12,000 agent and supervisor accounts that are not enabled for SSO. The form of the request is
If the database contains more than 12,000 non-SSO users, get the first 12,000 and update their credentials for SSO. Then get the next 12,000 users and update their credentials for SSO. Repeat until there are no more agents to migrate.
Non-SSO users can be filtered by peripheralId, agentTeamId, or both.
To filter by peripheralId, use the following URL: https://<server>/unifiedconfig/config/bulkjob/templates/ ssomigration?q=peripheralId:<peripheralId>.
To filter by agentTeamId, use the following URL: https://<server>/unifiedconfig/config/bulkjob/templates/ ssomigration?q=agentTeamId:<agentTeamId>.
To filter by both peripheralId and agentTeamId, use the following URL: https://<server>/unifiedconfig/config/bulkjob/templates/ ssomigration?q=peripheralId:<peripheralId> agentTeamId:<agentTeamId>.
Retrieves a list of bulk jobs.
refURL of the bulk job. See
The content of the bulk CSV file. The size of the file must not exceed 3MB.
createDateTime: The time the bulk job was submitted. It
indicates the time in milliseconds elapsed from the zero epoch value of January
1, 1970, 00:00:00 GMT. Read-only.
The Windows computer name of the AW that initiated the bulk job.
The time the bulk job began executing. Read-only.
The time the bulk job completed or failed. Read-only.
current state of the job. Read-only.
job type. Optional. If this parameter is not provided, the value is determined automatically based on the header in the bulk job file. If the parameter is provided, the header must match the job type specified.
The only valid value is 5, for SSO Migration.
logFile: A URL
to download the log file for the bulk job. Read-only.
csvFile: A URL
to download the CSV file that was originally uploaded in the fileContent
table shows the parameters that are searched and the parameters that are
for a SSO migration create job that completed successfully:
<description>sso migration bulk job</description>