Show / Hide Table of Contents

Policy.ReadWrite.ConditionalAccess

Allows the app to read and write your organization's conditional access policies on behalf of the signed-in user.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D DELETE /identity/conditionalAccess/namedLocations/{id}
V1 A,D DELETE /identity/conditionalAccess/policies/{id}
Beta A,D GET /identity/conditionalAccess/authenticationContextClassReferences
Beta D GET /tenantRelationships/managedTenants/conditionalAccessPolicyCoverages
Beta D GET /tenantRelationships/managedTenants/conditionalAccessPolicyCoverages/{conditionalAccessPolicyCoverageId}
Beta A,D PATCH /identity/conditionalAccess/authenticationContextClassReferences/{id}
V1 A,D PATCH /identity/conditionalAccess/namedLocations/{id}
V1 A,D PATCH /identity/conditionalAccess/policies/{id}
Beta A,D PATCH /identity/continuousAccessEvaluationPolicy
V1 A,D PATCH /policies/identitySecurityDefaultsEnforcementPolicy
Beta A,D POST /identity/conditionalAccess/authenticationContextClassReferences
V1 A,D POST /identity/conditionalAccess/namedLocations
V1 A,D POST /identity/conditionalAccess/policies

Delegate Permission

Id ad902697-1014-4ef5-81ef-2b4301988e8c
Consent Type Admin
Display String Read and write your organization's conditional access policies
Description Allows the app to read and write your organization's conditional access policies on behalf of the signed-in user.

Application Permission

Id 01c0a623-fc9b-48e9-b794-0756f8e8f067
Display String Read and write your organization's conditional access policies
Description Allows the app to read and write your organization's conditional access policies, without a signed-in user.

Resources

authenticationContextClassReference

Property Type Description
id String Identifier used to reference the authentication context class. The id is used to trigger step-up authentication for the referenced authentication requirements and is the value that will be issued in the acrs claim. This value in the claim is used to verify the required authentication context has been satisfied. The allowed id values are "c1" through "c25".
displayName String The display name is the friendly name of the authenticationContextClassReference. This value should be used to identify the authentication context class reference when building user facing admin experiences. For example, selection UX.
description String A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user facing admin experiences. For example, selection UX.
isAvailable boolean Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it is set to false it should not be shown in admin UX experiences because the value is not currently available for selection.

conditionalAccessApplications

Property Type Description
includeApplications String collection The list of application IDs the policy applies to, unless explicitly excluded (in excludeApplications). Can also be set to All.
excludeApplications String collection The list of application IDs explicitly excluded from the policy.
includeUserActions String collection User actions to include. Supported values are urn:user:registersecurityinfo and urn:user:registerdevice

conditionalAccessGrantControls

Property Type Description
operator String Defines the relationship of the grant controls. Possible values: AND, OR.
builtInControls conditionalAccessGrantControl collection List of values of built-in controls required by the policy. Possible values: block, mfa, compliantDevice, domainJoinedDevice, approvedApplication, compliantApplication, passwordChange, unknownFutureValue.
customAuthenticationFactors String collection List of custom controls IDs required by the policy. For more information, see Custom controls.
termsOfUse String collection List of terms of use IDs required by the policy.

conditionalAccessPolicy

Property Type Description
conditions conditionalAccessConditionSet Specifies the rules that must be met for the policy to apply. Required.
createdDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Readonly.
displayName String Specifies a display name for the conditionalAccessPolicy object.
grantControls conditionalAccessGrantControls Specifies the grant controls that must be fulfilled to pass the policy.
id String Specifies the identifier of a conditionalAccessPolicy object. Read-only.
modifiedDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Readonly.
sessionControls conditionalAccessSessionControls Specifies the session controls that are enforced after sign-in.
state conditionalAccessPolicyState Specifies the state of the conditionalAccessPolicy object. Possible values are: enabled, disabled, enabledForReportingButNotEnforced. Required.

conditionalAccessSessionControls

Property Type Description
applicationEnforcedRestrictions applicationEnforcedRestrictionsSessionControl Session control to enforce application restrictions. Only Exchange Online and Sharepoint Online support this session control.
cloudAppSecurity cloudAppSecuritySessionControl Session control to apply cloud app security.
disableResilienceDefaults Boolean Session control that determines whether it is acceptable for Azure AD to extend existing sessions based on information collected prior to an outage or not.
persistentBrowser persistentBrowserSessionControl Session control to define whether to persist cookies or not. All apps should be selected for this session control to work correctly.
signInFrequency signInFrequencySessionControl Session control to enforce signin frequency.

conditionalAccessUsers

Property Type Description
includeUsers String collection User IDs in scope of policy unless explicitly excluded, or None or All or GuestsOrExternalUsers.
excludeUsers String collection User IDs excluded from scope of policy and/or GuestsOrExternalUsers.
includeGroups String collection Group IDs in scope of policy unless explicitly excluded, or All.
excludeGroups String collection Group IDs excluded from scope of policy.
includeRoles String collection Role IDs in scope of policy unless explicitly excluded, or All.
excludeRoles String collection Role IDs excluded from scope of policy.

continuousAccessEvaluationPolicy

Property Type Description
description String Continuous access evaluation automatically blocks access to resources and applications in near real time when a user's access is removed or a client IP address changes. Read-only.
displayName String The value is always Continuous Access Evaluation. Read-only.
groups String collection The collection of group identifiers in scope for evaluation. All groups are in scope when the collection is empty. Read-only.
id String Specifies the identifier of a continuousAccessEvaluationPolicy object. Read-only.
isEnabled Boolean true to indicate whether continuous access evaluation should be performed; otherwise false. Read-only.
users String collection The collection of user identifiers in scope for evaluation. All users are in scope when the collection is empty. Read-only.
migrate Boolean true to indicate that the continuous access evaluation policy settings should be or has been migrated to the conditional access policy.

countryNamedLocation

Property Type Description
countriesAndRegions String collection List of countries and/or regions in two-letter format specified by ISO 3166-2. Required.
countryLookupMethod countryLookupMethodType Determines what method is used to decide which country the user is located in. Possible values are clientIpAddress(default) and authenticatorAppGps. Note: authenticatorAppGps is not yet supported in the Microsoft Cloud for US Government.
createdDateTime DateTimeOffset The Timestamp type represents creation date and time of the location using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Inherited from namedLocation.
displayName String Human-readable name of the location. Required. Inherited from namedLocation.
id String Identifier of a namedLocation object. Read-only. Inherited from namedLocation.
includeUnknownCountriesAndRegions Boolean true if IP addresses that don't map to a country or region should be included in the named location. Optional. Default value is false.
modifiedDateTime DateTimeOffset The Timestamp type represents last modified date and time of the location using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Inherited from namedLocation.

identitySecurityDefaultsEnforcementPolicy

Property Type Description
description String Description for this policy. Read-only.
displayName String Display name for this policy. Read-only.
id String Identifier for this policy. Read-only.
isEnabled Boolean If set to true, Azure Active Directory security defaults is enabled for the tenant.

ipNamedLocation

Property Type Description
createdDateTime DateTimeOffset The Timestamp type represents creation date and time of the location using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Inherited from namedLocation.
displayName String Human-readable name of the location. Required.
id String Identifier of a namedLocation object. Read-only. Inherited from namedLocation.
ipRanges ipRange collection List of IP address ranges in IPv4 CIDR format (e.g. 1.2.3.4/32) or any allowable IPv6 format from IETF RFC596. Required.
isTrusted Boolean true if this location is explicitly trusted. Optional. Default value is false.
modifiedDateTime DateTimeOffset The Timestamp type represents last modified date and time of the location using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Inherited from namedLocation.

ipRange

conditionalAccessPolicyCoverage

Property Type Description
conditionalAccessPolicyState String The state for the conditional access policy. Possible values are: enabled, disabled, enabledForReportingButNotEnforced. Required. Read-only.
id String The unique identifier for this entity. Required. Read-only.
latestPolicyModifiedDateTime DateTimeOffset The date and time the conditional access policy was last modified. Required. Read-only.
requiresDeviceCompliance Boolean A flag indicating whether the conditional access policy requires device compliance. Required. Read-only.
tenantDisplayName String The display name for the managed tenant. Required. Read-only.

namedLocation

Property Type Description
createdDateTime DateTimeOffset The Timestamp type represents creation date and time of the location using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
displayName String Human-readable name of the location.
id String Identifier of a namedLocation object. Read-only.
modifiedDateTime DateTimeOffset The Timestamp type represents last modified date and time of the location using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
In This Article
Back to top Created by merill | Submit feedback