Provisioning task endpoints
GetProvisioningTaskCount
GetProvisioningTaskCount(System.String)
Gets the number of provisioning tasks in the organization.
Parameter
Param: organization: Account
Returns
Number of provisioning tasks in the account
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
GetProvisioningTaskDetails
GetProvisioningTaskDetails(System.Int32,System.String)
Gets detailed information on a specific provisioning task.
Parameters
Param: taskID: Task to get details for
Param: organization: Account
Returns
A table with the following columns:
-
userid
-
username
-
startdate
-
stopdate
-
status
-
serialnumber
-
description
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
GetProvisioningTasks
GetProvisioningTasks(System.String,System.Int32,System.Int32)
Gets a list of all provisioning tasks in the organization.
Parameters
Param: organization: Account
Param: startRecord: First record
Param: numberOfRecords: Number of records
Returns
A table with the following columns:
taskid | |
operator | |
startdate | (Disregard the values in this column. Use GetProvisioningTaskDetails for accurate start dates.) |
count | |
tokenoption | |
stopdate | (Disregard the values in this column. Use GetProvisioningTaskDetails for accurate stop dates.) |
Note
GetProvisioningTasks does not return proper start/stop dates. These dates are available using GetProvisioningTaskDetails.
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
GetProvisioningTasksForUser
GetProvisioningTasksForUser(System.String,System.String,System.Int32,System.Int32)
Gets a list of all provisioning tasks in the organization.
Parameters
Param: user: The user to get provisioning tasks for
Param: organization: Account
Param: startRecord: First record
Param: numberOfRecords: Number of records
Returns
A table with the following columns:
-
taskid
-
operator
-
startdate
-
count
-
tokenoption
-
stopdate
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
GetProvisioningTasksForUserCount
GetProvisioningTasksForUserCount(System.String,System.String)
Gets the number of provisioning tasks in the organization.
Parameters
Param: user: User to get task count for
Param: organization: Account
Returns
Number of provisioning tasks for the user
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
RemoveProvisioningTask
RemoveProvisioningTask(System.Int32,System.Boolean,System.String)
Removes an existing provisioning task, optionally sending a notification e-mail to all the users that this affects.
Parameters
Param: taskID: Task ID to remove
Param: sendNotificationEmail: True to send a notification e-mail
Param: organization: Account
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
RemoveUsersFromProvisioningTask
RemoveUsersFromProvisioningTask(System.Int32,System.Collections.Generic.List{System.String},System.Boolean,System.String)
Removes specific users from a given provisioning task, optionally sending a notification e-mail to them.
Parameters
Param: taskID: Task ID to remove users from
Param: userNames: List of user names to remove
Param: sendNotificationEmail: True to send a notification e-mail
Param: organization: Account
Returns
- True if users are removed
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
UpdateProvisioningStopDate
UpdateProvisioningStopDate(System.Int32,System.Collections.Generic.List{System.String},System.DateTime,System.String)
Updates the expiry date of a provisioning task for the given users. Used to extent a provisioning task that users may not have had the time to complete.
Parameters
Param: taskID: Task ID to update
Param: userNames: List of user names to update the expiry date for
Param: newStopDate: The new expiry date
Param: organization: Account
Returns
- True if the expiry dates were updated
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response: