🔍 Code Extractor

class ConditionalAccessPolicy

Maturity: 43

Represents an Azure Active Directory conditional access policy entity that defines custom rules for access scenarios.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/policies/conditional_access.py
Lines:
4 - 10
Complexity:
simple

Purpose

This class serves as a data model for Azure AD conditional access policies, which are security rules that control when and how users can access resources. It inherits from the Entity base class to provide standard entity functionality for interacting with Microsoft Graph API endpoints related to conditional access policies. The class is designed to be used within the Office365 SDK to manage and manipulate conditional access policies programmatically.

Source Code

class ConditionalAccessPolicy(Entity):
    """
    Represents an Azure Active Directory conditional access policy.
    Conditional access policies are custom rules that define an access scenario.
    """

    pass

Parameters

Name Type Default Kind
bases Entity -

Parameter Details

bases: Inherits from Entity class, which provides base functionality for Microsoft Graph API entities including property management, serialization, and API interaction capabilities

Return Value

Instantiation returns a ConditionalAccessPolicy object that represents an Azure AD conditional access policy. The object inherits all methods and properties from the Entity base class, allowing interaction with the Microsoft Graph API for conditional access policy operations.

Class Interface

Dependencies

  • office365

Required Imports

from office365.entity import Entity
from office365.directory.policies.conditionalaccesspolicy import ConditionalAccessPolicy

Usage Example

from office365.directory.policies.conditionalaccesspolicy import ConditionalAccessPolicy
from office365.graph_client import GraphClient

# Initialize Graph client with credentials
client = GraphClient.with_client_secret(tenant_id, client_id, client_secret)

# Get a conditional access policy
policy = client.policies.conditional_access_policies.get_by_id('policy-id')
client.execute_query()

# Access policy properties (inherited from Entity)
print(policy.display_name)
print(policy.state)

# Create a new conditional access policy
new_policy = ConditionalAccessPolicy()
new_policy.display_name = 'Block Legacy Authentication'
client.policies.conditional_access_policies.add(new_policy)
client.execute_query()

Best Practices

  • Always authenticate properly with Microsoft Graph API before attempting to access or modify conditional access policies
  • Use execute_query() after operations to commit changes to the Microsoft Graph API
  • Ensure your application has the appropriate permissions (Policy.Read.All, Policy.ReadWrite.ConditionalAccess) in Azure AD
  • The class is a pass-through entity, so all functionality comes from the Entity base class
  • Handle API exceptions appropriately as conditional access policy operations require elevated permissions
  • Test conditional access policies in a non-production environment before deploying to production
  • Be aware that this class represents the data model; actual CRUD operations are performed through the GraphClient and collection methods

Tags

azure-ad conditional-access security-policy microsoft-graph office365 entity access-control authentication authorization

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class AuthenticationStrengthPolicy 74.3% similar

    Represents an Azure AD authentication strength policy that defines specific combinations of authentication methods and metadata for Conditional Access scenarios.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/policies/authentication_strength.py

  • class ConditionalAccessRoot 70.6% similar

    ConditionalAccessRoot is an entry point class for the Conditional Access (CA) object model in Microsoft Graph API. It serves as a placeholder entity without any usable properties of its own.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/identities/conditional_access_root.py

  • class CrossTenantAccessPolicy 67.6% similar

    Represents the base policy in the directory for cross-tenant access settings in Microsoft 365/Azure AD environments.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/policies/cross_tenant_access.py

  • class AuthorizationPolicy 66.0% similar

    A singleton class representing Azure Active Directory authorization policy settings that control tenant-level authorization behaviors.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/policies/authorization.py

  • class PolicyRoot 64.1% similar

    PolicyRoot is a resource class that provides access to various Azure Active Directory (Azure AD) policy configurations through navigation properties, acting as a singleton entry point for policy management.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/policies/root.py
← Back to Browse