ADFederationService.Enabled property

The Enabled property specifies or retrieves a Boolean value that indicates whether Active Directory Federation Services (ADFS) trust is enabled.

Syntax

ADFederationService.Enabled

Property value

This property is read/write.

Remarks

Before a federated user can access rights-protected content, the ADFS service must be installed and enabled, and a rights account certificate must be issued. A rights account certificate (RAC) binds a computer to an end-user license. The AD RMS service issues a RAC when the Enabled property is set to True. For related information, see IsSupported and RightsAccountCertificateRequestUrl.

If the IsSupported property value is false, the Enabled property throws an exception.

The ADFS service must be enabled before any of the following properties can be set or retrieved:

• IsProxyEmailAddressesAllowed
• RightsAccountCertificateRequestUrl
• ValidityPeriodInDays

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

' *******************************************************************
' Specify ADFS information.

SUB SetADFS()
    
  DIM objADFS

  SET objADFS = _
    config_manager.Enterprise.TrustPolicy.ADFederationService
  CheckError()
        
  IF objADFS.IsSupported = TRUE THEN
    objADFS.Enabled = true
    CheckError()

    objADFS.ValidityPeriodInDays = 10
    CheckError()

    objADFS.RightsAccountCertificateRequestUrl = _
        "https://www.example.com"
    CheckError()

    objADFS.IsProxyEmailAddressesAllowed = TRUE
    CheckError()
  END IF

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

See also

ADFederationService