@microsoft/msgraph-sdk
Version:
Microsoft Graph JavaScript client library
1,179 lines • 5.45 MB
TypeScript
import { type CallRecord } from './callRecords/index.js';
import { type LifecycleWorkflowsContainer, type Workflow } from './identityGovernance/index.js';
import { type Billing } from './partners/billing/index.js';
import { type Acronym, type Bookmark, type Qna } from './search/index.js';
import { BehaviorDuringRetentionPeriod, type CasesRoot, type IdentityContainer as I2b88f0c27d7fd9c000e7e4e78cc3161590db07c518949b504f8a27680ed1200f, type Incident, type LabelsRoot, type ThreatIntelligence, type TriggersRoot, type TriggerTypesRoot } from './security/index.js';
import { type Set, type Store, type Term } from './termStore/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 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 userId property
*/
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 {
/**
* The access packages that are incompatible with this package. Read-only.
*/
accessPackagesIncompatibleWith?: AccessPackage[] | null;
/**
* Read-only. Nullable. Supports $expand.
*/
assignmentPolicies?: AccessPackageAssignmentPolicy[] | null;
/**
* Required when creating the access package. Read-only. Nullable.
*/
catalog?: AccessPackageCatalog | 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;
/**
* Required. 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;
/**
* 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 resource roles and scopes in this access package.
*/
resourceRoleScopes?: AccessPackageResourceRoleScope[] | null;
}
export interface AccessPackageAnswer extends AdditionalDataHolder, BackedModel, Parsable {
/**
* The answeredQuestion property
*/
answeredQuestion?: AccessPackageQuestion | null;
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* The localized display value shown to the requestor and approvers.
*/
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 text of the answer choice represented in a format for a specific locale.
*/
localizations?: AccessPackageLocalizedText[] | null;
/**
* The OdataType property
*/
odataType?: string | null;
/**
* The string to display for this answer; if an Accept-Language header is provided, and there is a matching localization in localizations, this string will be the matching localized string; otherwise, this string remains as the default non-localized string. Required.
*/
text?: 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. Supports $filter (eq) on the id property and $expand query parameters.
*/
assignmentPolicy?: AccessPackageAssignmentPolicy | 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. Read-only.
*/
expiredDateTime?: Date | null;
/**
* When the access assignment is to be in place. Read-only.
*/
schedule?: EntitlementManagementSchedule | null;
/**
* The state of the access package assignment. The possible values are: delivering, partiallyDelivered, delivered, expired, deliveryFailed, unknownFutureValue. Read-only. Supports $filter (eq).
*/
state?: AccessPackageAssignmentState | null;
/**
* More information about the assignment lifecycle. Possible values include Delivering, Delivered, AutoAssignmentInGracePeriod, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only.
*/
status?: string | null;
/**
* The subject of the access package assignment. Read-only. Nullable. Supports $expand. Supports $filter (eq) on objectId.
*/
target?: AccessPackageSubject | null;
}
export interface AccessPackageAssignmentApprovalSettings extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* If false, then approval isn't required for new requests in this policy.
*/
isApprovalRequiredForAdd?: boolean | null;
/**
* If false, then approval isn't required for updates to requests in this policy.
*/
isApprovalRequiredForUpdate?: boolean | null;
/**
* If false, then requestor justification isn't required for updates to requests in this policy.
*/
isRequestorJustificationRequired?: boolean | null;
/**
* The OdataType property
*/
odataType?: string | null;
/**
* If approval is required, the one, two or three elements of this collection define each of the stages of approval. An empty array is present if no approval is required.
*/
stages?: AccessPackageApprovalStage[] | null;
}
export interface AccessPackageAssignmentCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackageAssignment[] | null;
}
export interface AccessPackageAssignmentPolicy extends Entity, Parsable {
/**
* Access package containing this policy. Read-only. Supports $expand.
*/
accessPackage?: AccessPackage | null;
/**
* Principals that can be assigned the access package through this policy. The possible values are: notSpecified, specificDirectoryUsers, specificConnectedOrganizationUsers, specificDirectoryServicePrincipals, allMemberUsers, allDirectoryUsers, allDirectoryServicePrincipals, allConfiguredConnectedOrganizationUsers, allExternalUsers, unknownFutureValue.
*/
allowedTargetScope?: AllowedTargetScope | null;
/**
* This property is only present for an auto assignment policy; if absent, this is a request-based policy.
*/
automaticRequestSettings?: AccessPackageAutomaticRequestSettings | null;
/**
* Catalog of the access package containing this policy. Read-only.
*/
catalog?: AccessPackageCatalog | 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.
*/
customExtensionStageSettings?: CustomExtensionStageSetting[] | null;
/**
* The description of the policy.
*/
description?: string | null;
/**
* The display name of the policy.
*/
displayName?: string | null;
/**
* The expiration date for assignments created in this policy.
*/
expiration?: ExpirationPattern | 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;
/**
* The notificationSettings property
*/
notificationSettings?: AccessPackageNotificationSettings | null;
/**
* Questions that are posed to the requestor.
*/
questions?: AccessPackageQuestion[] | null;
/**
* Specifies the settings for approval of requests for an access package assignment through this policy. For example, if approval is required for new requests.
*/
requestApprovalSettings?: AccessPackageAssignmentApprovalSettings | null;
/**
* Provides additional settings to select who can create a request for an access package assignment through this policy, and what they can include in their request.
*/
requestorSettings?: AccessPackageAssignmentRequestorSettings | null;
/**
* Settings for access reviews of assignments through this policy.
*/
reviewSettings?: AccessPackageAssignmentReviewSettings | null;
/**
* The principals that can be assigned access from an access package through this policy.
*/
specificAllowedTargets?: SubjectSet[] | 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;
/**
* Answers provided by the requestor to accessPackageQuestions asked of them at the time of request.
*/
answers?: AccessPackageAnswer[] | null;
/**
* For a requestType of userAdd or adminAdd, this is an access package assignment requested to be created. For a requestType of userRemove, adminRemove or systemRemove, this has the id property of an existing assignment to be removed. Supports $expand.
*/
assignment?: AccessPackageAssignment | 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.
*/
completedDateTime?: 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. Supports $filter.
*/
createdDateTime?: Date | null;
/**
* Information about all the custom extension calls that were made during the access package assignment workflow.
*/
customExtensionCalloutInstances?: CustomExtensionCalloutInstance[] | 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;
/**
* The type of the request. The possible values are: notSpecified, userAdd, UserExtend, userUpdate, userRemove, adminAdd, adminUpdate, adminRemove, systemAdd, systemUpdate, systemRemove, onBehalfAdd (not supported), unknownFutureValue. Requests from the user have a requestType of userAdd, userUpdate, or userRemove. This property can't be changed once set.
*/
requestType?: AccessPackageRequestType | null;
/**
* The range of dates that access is to be assigned to the requestor. This property can't be changed once set, but a new schedule for an assignment can be included in another userUpdate or UserExtend or adminUpdate assignment request.
*/
schedule?: EntitlementManagementSchedule | null;
/**
* The state of the request. The possible values are: submitted, pendingApproval, delivering, delivered, deliveryFailed, denied, scheduled, canceled, partiallyDelivered, unknownFutureValue. Read-only. Supports $filter (eq).
*/
state?: AccessPackageRequestState | null;
/**
* More information on the request processing status. Read-only.
*/
status?: string | 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 AccessPackageAssignmentRequestorSettings extends AdditionalDataHolder, BackedModel, Parsable {
/**
* False indicates that the requestor isn't permitted to include a schedule in their request.
*/
allowCustomAssignmentSchedule?: boolean | null;
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* True allows on-behalf-of requestors to create a request to add access for another principal.
*/
enableOnBehalfRequestorsToAddAccess?: boolean | null;
/**
* True allows on-behalf-of requestors to create a request to remove access for another principal.
*/
enableOnBehalfRequestorsToRemoveAccess?: boolean | null;
/**
* True allows on-behalf-of requestors to create a request to update access for another principal.
*/
enableOnBehalfRequestorsToUpdateAccess?: boolean | null;
/**
* True allows requestors to create a request to add access for themselves.
*/
enableTargetsToSelfAddAccess?: boolean | null;
/**
* True allows requestors to create a request to remove their access.
*/
enableTargetsToSelfRemoveAccess?: boolean | null;
/**
* True allows requestors to create a request to update their access.
*/
enableTargetsToSelfUpdateAccess?: boolean | null;
/**
* The OdataType property
*/
odataType?: string | null;
/**
* The principals who can request on-behalf-of others.
*/
onBehalfRequestors?: SubjectSet[] | null;
}
export interface AccessPackageAssignmentRequestRequirements extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Indicates whether the requestor is allowed to set a custom schedule.
*/
allowCustomAssignmentSchedule?: boolean | null;
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* Indicates whether a request to add must be approved by an approver.
*/
isApprovalRequiredForAdd?: boolean | null;
/**
* Indicates whether a request to update must be approved by an approver.
*/
isApprovalRequiredForUpdate?: boolean | null;
/**
* Indicates whether requestors must justify requesting access to an access package.
*/
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;
/**
* The questions property
*/
questions?: AccessPackageQuestion[] | null;
/**
* Schedule restrictions enforced, if any.
*/
schedule?: EntitlementManagementSchedule | 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 AccessPackageAssignmentReviewSettings extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* The default decision to apply if the access is not reviewed. The possible values are: keepAccess, removeAccess, acceptAccessRecommendation, unknownFutureValue.
*/
expirationBehavior?: AccessReviewExpirationBehavior | null;
/**
* This collection specifies the users who will be the fallback reviewers when the primary reviewers don't respond.
*/
fallbackReviewers?: SubjectSet[] | null;
/**
* If true, access reviews are required for assignments through this policy.
*/
isEnabled?: boolean | null;
/**
* Specifies whether to display recommendations to the reviewer. The default value is true.
*/
isRecommendationEnabled?: boolean | null;
/**
* Specifies whether the reviewer must provide justification for the approval. The default value is true.
*/
isReviewerJustificationRequired?: boolean | null;
/**
* Specifies whether the principals can review their own assignments.
*/
isSelfReview?: boolean | null;
/**
* The OdataType property
*/
odataType?: string | null;
/**
* This collection specifies the users or group of users who will review the access package assignments.
*/
primaryReviewers?: SubjectSet[] | null;
/**
* When the first review should start and how often it should recur.
*/
schedule?: EntitlementManagementSchedule | null;
}
export type AccessPackageAssignmentState = (typeof AccessPackageAssignmentStateObject)[keyof typeof AccessPackageAssignmentStateObject];
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 AccessPackageAutomaticRequestSettings extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* The duration for which access must be retained before the target's access is revoked once they leave the allowed target scope.
*/
gracePeriodBeforeAccessRemoval?: Duration | null;
/**
* The OdataType property
*/
odataType?: string | null;
/**
* Indicates whether automatic assignment must be removed for targets who move out of the allowed target scope.
*/
removeAccessWhenTargetLeavesAllowedTargets?: boolean | null;
/**
* If set to true, automatic assignments will be created for targets in the allowed target scope.
*/
requestAccessForAllowedTargets?: boolean | null;
}
export interface AccessPackageCatalog extends Entity, Parsable {
/**
* The access packages in this catalog. Read-only. Nullable.
*/
accessPackages?: AccessPackage[] | null;
/**
* Whether the catalog is created by a user or entitlement management. The possible values are: userManaged, serviceDefault, serviceManaged, unknownFutureValue.
*/
catalogType?: AccessPackageCatalogType | 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 customWorkflowExtensions property
*/
customWorkflowExtensions?: CustomCalloutExtension[] | null;
/**
* The description of the access package catalog.
*/
description?: string | null;
/**
* The display name of the access package catalog.
*/
displayName?: string | null;
/**
* Whether the access packages in this catalog can be requested by users outside of the tenant.
*/
isExternallyVisible?: 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. Read-only.
*/
modifiedDateTime?: Date | null;
/**
* The resourceRoles property
*/
resourceRoles?: AccessPackageResourceRole[] | null;
/**
* Access package resources in this catalog.
*/
resources?: AccessPackageResource[] | null;
/**
* The resourceScopes property
*/
resourceScopes?: AccessPackageResourceScope[] | null;
/**
* Has the value published if the access packages are available for management. The possible values are: unpublished, published, unknownFutureValue.
*/
state?: AccessPackageCatalogState | null;
}
export interface AccessPackageCatalogCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackageCatalog[] | null;
}
export type AccessPackageCatalogState = (typeof AccessPackageCatalogStateObject)[keyof typeof AccessPackageCatalogStateObject];
export type AccessPackageCatalogType = (typeof AccessPackageCatalogTypeObject)[keyof typeof AccessPackageCatalogTypeObject];
export interface AccessPackageCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackage[] | null;
}
export type AccessPackageCustomExtensionStage = (typeof AccessPackageCustomExtensionStageObject)[keyof typeof AccessPackageCustomExtensionStageObject];
export type AccessPackageExternalUserLifecycleAction = (typeof AccessPackageExternalUserLifecycleActionObject)[keyof typeof AccessPackageExternalUserLifecycleActionObject];
export interface AccessPackageLocalizedText extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* The language code that text is in. For example, 'en-us'. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2. Required.
*/
languageCode?: string | null;
/**
* The OdataType property
*/
odataType?: string | null;
/**
* The question in the specific language. Required.
*/
text?: string | null;
}
export interface AccessPackageMultipleChoiceQuestion extends AccessPackageQuestion, Parsable {
/**
* List of answer choices.
*/
choices?: AccessPackageAnswerChoice[] | null;
/**
* Indicates whether requestor can select multiple choices as their answer.
*/
isMultipleSelectionAllowed?: boolean | 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 Entity, Parsable {
/**
* Specifies whether the requestor is allowed to edit answers to questions for an assignment by posting an update to accessPackageAssignmentRequest.
*/
isAnswerEditable?: boolean | null;
/**
* Whether the requestor is required to supply an answer or not.
*/
isRequired?: boolean | null;
/**
* The text of the question represented in a format for a specific locale.
*/
localizations?: AccessPackageLocalizedText[] | 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?: string | null;
}
export interface AccessPackageQuestionCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackageQuestion[] | null;
}
export type AccessPackageRequestState = (typeof AccessPackageRequestStateObject)[keyof typeof AccessPackageRequestStateObject];
export type AccessPackageRequestType = (typeof AccessPackageRequestTypeObject)[keyof typeof AccessPackageRequestTypeObject];
export interface AccessPackageResource extends Entity, Parsable {
/**
* Contains information about the attributes to be collected from the requestor and sent to the resource application.
*/
attributes?: AccessPackageResourceAttribute[] | 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;
/**
* 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;
/**
* Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
*/
environment?: AccessPackageResourceEnvironment | 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 unique identifier of the resource in the origin system. For a Microsoft Entra group, this is the identifier of the group.
*/
originId?: string | null;
/**
* The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup.
*/
originSystem?: string | null;
/**
* Read-only. Nullable. Supports $expand.
*/
roles?: AccessPackageResourceRole[] | null;
/**
* Read-only. Nullable. Supports $expand.
*/
scopes?: AccessPackageResourceScope[] | null;
}
export interface AccessPackageResourceAttribute extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* Information about how to set the attribute, currently a accessPackageUserDirectoryAttributeStore type.
*/
destination?: AccessPackageResourceAttributeDestination | null;
/**
* The isEditable property
*/
isEditable?: boolean | null;
/**
* The isPersistedOnAssignmentRemoval property
*/
isPersistedOnAssignmentRemoval?: boolean | 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.
*/
name?: string | null;
/**
* The OdataType property
*/
odataType?: string | null;
/**
* Information about how to populate the attribute value when an accessPackageAssignmentRequest is being fulfilled, currently a accessPackageResourceAttributeQuestion type.
*/
source?: AccessPackageResourceAttributeSource | 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 property
*/
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 {
/**
* Connection information of an environment used to connect to a resource.
*/
connectionInfo?: ConnectionInfo | 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 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;
/**
* Read-only. Required.
*/
resources?: AccessPackageResource[] | null;
}
export interface AccessPackageResourceEnvironmentCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackageResourceEnvironment[] | null;
}
export interface AccessPackageResourceRequest extends Entity, Parsable {
/**
* The catalog property
*/
catalog?: AccessPackageCatalog | 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 type of the request. 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?: AccessPackageRequestType | null;
/**
* The resource property
*/
resource?: AccessPackageResource | 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, and deliveryFailed if it couldn't be added or removed. Read-only.
*/
state?: AccessPackageRequestState | null;
}
export interface AccessPackageResourceRequestCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackageResourceRequest[] | null;
}
export interface AccessPackageResourceRole extends Entity, Parsable {
/**
* 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;
/**
* The resource property
*/
resource?: AccessPackageResource | null;
}
export interface AccessPackageResourceRoleCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackageResourceRole[] | null;
}
export interface AccessPackageResourceRoleScope extends Entity, Parsable {
/**
* 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 role property
*/
role?: AccessPackageResourceRole | null;
/**
* The scope property
*/
scope?: AccessPackageResourceScope | null;
}
export interface AccessPackageResourceRoleScopeCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackageResourceRoleScope[] | null;
}
export interface AccessPackageResourceScope extends Entity, Parsable {
/**
* 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 resource property
*/
resource?: AccessPackageResource | null;
}
export interface AccessPackageResourceScopeCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessPackageResourceScope[] | null;
}
export interface AccessPackageSubject extends Entity, Parsable {
/**
* The connected organization of the subject. Read-only. Nullable.
*/
connectedOrganization?: ConnectedOrganization | 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.
*/
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 resource type of the subject. The possible values are: notSpecified, user, servicePrincipal, unknownFutureValue.
*/
subjectType?: AccessPackageSubjectType | null;
}
export type AccessPackageSubjectType = (typeof AccessPackageSubjectTypeObject)[keyof typeof AccessPackageSubjectTypeObject];
export interface AccessPackageTextInputQuestion extends AccessPackageQuestion, Parsable {
/**
* Indicates whether the answer is in single or multiple line format.
*/
isSingleLineQuestion?: boolean | null;
/**
* The regular expression pattern that any answer to this question must match.
*/
regexPattern?: string | null;
}
export interface AccessPackageUserDirectoryAttributeStore extends AccessPackageResourceAttributeDestination, Parsable {
}
export interface AccessReviewApplyAction extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* The OdataType property
*/
odataType?: string | null;
}
export type AccessReviewExpirationBehavior = (typeof AccessReviewExpirationBehaviorObject)[keyof typeof AccessReviewExpirationBehaviorObject];
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.
*/
createdDateTime?: Date | null;
/**
* Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions are included by default if no decisions are provided on create. Possible values are: approve, deny, dontKnow, notReviewed, and notNotified.
*/
decisions?: AccessReviewHistoryDecisionFilter[] | null;
/**
* Name for the access review history data collection. Required.
*/
displayName?: string | null;
/**
* If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that doesn't recur will have exactly one instance.
*/
instances?: AccessReviewHistoryInstance[] | null;
/**
* A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined.
*/
reviewHistoryPeriodEndDateTime?: Date | null;
/**
* A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined.
*/
reviewHistoryPeriodStartDateTime?: Date | null;
/**
* The settings for a recurring access review history definition series. Only required if reviewHistoryPeriodStartDateTime or reviewHistoryPeriodEndDateTime aren't defined. Not supported yet.
*/
scheduleSettings?: AccessReviewHistoryScheduleSettings | null;
/**
* Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.
*/
scopes?: AccessReviewScope[] | null;
/**
* Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue.
*/
status?: AccessReviewHistoryStatus | null;
}
export interface AccessReviewHistoryDefinitionCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessReviewHistoryDefinition[] | null;
}
export interface AccessReviewHistoryInstance extends Entity, Parsable {
/**
* Uri that can be used to retrieve review history data. This URI will be active for 24 hours after being generated. Required.
*/
downloadUri?: string | null;
/**
* Timestamp when this instance and associated data expires and the history is deleted. Required.
*/
expirationDateTime?: Date | null;
/**
* Timestamp when all of the available data for this instance was collected and is set after this instance's status is set to done. Required.
*/
fulfilledDateTime?: Date | null;
/**
* Timestamp reviews ending on or before this date will be included in the fetched history data.
*/
reviewHistoryPeriodEndDateTime?: Date | null;
/**
* Timestamp reviews starting on or after this date will be included in the fetched history data.
*/
reviewHistoryPeriodStartDateTime?: Date | null;
/**
* Timestamp when the instance's history data is scheduled to be generated.
*/
runDateTime?: Date | null;
/**
* Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue. Once the status has been marked as done, a link can be generated to retrieve the instance's data by calling generateDownloadUri method.
*/
status?: AccessReviewHistoryStatus | null;
}
export interface AccessReviewHistoryInstanceCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
/**
* The value property
*/
value?: AccessReviewHistoryInstance[] | null;
}
export interface AccessReviewHistoryScheduleSettings extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* The OdataType property
*/
odataType?: string | null;
/**
* The recurrence property
*/
recurrence?: PatternedRecurrence | null;
/**
* A duration string in ISO 8601 duration format specifying the lookback period of the generated review history data. For example, if a history definition is scheduled to run on the first of every month, the reportRange is P1M. In this case, on the first of every month, access review history data is collected containing only the previous month's review data. Note: Only years, months, and days ISO 8601 properties are supported. Required.
*/
reportRange?: string | null;
}
export type AccessReviewHistoryStatus = (typeof AccessReviewHistoryStatusObject)[keyof typeof AccessReviewHistoryStatusObject];
export interface AccessReviewInactiveUsersQueryScope extends AccessReviewQueryScope, Parsable {
/**
* Defines the duration of inactivity. Inactivity is based on the last sign in date of the user compared to the access review instance's start date. If this property is not specified, it's assigned the default value PT0S.
*/
inactiveDuration?: Duration | null;
}
export interface AccessReviewInstance extends Entity, Parsable {
/**
* Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.
*/
contactedReviewers?: AccessReviewReviewer[] | null;
/**
* Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.
*/
decisions?: AccessReviewInstanceDecisionItem[] | null;
/**
* DateTime when review instance is scheduled to end.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. Supports $select. Read-only.
*/
endDateTime?: Date | null;
/**
* This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user's manager does not exist. Supports $select.
*/
fallbackReviewers?: AccessReviewReviewerScope[] | null;
/**
* This collection of access review scopes is used to define who the reviewers are. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.
*/
reviewers?: AccessReviewReviewerScope[] | null;
/**
* Created based on scope and instanceEnumerationScope at the accessReviewScheduleDefinition level. Defines the scope of users reviewed in a group. Supports $select and $filter (contains only). Read-only.
*/
scope?: AccessReviewScope | null;
/**
* If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the accessReviewStageSettings on the parent accessReviewScheduleDefinition.
*/
stages?: AccessReviewStage[] | null;
/**
* DateTime when review instance is scheduled to start. May be in the future. 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:00