Active Directory Provider::Verify UPN

  • Article

Verifies that the user principal name (UPN) has a valid UPN suffix (any characters after the "@" character) and returns an error if it does not. More precisely, this procedure verifies that the suffix of the given UPN is in the given list of UPN suffixes. Used by Microsoft Provisioning Framework (MPF).

Arguments

The following table describes the XML schema elements and attributes. Unless otherwise indicated, the data type is string.

Element Description, relationships, and attributes

executeData

Description:
Encapsulates the procedure's input and output data.

Children:
uPNSuffixes (minOccurs="1" maxOccurs="1")
userPrincipalName (minOccurs="1" maxOccurs="1")

uPNSuffixes

Description:
Set of valid UPN suffixes, represented as value child nodes.

Parent:
executeData

Children:
value (minOccurs="1" maxOccurs="*")

userPrincipalName

Description:
UPN to verify. UPN is an attribute of the Microsoft Active Directory User Account object.

Parent:
executeData

value

Description:
Valid UPN suffix.

Parent:
uPNSuffixes

Remarks

This action does not use an Active Directory domain controller or any other server. It only searches for an "@" character in the userPrincipalName and verifies that the string after that character matches one of the uPNSuffixes. The following example would succeed because the suffix of the UPN, "tailspintoys.com", is in the list of valid UPN suffixes.

<executeData> 
  <userPrincipalName>user1@domain.com</userPrincipalName> 
  <uPNSuffixes> 
     <value>domain.com</value> 
     <value>domain.net</value> 
  <uPNSuffixes> 
</executeData>

Schema Definition

Input

<executeData>1..1
  <userPrincipalName>1..1</userPrincipalName>
  <uPNSuffixes>1..1
    <value>1..unbounded</value>
  </uPNSUffixes>
</executeData>

Sample Code

Example XML Request

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

Example XML Response

Verify UPN does not return data.

Applies To

Active Directory Provider for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0