OnlineTrustedServiceExcludedUserCollection object

Article
05/31/2018

The OnlineTrustedServiceExcludedUserCollection object contains a collection of users excluded from the Windows Live ID user domain. Each user is identified by a string value in the form user@example.com. You can retrieve this object by calling the ExcludedUsers property on the OnlineTrustedServiceUserDomain object.

Members

The OnlineTrustedServiceExcludedUserCollection object has these types of members:

Methods
Properties

Methods

The OnlineTrustedServiceExcludedUserCollection object has these methods.

Method	Description
Add	Adds an object to the collection (inherited from IList).
Clear	Removes all objects from the collection (inherited from IList).
Contains	Determines whether the collection contains a specific object (inherited from IList).
CopyTo	Copies the collection elements to an array, starting at a specified index (inherited from ICollection).
IndexOf	Retrieves the index of a specific object in the collection (inherited from IList).
Insert	Inserts an object in the collection at the specified index (inherited from IList).
Remove	Removes the first occurrence of the specified object from the collection (inherited from IList).
RemoveAt	Removes the object at the specified index from the collection (inherited from IList).
Update	Updates the collection on the server.

Properties

The OnlineTrustedServiceExcludedUserCollection object has these properties.

Property	Description
Count	Retrieves the number of objects contained in the collection (inherited from ICollection).
Item	Specifies or retrieves the object at the specified index (inherited from IList).

Remarks

To exclude all users in a domain, add only the domain name, in the form DomainName.com, to the collection. That is, do not include the user name.

Examples

DIM config_manager
DIM admin_role

' *******************************************************************
' Create and initialize a ConfigurationManager object.

SUB InitObject()

  CALL WScript.Echo( "Create ConfigurationManager object...")
  SET config_manager = CreateObject _
    ("Microsoft.RightsManagementServices.Admin.ConfigurationManager")      
  CheckError()
    
  CALL WScript.Echo( "Initialize...")
  admin_role=config_manager.Initialize(false,"localhost",80,"","","")
  CheckError()

END SUB

' *******************************************************************
' Retrieve Windows Live ID user domain information.

SUB GetLiveIdInfo()

  DIM trustPolicy
  DIM LiveIdDomain

  ' Retrieve the trust policy object. 
  SET trustPolicy = config_manager.Enterprise.TrustPolicy
  CheckError()

  ' Retrieve the Windows Live ID user domain object.
  SET LiveIdDomain = trustPolicy.OnlineTrustedServiceUserDomain
  CheckError()

  ' Enable Windows Live ID user domains.
  LiveIdDomain.Enabled = TRUE
  CheckError()

  IF IsNull(LiveIdDomain.Id) OR LEN(LiveIdDomain.Id) = 0 THEN
    CALL RaiseError(-601, "Enable Live ID user domain failed.")
  END IF
  CALL WScript.Echo("OnlineTrustedServiceUserDomain.Enabled: Id = " _
                    & LiveIdDomain.Id _
                    & " Certification Name = " _
                    & LiveIdDomain.CertificationName _
                    & " Certificate Expiration = " _
                    & LiveIdDomain.CertificateExpirationTime)

  ' Add excluded users to the domain.
  LiveIdDomain.ExcludedUsers.Clear()
  LiveIdDomain.ExcludedUsers.Add("LiveId1@example.com")
  LiveIdDomain.ExcludedUsers.Add("LiveId2@example.com")
  LiveIdDomain.ExcludedUsers.Update()
  CheckError()
  CALL WScript.Echo("LiveIdUserDomain: excluded count=" & _
                    LiveIdDomain.ExcludedUsers.Count)
 
END SUB

' *******************************************************************
' Error checking function.

FUNCTION CheckError()
  CheckError = Err.number
  IF Err.number <> 0 THEN
    CALL WScript.Echo( vbTab & "*****Error Number: " _
                       & Err.number _
                       & " Desc:" _
                       & Err.Description _
                       & "*****")
    WScript.StdErr.Write(Err.Description)
    WScript.Quit( Err.number )
  END IF
END FUNCTION

' *******************************************************************
' Generate a runtime error.

SUB RaiseError(errId, desc)
  CALL Err.Raise( errId, "", desc )
  CheckError()
END SUB

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008
Assembly	Microsoft.RightsManagementServices.Admin.dll

Share via