UNPKG

@microsoft/msgraph-beta-sdk

Version:
1,289 lines 11 MB
import { type AgentSignIn } from './agentic/index.js'; import { type CallRecord } from './callRecords/index.js'; import { type GroupCloudLicensing, type UserCloudLicensing } from './cloudLicensing/index.js'; import { type Monitoring } from './deviceManagement/index.js'; import { type Ediscoveryroot } from './ediscovery/index.js'; import { type HealthMonitoringRoot } from './healthMonitoring/index.js'; import { type LifecycleWorkflowsContainer, type Workflow } from './identityGovernance/index.js'; import { type ManagedTenant } from './managedTenants/index.js'; import { type PartnerSecurity } from './partner/security/index.js'; import { type Billing } from './partners/billing/index.js'; import { type Acronym, type Bookmark, type Qna } from './search/index.js'; import { BehaviorDuringRetentionPeriod, type AuditCoreRoot, type CasesRoot, type CollaborationRoot, type DataDiscoveryRoot, type IdentityContainer as I2b88f0c27d7fd9c000e7e4e78cc3161590db07c518949b504f8a27680ed1200f, type Incident, type IncidentTask, type InformationProtection as I4e59ad7f33a80062e65e44cb0388f1dd8c3f3946f41528003b4efb43cd7aa41a, type LabelsRoot, type RulesRoot, type Security as I74bd4c4a15534de8ea85f48f0c772cb06bf0e1613540a31fcc8cff6c4cb0c5f9, type ThreatIntelligence, type ThreatSubmissionRoot, type TriggersRoot, type TriggerTypesRoot } from './security/index.js'; import { type TeamsAdminRoot } from './teamsAdministration/index.js'; import { type Set, type Store, type Term } from './termStore/index.js'; import { type Catalog, type Deployment, type DeploymentAudience, type Product, type ResourceConnection, type UpdatableAsset, type UpdatePolicy } from './windowsUpdates/index.js'; import { type AdditionalDataHolder, type BackedModel, type DateOnly, type Duration, type Guid, type Parsable, type ParseNode, type SerializationWriter, type TimeOnly, type UntypedNode } from '@microsoft/kiota-abstractions'; export interface AadSource extends AuthorizationSystemIdentitySource, Parsable { /** * Domain name */ domain?: string | null; } export interface AadUserConversationMember extends ConversationMember, Parsable { /** * The email address of the user. */ email?: string | null; /** * TenantId which the Microsoft Entra user belongs to. */ tenantId?: string | null; /** * The user property */ user?: User | null; /** * The GUID of the user. */ userId?: string | null; } export interface AadUserConversationMemberResult extends ActionResultPart, Parsable { /** * The user object ID of the Microsoft Entra user that was being added as part of the bulk operation. */ userId?: string | null; } export interface AadUserNotificationRecipient extends Parsable, TeamworkNotificationRecipient { /** * Microsoft Entra user identifier. Use the List users method to get this ID. */ userId?: string | null; } export interface AccessAction extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessPackage extends Entity, Parsable { /** * Read-only. Nullable. Supports $expand. */ accessPackageAssignmentPolicies?: AccessPackageAssignmentPolicy[] | null; /** * The accessPackageCatalog property */ accessPackageCatalog?: AccessPackageCatalog | null; /** * The accessPackageResourceRoleScopes property */ accessPackageResourceRoleScopes?: AccessPackageResourceRoleScope[] | null; /** * The access packages that are incompatible with this package. Read-only. */ accessPackagesIncompatibleWith?: AccessPackage[] | null; /** * Identifier of the access package catalog referencing this access package. Read-only. */ catalogId?: string | null; /** * The userPrincipalName of the user or identity of the subject who created this resource. Read-only. */ createdBy?: string | null; /** * 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. Read-only. */ createdDateTime?: Date | null; /** * The description of the access package. */ description?: string | null; /** * The display name of the access package. Supports $filter (eq, contains). */ displayName?: string | null; /** * The access packages whose assigned users are ineligible to be assigned this access package. */ incompatibleAccessPackages?: AccessPackage[] | null; /** * The groups whose members are ineligible to be assigned this access package. */ incompatibleGroups?: Group[] | null; /** * Indicates whether the access package is hidden from the requestor. */ isHidden?: boolean | null; /** * Indicates whether role scopes are visible. */ isRoleScopesVisible?: boolean | null; /** * The userPrincipalName of the user who last modified this resource. Read-only. */ modifiedBy?: string | null; /** * 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. Read-only. */ modifiedDateTime?: Date | null; /** * The uniqueName property */ uniqueName?: string | null; } export interface AccessPackageAnswer extends AdditionalDataHolder, BackedModel, Parsable { /** * The question the answer is for. Required and Read-only. */ answeredQuestion?: AccessPackageQuestion | null; /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The display value of the answer. Required. */ displayValue?: string | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessPackageAnswerChoice extends AdditionalDataHolder, BackedModel, Parsable { /** * The actual value of the selected choice. This is typically a string value which is understandable by applications. Required. */ actualValue?: string | null; /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The localized display values shown to the requestor and approvers. Required. */ displayValue?: AccessPackageLocalizedContent | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessPackageAnswerString extends AccessPackageAnswer, Parsable { /** * The value stored on the requestor's user profile, if this answer is configured to be stored as a specific attribute. */ value?: string | null; } export interface AccessPackageApprovalStage extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The number of days that a request can be pending a response before it is automatically denied. */ durationBeforeAutomaticDenial?: Duration | null; /** * If escalation is required, the time a request can be pending a response from a primary approver. */ durationBeforeEscalation?: Duration | null; /** * If escalation is enabled and the primary approvers do not respond before the escalation time, the escalationApprovers are the users who will be asked to approve requests. */ escalationApprovers?: SubjectSet[] | null; /** * The subjects, typically users, who are the fallback escalation approvers. */ fallbackEscalationApprovers?: SubjectSet[] | null; /** * The subjects, typically users, who are the fallback primary approvers. */ fallbackPrimaryApprovers?: SubjectSet[] | null; /** * Indicates whether the approver is required to provide a justification for approving a request. */ isApproverJustificationRequired?: boolean | null; /** * If true, then one or more escalationApprovers are configured in this approval stage. */ isEscalationEnabled?: boolean | null; /** * The OdataType property */ odataType?: string | null; /** * The subjects, typically users, who will be asked to approve requests. A collection of singleUser, groupMembers, requestorManager, internalSponsors, externalSponsors, or targetUserSponsors. */ primaryApprovers?: SubjectSet[] | null; } export interface AccessPackageAssignment extends Entity, Parsable { /** * Read-only. Nullable. Supports $filter (eq) on the id property and $expand query parameters. */ accessPackage?: AccessPackage | null; /** * Read-only. Nullable. Supports $filter (eq) on the id property */ accessPackageAssignmentPolicy?: AccessPackageAssignmentPolicy | null; /** * The accessPackageAssignmentRequests property */ accessPackageAssignmentRequests?: AccessPackageAssignmentRequest[] | null; /** * The resource roles delivered to the target user for this assignment. Read-only. Nullable. */ accessPackageAssignmentResourceRoles?: AccessPackageAssignmentResourceRole[] | null; /** * The identifier of the access package. Read-only. */ accessPackageId?: string | null; /** * The identifier of the access package assignment policy. Read-only. */ assignmentPolicyId?: string | null; /** * The state of the access package assignment. Possible values are Delivering, Delivered, or Expired. Read-only. Supports $filter (eq). */ assignmentState?: string | null; /** * More information about the assignment lifecycle. Possible values include Delivering, Delivered, AutoAssignmentInGracePeriod, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only. */ assignmentStatus?: string | null; /** * The identifier of the catalog containing the access package. Read-only. */ catalogId?: string | null; /** * Information about all the custom extension calls that were made during the access package assignment workflow. */ customExtensionCalloutInstances?: CustomExtensionCalloutInstance[] | null; /** * 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 */ expiredDateTime?: Date | null; /** * Indicates whether the access package assignment is extended. Read-only. */ isExtended?: boolean | null; /** * When the access assignment is to be in place. Read-only. */ schedule?: RequestSchedule | null; /** * The subject of the access package assignment. Read-only. Nullable. Supports $expand. Supports $filter (eq) on objectId. */ target?: AccessPackageSubject | null; /** * This property should not be used as a dependency, as it may change without notice. Instead, expand the target relationship and use the objectId property. Read-only. */ targetId?: string | null; } export interface AccessPackageAssignmentCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageAssignment[] | null; } export interface AccessPackageAssignmentPolicy extends Entity, Parsable { /** * The access package with this policy. Read-only. Nullable. Supports $expand. */ accessPackage?: AccessPackage | null; /** * The accessPackageCatalog property */ accessPackageCatalog?: AccessPackageCatalog | null; /** * Identifier of the access package. */ accessPackageId?: string | null; /** * Represents the settings for email notifications for requests to an access package. */ accessPackageNotificationSettings?: AccessPackageNotificationSettings | null; /** * Who must review, and how often, the assignments to the access package from this policy. This property is null if reviews aren't required. */ accessReviewSettings?: AssignmentReviewSettings | null; /** * Indicates whether a user can extend the access package assignment duration after approval. */ canExtend?: boolean | null; /** * The createdBy property */ createdBy?: string | null; /** * 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 */ createdDateTime?: Date | null; /** * The collection of stages when to execute one or more custom access package workflow extensions. Supports $expand. */ customExtensionHandlers?: CustomExtensionHandler[] | null; /** * The collection of stages when to execute one or more custom access package workflow extensions. Supports $expand. */ customExtensionStageSettings?: CustomExtensionStageSetting[] | null; /** * The description of the policy. */ description?: string | null; /** * The display name of the policy. Supports $filter (eq). */ displayName?: string | null; /** * The number of days in which assignments from this policy last until they're expired. */ durationInDays?: number | null; /** * The expiration date for assignments created in this policy. 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 */ expirationDateTime?: Date | null; /** * The modifiedBy property */ modifiedBy?: string | null; /** * 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 */ modifiedDateTime?: Date | null; /** * Questions that are posed to the requestor. */ questions?: AccessPackageQuestion[] | null; /** * Who must approve requests for access package in this policy. */ requestApprovalSettings?: ApprovalSettings | null; /** * Who can request this access package from this policy. */ requestorSettings?: RequestorSettings | null; /** * Settings for verifiable credentials set up through the Microsoft Entra Verified I D service. These settings represent the verifiable credentials that a requestor of an access package in this policy can present to be assigned the access package. */ verifiableCredentialSettings?: VerifiableCredentialSettings | null; } export interface AccessPackageAssignmentPolicyCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageAssignmentPolicy[] | null; } export interface AccessPackageAssignmentRequest extends Entity, Parsable { /** * The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of resource roles and the policies for how one or more users can get access to those resources. Read-only. Nullable. Supports $expand. */ accessPackage?: AccessPackage | null; /** * For a requestType of UserAdd or AdminAdd, an access package assignment requested to be created. For a requestType of UserRemove, AdminRemove, or SystemRemove, this property has the id property of an existing assignment to be removed. Supports $expand. */ accessPackageAssignment?: AccessPackageAssignment | null; /** * Answers provided by the requestor to accessPackageQuestions asked of them at the time of request. */ answers?: AccessPackageAnswer[] | null; /** * The date of the end of processing, either successful or failure, of a request. 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. Read-only. */ completedDate?: Date | null; /** * 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. Read-only. */ createdDateTime?: Date | null; /** * Information about all the custom extension calls that were made during the access package assignment request workflow. */ customExtensionCalloutInstances?: CustomExtensionCalloutInstance[] | null; /** * A collection of custom workflow extension instances being run on an assignment request. Read-only. */ customExtensionHandlerInstances?: CustomExtensionHandlerInstance[] | null; /** * 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 */ expirationDateTime?: Date | null; /** * The history property */ history?: RequestActivity[] | null; /** * True if the request isn't to be processed for assignment. */ isValidationOnly?: boolean | null; /** * The requestor's supplied justification. */ justification?: string | null; /** * The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports $expand. */ requestor?: AccessPackageSubject | null; /** * One of PendingApproval, Canceled, Denied, Delivering, Delivered, PartiallyDelivered, DeliveryFailed, Submitted, or Scheduled. Read-only. */ requestState?: string | null; /** * More information on the request processing status. Read-only. */ requestStatus?: string | null; /** * One of UserAdd, UserExtend, UserUpdate, UserRemove, AdminAdd, AdminRemove, or SystemRemove. A request from the user has a requestType of UserAdd, UserUpdate, or UserRemove. Read-only. */ requestType?: string | null; /** * The range of dates that access is to be assigned to the requestor. Read-only. */ schedule?: RequestSchedule | null; /** * The details of the verifiable credential that the requestor presented, such as the issuer and claims. Read-only. */ verifiedCredentialsData?: VerifiedCredentialData[] | null; } export interface AccessPackageAssignmentRequestCallbackData extends CustomExtensionData, Parsable { /** * Details for the callback. */ customExtensionStageInstanceDetail?: string | null; /** * Unique identifier of the callout to the custom extension. */ customExtensionStageInstanceId?: string | null; /** * Indicates the stage at which the custom callout extension is executed. The possible values are: assignmentRequestCreated, assignmentRequestApproved, assignmentRequestGranted, assignmentRequestRemoved, assignmentFourteenDaysBeforeExpiration, assignmentOneDayBeforeExpiration, unknownFutureValue. */ stage?: AccessPackageCustomExtensionStage | null; /** * Allow the extension to be able to deny or cancel the request submitted by the requestor. The supported values are Denied and Canceled. This property can only be set for an assignmentRequestCreated stage. */ state?: string | null; } export interface AccessPackageAssignmentRequestCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageAssignmentRequest[] | null; } export interface AccessPackageAssignmentRequestRequirements extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * Answers that have already been provided. */ existingAnswers?: AccessPackageAnswer[] | null; /** * Indicates whether a request must be approved by an approver. */ isApprovalRequired?: boolean | null; /** * Indicates whether approval is required when a user tries to extend their access. */ isApprovalRequiredForExtension?: boolean | null; /** * Indicates whether the requestor is allowed to set a custom schedule. */ isCustomAssignmentScheduleAllowed?: boolean | null; /** * Indicates whether a requestor must supply justification when submitting an assignment request. */ isRequestorJustificationRequired?: boolean | null; /** * The OdataType property */ odataType?: string | null; /** * The description of the policy that the user is trying to request access using. */ policyDescription?: string | null; /** * The display name of the policy that the user is trying to request access using. */ policyDisplayName?: string | null; /** * The identifier of the policy that these requirements are associated with. This identifier can be used when creating a new assignment request. */ policyId?: string | null; /** * Questions that are configured on the policy. The questions can be required or optional; callers can determine whether a question is required or optional based on the isRequired property on accessPackageQuestion. */ questions?: AccessPackageQuestion[] | null; /** * Schedule restrictions enforced, if any. */ schedule?: RequestSchedule | null; /** * The status of the process to process the verifiable credential, if any. */ verifiableCredentialRequirementStatus?: VerifiableCredentialRequirementStatus | null; } export interface AccessPackageAssignmentRequestWorkflowExtension extends CustomCalloutExtension, Parsable { /** * The callback configuration for a custom extension. */ callbackConfiguration?: CustomExtensionCallbackConfiguration | null; /** * The userPrincipalName of the user or identity of the subject that created this resource. Read-only. */ createdBy?: string | null; /** * When the object was created. */ createdDateTime?: Date | null; /** * The userPrincipalName of the identity that last modified the object. */ lastModifiedBy?: string | null; /** * When the object was last modified. */ lastModifiedDateTime?: Date | null; } export interface AccessPackageAssignmentResourceRole extends Entity, Parsable { /** * The access package assignments resulting in this role assignment. Read-only. Nullable. */ accessPackageAssignments?: AccessPackageAssignment[] | null; /** * The accessPackageResourceRole property */ accessPackageResourceRole?: AccessPackageResourceRole | null; /** * The accessPackageResourceScope property */ accessPackageResourceScope?: AccessPackageResourceScope | null; /** * Read-only. Nullable. Supports $filter (eq) on objectId and $expand query parameters. */ accessPackageSubject?: AccessPackageSubject | null; /** * A unique identifier relative to the origin system, corresponding to the originId property of the accessPackageResourceRole. */ originId?: string | null; /** * The system where the role assignment is to be created or has been created for an access package assignment, such as SharePointOnline, AadGroup, or AadApplication, corresponding to the originSystem property of the accessPackageResourceRole. */ originSystem?: string | null; /** * The value is PendingFulfillment before the access package assignment is delivered to the origin system, and Fulfilled after the access package assignment is delivered to the origin system. */ status?: string | null; } export interface AccessPackageAssignmentResourceRoleCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageAssignmentResourceRole[] | null; } export interface AccessPackageAssignmentWorkflowExtension extends CustomCalloutExtension, Parsable { /** * The callback configuration for a custom extension. */ callbackConfiguration?: CustomExtensionCallbackConfiguration | null; /** * The userPrincipalName of the user or identity of the subject that created this resource. Read-only. */ createdBy?: string | null; /** * When the entity was created. */ createdDateTime?: Date | null; /** * The userPrincipalName of the identity that last modified the entity. */ lastModifiedBy?: string | null; /** * When the entity was last modified. */ lastModifiedDateTime?: Date | null; } export interface AccessPackageCatalog extends Entity, Parsable { /** * The attributes of a logic app, which can be called at various stages of an access package request and assignment cycle. */ accessPackageCustomWorkflowExtensions?: CustomCalloutExtension[] | null; /** * The roles in each resource in a catalog. Read-only. */ accessPackageResourceRoles?: AccessPackageResourceRole[] | null; /** * The accessPackageResources property */ accessPackageResources?: AccessPackageResource[] | null; /** * The accessPackageResourceScopes property */ accessPackageResourceScopes?: AccessPackageResourceScope[] | null; /** * The access packages in this catalog. Read-only. Nullable. Supports $expand. */ accessPackages?: AccessPackage[] | null; /** * Has the value Published if the access packages are available for management. */ catalogStatus?: string | null; /** * One of UserManaged or ServiceDefault. */ catalogType?: string | null; /** * UPN of the user who created this resource. Read-only. */ createdBy?: string | null; /** * 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. Read-only. */ createdDateTime?: Date | null; /** * The customAccessPackageWorkflowExtensions property */ customAccessPackageWorkflowExtensions?: CustomAccessPackageWorkflowExtension[] | null; /** * The description of the access package catalog. */ description?: string | null; /** * The display name of the access package catalog. Supports $filter (eq, contains). */ displayName?: string | null; /** * Whether the access packages in this catalog can be requested by users outside of the tenant. */ isExternallyVisible?: boolean | null; /** * The UPN of the user who last modified this resource. Read-only. */ modifiedBy?: string | null; /** * 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. Read-only. */ modifiedDateTime?: Date | null; /** * The uniqueName property */ uniqueName?: string | null; } export interface AccessPackageCatalogCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageCatalog[] | null; } export interface AccessPackageCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackage[] | null; } export type AccessPackageCustomExtensionHandlerStatus = (typeof AccessPackageCustomExtensionHandlerStatusObject)[keyof typeof AccessPackageCustomExtensionHandlerStatusObject]; export type AccessPackageCustomExtensionStage = (typeof AccessPackageCustomExtensionStageObject)[keyof typeof AccessPackageCustomExtensionStageObject]; export interface AccessPackageDynamicApprovalStage extends ApprovalStage, Parsable { /** * The customExtension property */ customExtension?: CustomCalloutExtension | null; } export interface AccessPackageLocalizedContent extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The fallback string, which is used when a requested localization isn't available. Required. */ defaultText?: string | null; /** * Content represented in a format for a specific locale. */ localizedTexts?: AccessPackageLocalizedText[] | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessPackageLocalizedText extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The ISO code for the intended language. Required. */ languageCode?: string | null; /** * The OdataType property */ odataType?: string | null; /** * The text in the specific language. Required. */ text?: string | null; } export interface AccessPackageMultipleChoiceQuestion extends AccessPackageQuestion, Parsable { /** * Indicates whether requestor can select multiple choices as their answer. */ allowsMultipleSelection?: boolean | null; /** * List of answer choices. */ choices?: AccessPackageAnswerChoice[] | null; } export interface AccessPackageNotificationSettings extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * Indicates if notification emails for an access package are disabled within an access package assignment policy. */ isAssignmentNotificationDisabled?: boolean | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessPackageQuestion extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * ID of the question. */ id?: string | null; /** * Specifies whether the requestor is allowed to edit answers to questions. */ isAnswerEditable?: boolean | null; /** * Whether the requestor is required to supply an answer or not. */ isRequired?: boolean | null; /** * The OdataType property */ odataType?: string | null; /** * Relative position of this question when displaying a list of questions to the requestor. */ sequence?: number | null; /** * The text of the question to show to the requestor. */ text?: AccessPackageLocalizedContent | null; } export interface AccessPackageRequestApprovalStageCallbackConfiguration extends CustomExtensionCallbackConfiguration, Parsable { } export interface AccessPackageResource extends Entity, Parsable { /** * Contains the environment information for the resource. This environment can be set using either the @odata.bind annotation or the environment's originId. Supports $expand. */ accessPackageResourceEnvironment?: AccessPackageResourceEnvironment | null; /** * Read-only. Nullable. Supports $expand. */ accessPackageResourceRoles?: AccessPackageResourceRole[] | null; /** * Read-only. Nullable. Supports $expand. */ accessPackageResourceScopes?: AccessPackageResourceScope[] | null; /** * The name of the user or application that first added this resource. Read-only. */ addedBy?: string | null; /** * 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. Read-only. */ addedOn?: Date | null; /** * Contains information about the attributes to be collected from the requestor and sent to the resource application. */ attributes?: AccessPackageResourceAttribute[] | null; /** * A description for the resource. */ description?: string | null; /** * The display name of the resource, such as the application name, group name, or site name. */ displayName?: string | null; /** * True if the resource is not yet available for assignment. Read-only. */ isPendingOnboarding?: boolean | null; /** * The unique identifier of the resource in the origin system. In the case of a Microsoft Entra group, originId is the identifier of the group. Supports $filter (eq). */ originId?: string | null; /** * The type of the resource in the origin system, such as SharePointOnline, AadApplication, or AadGroup. Supports $filter (eq). */ originSystem?: string | null; /** * The type of the resource, such as Application if it is a Microsoft Entra connected application, or SharePoint Online Site for a SharePoint Online site. */ resourceType?: string | null; /** * A unique resource locator for the resource, such as the URL for signing a user into an application. */ url?: string | null; } export interface AccessPackageResourceAttribute extends AdditionalDataHolder, BackedModel, Parsable { /** * Information about how to set the attribute, currently a accessPackageUserDirectoryAttributeStore object type. */ attributeDestination?: AccessPackageResourceAttributeDestination | null; /** * The name of the attribute in the end system. If the destination is accessPackageUserDirectoryAttributeStore, then a user property such as jobTitle or a directory schema extension for the user object type, such as extension2b676109c7c74ae2b41549205f1947edpersonalTitle. */ attributeName?: string | null; /** * Information about how to populate the attribute value when an accessPackageAssignmentRequest is being fulfilled, currently a accessPackageResourceAttributeQuestion object type. */ attributeSource?: AccessPackageResourceAttributeSource | null; /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * Unique identifier for the attribute on the access package resource. Read-only. */ id?: string | null; /** * Specifies whether or not an existing attribute value can be edited by the requester. */ isEditable?: boolean | null; /** * Specifies whether the attribute will remain in the end system after an assignment ends. */ isPersistedOnAssignmentRemoval?: boolean | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessPackageResourceAttributeDestination extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessPackageResourceAttributeQuestion extends AccessPackageResourceAttributeSource, Parsable { /** * The question asked in order to get the value of the attribute */ question?: AccessPackageQuestion | null; } export interface AccessPackageResourceAttributeSource extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessPackageResourceCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageResource[] | null; } export interface AccessPackageResourceEnvironment extends Entity, Parsable { /** * Read-only. Required. */ accessPackageResources?: AccessPackageResource[] | null; /** * Connection information of an environment used to connect to a resource. */ connectionInfo?: ConnectionInfo | null; /** * The display name of the user that created this object. */ createdBy?: string | null; /** * The date and time that this object was created. The DateTimeOffset 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. */ createdDateTime?: Date | null; /** * The description of this object. */ description?: string | null; /** * The display name of this object. */ displayName?: string | null; /** * Determines whether this is default environment or not. It is set to true for all static origin systems, such as Microsoft Entra groups and Microsoft Entra Applications. */ isDefaultEnvironment?: boolean | null; /** * The display name of the entity that last modified this object. */ modifiedBy?: string | null; /** * The date and time that this object was last modified. The DateTimeOffset 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. */ modifiedDateTime?: Date | null; /** * The unique identifier of this environment in the origin system. */ originId?: string | null; /** * The type of the resource in the origin system, that is, SharePointOnline. Requires $filter (eq). */ originSystem?: string | null; } export interface AccessPackageResourceEnvironmentCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageResourceEnvironment[] | null; } export interface AccessPackageResourceRequest extends Entity, Parsable { /** * The accessPackageResource property */ accessPackageResource?: AccessPackageResource | null; /** * The unique ID of the access package catalog. */ catalogId?: string | null; /** * The executeImmediately property */ executeImmediately?: boolean | null; /** * 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 */ expirationDateTime?: Date | null; /** * If set, doesn't add the resource. */ isValidationOnly?: boolean | null; /** * The requestor's justification for adding or removing the resource. */ justification?: string | null; /** * Read-only. Nullable. Supports $expand. */ requestor?: AccessPackageSubject | null; /** * The outcome of whether the service was able to add the resource to the catalog. The value is Delivered if the resource was added or removed. Read-Only. */ requestState?: string | null; /** * The requestStatus property */ requestStatus?: string | null; /** * Use AdminAdd to add a resource, if the caller is an administrator or resource owner, AdminUpdate to update a resource, or AdminRemove to remove a resource. */ requestType?: string | null; } export interface AccessPackageResourceRequestCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageResourceRequest[] | null; } export interface AccessPackageResourceRole extends Entity, Parsable { /** * The accessPackageResource property */ accessPackageResource?: AccessPackageResource | null; /** * A description for the resource role. */ description?: string | null; /** * The display name of the resource role such as the role defined by the application. */ displayName?: string | null; /** * The unique identifier of the resource role in the origin system. For a SharePoint Online site, the originId is the sequence number of the role in the site. */ originId?: string | null; /** * The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. */ originSystem?: string | null; } export interface AccessPackageResourceRoleCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageResourceRole[] | null; } export interface AccessPackageResourceRoleScope extends Entity, Parsable { /** * Read-only. Nullable. Supports $expand. */ accessPackageResourceRole?: AccessPackageResourceRole | null; /** * The accessPackageResourceScope property */ accessPackageResourceScope?: AccessPackageResourceScope | null; /** * The createdBy property */ createdBy?: string | null; /** * 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 */ createdDateTime?: Date | null; /** * The modifiedBy property */ modifiedBy?: string | null; /** * 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 */ modifiedDateTime?: Date | null; } export interface AccessPackageResourceRoleScopeCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageResourceRoleScope[] | null; } export interface AccessPackageResourceScope extends Entity, Parsable { /** * The accessPackageResource property */ accessPackageResource?: AccessPackageResource | null; /** * The description of the scope. */ description?: string | null; /** * The display name of the scope. */ displayName?: string | null; /** * True if the scopes are arranged in a hierarchy and this is the top or root scope of the resource. */ isRootScope?: boolean | null; /** * The unique identifier for the scope in the resource as defined in the origin system. */ originId?: string | null; /** * The origin system for the scope. */ originSystem?: string | null; /** * The origin system for the role, if different. */ roleOriginId?: string | null; /** * A resource locator for the scope. */ url?: string | null; } export interface AccessPackageResourceScopeCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageResourceScope[] | null; } export interface AccessPackageSubject extends Entity, Parsable { /** * Not Supported. */ altSecId?: string | null; /** * The date and time the subject is marked to be blocked from sign in or deleted. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. */ cleanupScheduledDateTime?: Date | null; /** * The connected organization of the subject. Read-only. Nullable. */ connectedOrganization?: ConnectedOrganization | null; /** * The identifier of the connected organization of the subject. */ connectedOrganizationId?: string | null; /** * The display name of the subject. */ displayName?: string | null; /** * The email address of the subject. */ email?: string | null; /** * The object identifier of the subject. null if the subject isn't yet a user in the tenant. Alternate key. */ objectId?: string | null; /** * A string representation of the principal's security identifier, if known, or null if the subject doesn't have a security identifier. */ onPremisesSecurityIdentifier?: string | null; /** * The principal name, if known, of the subject. */ principalName?: string | null; /** * The lifecycle of the subject user, if a guest. The possible values are: notDefined, notGoverned, governed, unknownFutureValue. */ subjectLifecycle?: AccessPackageSubjectLifecycle | null; /** * The resource type of the subject. */ type?: string | null; } export interface AccessPackageSubjectCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessPackageSubject[] | null; } export type AccessPackageSubjectLifecycle = (typeof AccessPackageSubjectLifecycleObject)[keyof typeof AccessPackageSubjectLifecycleObject]; export interface AccessPackageTextInputQuestion extends AccessPackageQuestion, Parsable { /** * Indicates whether the answer will be in single or multiple line format. */ isSingleLineQuestion?: boolean | null; /** * The regex pattern that the corresponding text answer must follow. */ regexPattern?: string | null; } export interface AccessPackageUserDirectoryAttributeStore extends AccessPackageResourceAttributeDestination, Parsable { } export interface AccessReview extends Entity, Parsable { /** * The business flow template identifier. Required on create. This value is case sensitive. */ businessFlowTemplateId?: string | null; /** * The user who created this review. */ createdBy?: UserIdentity | null; /** * The collection of decisions for this access review. */ decisions?: AccessReviewDecision[] | null; /** * The description provided by the access review creator, to show to the reviewers. */ description?: string | null; /** * The access review name. Required on create. */ displayName?: string | null; /** * The DateTime when the review is scheduled to end. This must be at least one day later than the start date. Required on create. */ endDateTime?: Date | null; /** * The collection of access reviews instances past, present, and future, if this object is a recurring access review. */ instances?: AccessReview[] | null; /** * The collection of decisions for the caller, if the caller is a reviewer. */ myDecisions?: AccessReviewDecision[] | null; /** * The object for which the access review is reviewing the access rights assignments. This identity can be the group for the review of memberships of users in a group, or the app for a review of assignments of users to an application. Required on create. */ reviewedEntity?: Identity | null; /** * The collection of reviewers for an access review, if access review reviewerType is of type delegated. */ reviewers?: AccessReviewReviewer[] | null; /** * The relationship type of reviewer to the target object, one of: self, delegated, entityOwners. Required on create. */ reviewerType?: string | null; /** * The settings of an accessReview, see type definition below. */ settings?: AccessReviewSettings | null; /** * The date and time when the review is scheduled to be start. This date can be in the future. Required on create. */ startDateTime?: Date | null; /** * This read-only field specifies the status of an accessReview. The typical states include Initializing, NotStarted, Starting,InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. */ status?: string | null; } export interface AccessReviewApplyAction extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The OdataType property */ odataType?: string | null; } export interface AccessReviewCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessReview[] | null; } export interface AccessReviewDecision extends Entity, Parsable { /** * The feature- generated recommendation shown to the reviewer, one of: Approve, Deny, NotAvailable. */ accessRecommendation?: string | null; /** * The feature-generated ID of the access review. */ accessReviewId?: string | null; /** * When the review completes, if the results were manually applied, the user identity of the user who applied the decision. If the review was autoapplied, the userPrincipalName is empty. */ appliedBy?: UserIdentity | null; /** * The date and time when the review decision was applied. */ appliedDateTime?: Date | null; /** * The outcome of applying the decision, one of: NotApplied, Success, Failed, NotFound, NotSupported. */ applyResult?: string | null; /** * The reviewer's business justification, if supplied. */ justification?: string | null; /** * The identity of the reviewer. If the recommendation was used as the review, the userPrincipalName is empty. */ reviewedBy?: UserIdentity | null; /** * The reviewedDateTime property */ reviewedDateTime?: Date | null; /** * The result of the review, one of NotReviewed, Deny, DontKnow or Approve. */ reviewResult?: string | null; } export interface AccessReviewDecisionCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable { /** * The value property */ value?: AccessReviewDecision[] | null; } export interface AccessReviewError extends GenericError, Parsable { } export type AccessReviewHistoryDecisionFilter = (typeof AccessReviewHistoryDecisionFilterObject)[keyof typeof AccessReviewHistoryDecisionFilterObject]; export interface AccessReviewHistoryDefinition extends Entity, Parsable { /** * The createdBy property */ createdBy?: UserIdentity | null; /** * Timestamp when the access review definition was created. */ cre