IPWorks Auth 2020 Python Edition

Questions / Feedback?

auth_mode Property

The authentication mode.

Syntax

def get_auth_mode() -> int: ...
def set_auth_mode(value: int) -> None: ...

auth_mode = property(get_auth_mode, set_auth_mode)

Default Value

0

Remarks

This property specifies the authentication mode. Possible values are:

0 (camSharePointOnline - default) Microsoft SharePoint Online
1 (camDynamicsCRM) Microsoft Dynamics CRM
2 (camADFS) Active Directory Federation Services
3 (camCustom) Custom

When this property is set the component is initialized based on common settings for the selected mode.

Setting this property to 2 (camADFS) or 3 (camCustom) will clear the values in federation_urn, and federation_sts. There is no functional difference between 2 (camADFS) and 3 (camCustom), they operate identically.

Setting this property to 0 (camSharePointOnline) or 1 (camDynamicsCRM) will populate federation_urn, and federation_sts with known valid values for federation_urn, and federation_sts.

The table below shows which properties are set depending on the value of this property.

auth_modefederation_urnfederation_stsUserRealm
camSharePointOnlineurn:federation:MicrosoftOnline"https://login.microsoftonline.com/RST2.srf""https://login.microsoftonline.com/GetUserRealm.srf"
camDynamicsCRMurn:federation:MicrosoftOnline"https://login.microsoftonline.com/RST2.srf""https://login.microsoftonline.com/GetUserRealm.srf"
camADFS""""""
camCustom""""""

The value 3 (camCustom) may be used with any STS as long as WS-TRUST is supported.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 Python Edition - Version 20.0 [Build 8155]