Skip to content

DirectoryConfig

Source code in docs_src/capo_appstream/types/directory_config.py
class DirectoryConfig(TypedDict, closed=True):
    directory_name: NotRequired["capo_appstream.types.directory_name.DirectoryName"]
    """<p>The fully qualified name of the directory (for example, corp.example.com).</p>"""
    organizational_unit_distinguished_names: NotRequired[
        "capo_appstream.types.organizational_unit_distinguished_names_list.OrganizationalUnitDistinguishedNamesList"
    ]
    """<p>The distinguished names of the organizational units for computer accounts.</p>"""
    service_account_credentials: NotRequired[
        "capo_appstream.types.service_account_credentials.ServiceAccountCredentials"
    ]
    """<p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>"""
    created_time: NotRequired["capo_appstream.types.timestamp.Timestamp"]
    """<p>The time the directory configuration was created.</p>"""
    certificate_based_auth_properties: NotRequired[
        "capo_appstream.types.certificate_based_auth_properties.CertificateBasedAuthProperties"
    ]
    """<p>The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is <b>Enabled</b> . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. <b>Enabled_no_directory_login_fallback</b> enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.</p>"""

certificate_based_auth_properties instance-attribute

certificate_based_auth_properties: NotRequired[CertificateBasedAuthProperties]

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

created_time instance-attribute

created_time: NotRequired[Timestamp]

The time the directory configuration was created.

directory_name instance-attribute

directory_name: NotRequired[DirectoryName]

The fully qualified name of the directory (for example, corp.example.com).

organizational_unit_distinguished_names instance-attribute

organizational_unit_distinguished_names: NotRequired[
    OrganizationalUnitDistinguishedNamesList
]

The distinguished names of the organizational units for computer accounts.

service_account_credentials instance-attribute

service_account_credentials: NotRequired[ServiceAccountCredentials]

The credentials for the service account used by the fleet or image builder to connect to the directory.