Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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 policy that controls how authentication requests from on-premises environments are managed. This resource allows administrators to define and enforce rules for on-premises authentication scenarios for users and applications.
Inherits from stsPolicy.
Methods
| Method | Return type | Description |
|---|---|---|
| List | onPremAuthenticationPolicy collection | Get a list of the onPremAuthenticationPolicy objects and their properties. |
| Create | onPremAuthenticationPolicy | Create a new onPremAuthenticationPolicy object. |
| Get | onPremAuthenticationPolicy | Read the properties and relationships of onPremAuthenticationPolicy object. |
| Update | onPremAuthenticationPolicy | Update the properties of an onPremAuthenticationPolicy object. |
| Delete | None | Delete an onPremAuthenticationPolicy object. |
| List applies to | directoryObject collection | Get the list of directoryObjects that this policy has been applied to. |
| Assign to | directoryObject | Add appliesTo by posting to the appliesTo collection. |
| Remove applies to | None | Remove a directoryObject object. |
Properties
| Property | Type | Description |
|---|---|---|
| deletedDateTime | DateTimeOffset | Date and time when this object was deleted. Always null when the object isn't deleted. Inherited from directoryObject. Optional. |
| definition | String collection | A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Required. Inherited from stsPolicy. |
| description | String | Description for this policy. Required. Inherited from policyBase. |
| displayName | String | Display name for this policy. Required. Inherited from policyBase. |
| id | String | Unique identifier for this policy. Read-only. Inherited from entity. |
| isOrganizationDefault | Boolean | If set to true, this instance of the policy will be considered the default for the organization. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. Inherited from stsPolicy. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| appliesTo | directoryObject collection | The directoryObject collection that this policy has been applied to. Read-only. Inherited from microsoft.graph.stsPolicy |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.onPremAuthenticationPolicy",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"definition": [
"String"
],
"isOrganizationDefault": "Boolean"
}