conditionalAccessPolicy resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a Microsoft Entra Conditional Access policy. Conditional access policies are custom rules that define an access scenario. For more information, see the Conditional access documentation.
Methods
| Method | Return Type | Description |
|---|---|---|
| List | conditionalAccessPolicy collection | Get all of the conditionalAccessPolicies objects in the organization. |
| Create | conditionalAccessPolicy | Create a new conditionalAccessPolicy object. |
| Get | conditionalAccessPolicy | Read properties and relationships of a conditionalAccessPolicy object. |
| Update | conditionalAccessPolicy | Update a conditionalAccessPolicy object. |
| Delete | None | Delete a conditionalAccessPolicy object. |
Properties
| 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. |
| description | String | Not used. |
| 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. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"conditions": {"@odata.type": "microsoft.graph.conditionalAccessConditionSet"},
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"grantControls": {"@odata.type": "microsoft.graph.conditionalAccessGrantControls"},
"id": "String (identifier)",
"modifiedDateTime": "String (timestamp)",
"sessionControls": {"@odata.type": "microsoft.graph.conditionalAccessSessionControls"},
"state": "string"
}