ITSM Endpoint - End User Provisioning

⚙️ Setup Guides
1

This article provides a deeper dive into the behaviours of the the ITSM endpoint for provisioning endusers.

POST - https://{your-zpm-url}/services/microsoft/automate-itsm/end-user-provisionings/v2

JSON Requirements

  • The userPrincipalName is the only required field, every other field is optional. Below is the complete list of possible attributes:
{
  "userPrincipalName": "string", // *required
  "dialPlanGroupId": "string"
  "lineUri": "string",
  "lineUriExtension": "string",
  "onlineVoiceRoutingPolicy": "string",
  "tenantDialPlan": "string",
  "emergencyCallingPolicy": "string",
  "emergencyCallRoutingPolicy": "string",
  "callingPolicy": "string",
  "ipPhonePolicy": "string",
  "teamsCallHoldPolicy": "string",
  "teamsCallParkPolicy": "string",
  "onlineVoicemailPolicy": "string",
  "callingLineIdentity": "string",
  "sharedCallRoutingPolicy": "string"
  "audioConferenceNumber": "string"
  "memberOfGroups": ["string"]
}

API Behaviours

When lineUri and optional lineUriExtension are provided:

  • lineURI cannot be provided at the same time as dialPlanGroupId
  • providing optional lineUriExtension requires lineUri of main number to be provided.
  • Looks up the associated dial plan. If no dial plan is found, an error is thrown, and the operation is aborted.
  • Assigns the number
  • Assigns the default voice policies that are linked to the dial plan.
  • Assign the default emergency location tied to the dial plan

When dialPlanGroupId is provided:

  • lineURI cannot be provided at the same time as dialPlanGroupId
  • Assigns the next available number from the dial plan to the user.
  • Priority given to numbers that have not been recently deleted
  • Automatically assigns default voice policies associated with the dial plan group.
  • Assign the default emergency location tied to the dial plan

When an optional voice policy is provided

  • If voice policies are provided along with a dialPlanGroupId or lineUri, the default value from the dial plan will be overridden by the specified voice policy.
  • If a voice policy is provided without a lineUri or dialPlanGroupId, only the provided voice policies change; the user preserves any other voice policies they previously had.

When audioConferenceNumber is provided

  • Sets the provided number as the Audio Conferencing dial-in number.

When memberOfGroups are provided

  • Expects the GUID/UUID value of a security group
  • Only cloud defined groups are supported
  • Adds user as a member of the provided groups
  • Note: An empty list or null of groups does not modify group membership.

Response

On a successful operation, a 200 response will be provided with the assigned phone number and extension:

BulkProvisioningUserDetailsJson {
"userPrincipalName" : "string"
"lineUri" : "string"
"lineUriExtension":	"string"
}
1 Like