unifiedRoleEligibilityScheduleInstance resource type

  • Článek

Namespace: microsoft.graph

Represents the instance for a role eligibility in your tenant.

Inherits from unifiedRoleScheduleInstanceBase.

Methods

Method Return type Description
List unifiedRoleEligibilityScheduleInstance collection Get the instances of role eligibilities.
Get unifiedRoleEligibilityScheduleInstance Get the instance of a role eligibility.
Filter by current user unifiedRoleEligibilityScheduleInstance collection Get the instances of eligible roles for the calling principal.

Properties

Property Type Description
appScopeId String Identifier of the app-specific scope when the role eligibility is scoped to an app. The scope of the role eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. Inherited from unifiedRoleScheduleInstanceBase. Supports $filter (eq, ne, and on null values).
directoryScopeId String Identifier of the directory object representing the scope of the role eligibility. The scope of the role eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Inherited from unifiedRoleScheduleInstanceBase. Supports $filter (eq, ne, and on null values).
endDateTime DateTimeOffset The end date of the schedule instance.
id String The unique identifier for the schedule object. Inherited from entity.
memberType String How the role eligibility is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleEligibilitySchedule can be managed by the caller. Supports $filter (eq, ne).
principalId String Identifier of the principal that's eligible for a role. Inherited from unifiedRoleScheduleInstanceBase. Supports $filter (eq, ne).
roleDefinitionId String Identifier of the unifiedRoleDefinition object that the principal is eligible for. Inherited from unifiedRoleScheduleInstanceBase. Supports $filter (eq, ne).
roleEligibilityScheduleId String The identifier of the unifiedRoleEligibilitySchedule object from which this instance was created. Supports $filter (eq, ne).
startDateTime DateTimeOffset When this instance starts.

Relationships

Relationship Type Description
appScope appScope Read-only property with details of the app-specific scope when the role eligibility is scoped to an app. Nullable. Inherited from unifiedRoleScheduleInstanceBase. Supports $expand.
directoryScope directoryObject The directory object that is the scope of the role eligibility. Read-only. Inherited from unifiedRoleScheduleInstanceBase. Supports $expand.
principal directoryObject The principal that's getting a role eligibility through the request. Inherited from unifiedRoleScheduleInstanceBase. Supports $expand.
roleDefinition unifiedRoleDefinition Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property. Inherited from unifiedRoleScheduleInstanceBase. Supports $expand.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.unifiedRoleEligibilityScheduleInstance",
  "id": "String (identifier)",
  "principalId": "String",
  "roleDefinitionId": "String",
  "directoryScopeId": "String",
  "appScopeId": "String",
  "startDateTime": "String (timestamp)",
  "endDateTime": "String (timestamp)",
  "memberType": "String",
  "roleEligibilityScheduleId": "String"
}