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 Microsoft Entra B2B features in Microsoft Entra External ID for workforce tenants, including restricting/allowing which domains can be used to invite users, if auto redemption of invitations is allowed, and opt in of preview features.
Inherits from stsPolicy.
Methods
| Method | Return type | Description |
|---|---|---|
| List | b2bManagementPolicy collection | Get a list of the b2bManagementPolicy objects and their properties. |
| Create | b2bManagementPolicy | Create a new b2bManagementPolicy object. |
| Get | b2bManagementPolicy | Read the properties and relationships of b2bManagementPolicy object. |
| Update | b2bManagementPolicy | Update the properties of a b2bManagementPolicy object. |
| Delete | None | Delete a b2bManagementPolicy object. |
| List appliesTo | directoryObject collection | Get the list of directoryObjects that this policy is applied to. |
| Add appliesTo | directoryObject | Add appliesTo by posting to the appliesTo collection. |
| Remove appliesTo | None | Remove a directoryObject object that this policy is applied to. |
Properties
| Property | Type | Description |
|---|---|---|
| deletedDateTime | DateTimeOffset | Date and Time when the policy object was deleted. Inherited from directoryObject. |
| definition | String collection | A string collection containing a JSON string that defines the rules and settings for a policy. Inherited from stsPolicy. Required. |
| description | String | Description for this policy. Inherited from policyBase. Required. |
| displayName | String | Display name for this policy. Inherited from policyBase. Required. |
| id | String | The unique identifier for the policy. Inherited from entity. |
| isOrganizationDefault | Boolean | If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Inherited from stsPolicy. Optional. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| appliesTo | directoryObject collection | The directoryObject collection that this policy is applied to. Read-only. Inherited from microsoft.graph.stsPolicy |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.b2bManagementPolicy",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"definition": [
"String"
],
"isOrganizationDefault": "Boolean"
}