Data Models

This section describes the common data models used across the API endpoints.

AccessCategoryInformation

Data model used by the API endpoints.

Property	Type	Description
Rights	FileSystemRights
GenericRightClassification	GenericFileSystemRight
InheritanceFlags	InheritanceFlags
PropagationFlags	PropagationFlags
Position	uint	Position of the the current access category from left to right

AccessEntryInfo

Data model used by the API endpoints.

Property	Type	Description
Name	string
ResourceTypes	ResourceType[]
Properties	AccessEntryPropertyInfo[]

AccountActionModel

Data model used by the API endpoints.

Property	Type	Description
SupportedActions	ScenarioActionDefinitionModel[]

AccountModel

Encapsulates display information about a user (or group) account

Property	Type	Description
ResourceTypeGuid	Guid
SerializedAccountId	string
UriKey	string
DisplayName	string
Provider	TechnologyProvider
IsGroup	bool
Sid	string
Guid	Guid?
Description	string
Attributes	KeyValuePair<string, string>[]
ExtendedAttributes	KeyValuePair<string, string>[]
Children	string[]
TypeId	int

AccountModelOptions

Specifies flags that control which optional properties of <see cref="AccountModel"/> should be included.

Property	Type	Description
IncludeChildren	bool	Indicates if <see cref="AccountModel.Children"/> should be included.
IncludeProvider	bool	Indicates if <see cref="AccountModel.Provider"/> should be included.
IncludeAttributes	bool	Indicates if <see cref="AccountModel.Attributes"/> should be included.
UseRawAttributeValues	bool	Indicates if <see cref="AccountModel.Attributes"/> are used, they will be included as raw values and not translated into DisplayValue. This option must be used in conjunction with IncludeAttributes = true
ResolveAllGroups	bool	(Reserved, not activ) Resolve all user accounts of groups <para>Default = false</para>

AccountTemplateFieldModel

Encapsulates a complete account template field information

Property	Type	Description
Properties	KeyValuePair<string, string>[]

AccountTemplateInfoModel

Encapsulates account creation templates

Property	Type	Description
Id	Guid
DisplayName	string
Description	string
FullyQualifiedDomainName	string

AclEntryModel

Data model used by the API endpoints.

Property	Type	Description
PropagationAndInheritance	string
PropagationFlags	int
InheritanceFlags	int

ActionRequest

Data model used by the API endpoints.

Property	Type	Description
CurrentContext	ResourceTreeItemModel
SelectedEntries	ResourceTreeItemModel[]
FormJsonString	string
Comment	string
action	string

ActivateAccountRequestArgument

Activate or deactivate the given account

Property	Type	Description
UserAccountDn	string
MoveToRecyclingOu	bool	Indicates if the deactivated account should be moved into the recycling OU configured for this domain in 8MAN.
Comment	string
ExecutionDate	string	An optional execution date.

AppInfoVersion

Data model used by the API endpoints.

Property	Type	Description
PnServerVersion	string	Get the version of the backend 8MAN server.
ApiVersion	double	Get the version the this API.

BulkLogoutRequestEntry

Data model used by the API endpoints.

Property	Type	Description
ClientType	string
SessionString	string

ChangeResult

Encapsulates the result to be returned to the web client.

Property	Type	Description
Success	bool
Data	object
ResponseId	Guid?
ErrorDetails	ExternalInterfaceException

CockpitData

Model class encapsulating the complete data for the web cockpit page.

Property	Type	Description
AccountManageActions	ScenarioActionDefinition[]
GroupMembershipActions	ScenarioActionDefinition[]
ServiceActions	ScenarioActionDefinition[]
MyEmployees	ScenarioConfiguration
SelfServiceActions	ScenarioActionDefinition[]
RiskAssessmentResultNotifications	ScenarioInfo[]
CockpitOptions	CockpitOptions	Contains information about which options, bubbles etc. are available/visible.
MyContacts	ScenarioActionDefinition[]
GroupMembershipActionsOnContacts	ScenarioActionDefinition[]

DataImportSaveResult

Encapsulates the result of a data import save action. See <see cref="IDataImportService.Save"/>.

Property	Type	Description
Errors	Dictionary<int, string>

DataImportServiceMetaInfo

Encapsulates localized meta-information about a <see cref="IDataImportService"/>.

Property	Type	Description
Title	string
Description	string
ColumnTitles	string[]
RequiresCommentOnSave	bool	Indicates if the save action requires a comment to be submitted along with the data.

DeleteAccountArgument

Delete an account

Property	Type	Description
AccountDn	string
Comment	string
DeleteNonEmpties	bool	Indicates that non-empty groups should also be deleted
DeleteRelatedAces	bool	Indicates that all account relates aces should be removed additionally
ExecutionDate	string	An optional execution date.

DeleteScanResourcesRequest

Request model for deleting scan resources

Property	Type	Description
ResourceIds	Guid[]	Array of resource GUIDs to delete
Comment	string	Comment describing the reason for deletion
DeleteScanData	bool?	If true, also deletes scan data from database; otherwise only removes resource configuration (default: true)

EventModel

Represents a TimeLine event

Property	Type	Description
Id	long
EventTime	DateTime
Severity	int
SourceType	int
SourceId	string
EventType	int
EventId	int
Technology	int
Provider	int
Title	string
GafferMachineName	int
AffectedObjectDisplayName	string
AffectedObjectId	string
AuthorDisplayName	string
AuthorAccountId	string
AuthorAccountProvider	string
AuthorAccountType	int
Description	string

EventStatisticModel

Represents a statistic entry for a single time period

Property	Type	Description
StartTime	DateTime
Count	int

ExecuteActionParameter

MVC model for ActionExecute

Property	Type	Description
EntryId	int	The ID of the grid entry.
Parameter	string[]
GridColumnDefinitions	GridColumnDefinition[]
DynamicGridColumnDefinitions	GridColumnDefinition[]
FormDataJson	string
Comment	string
ActionId	Guid?
ParameterSingleLine	object[]
TargetParameter	string
Action	string

FilesystemEntryModel

Delivers a set of information about a filesystem resource entry.

Property	Type	Description
DisplayName	string	Displayname of the share
Description	string	Description of a share or directory
Path	string	Path of the directory or share
UriKey	string	UriKey of the directory or share
Acl	int	Access Control List Flags
ServerName	string	Name of the server where the share is hosted on
Type	string	Type of returned object: Share or Dir
Childs	List<FilesystemEntryModel>	List of child objects.
DataOwner	List<string>

FilterCategoryModel

Represents one filter category

Property	Type	Description
Id	int
DisplayName	string
PropertyName	string
FilterValues	DisplayValue[]

GridDataModel

Model class representing data to be displayed on a view with a data grid, including various display options.

Property	Type	Description
GridParameters	GridParameters
GridEntries	IGridEntry[]
DataSourceInfos	DataSourceInfos

GroupMemebershipArguments

Add and remove particular guest user to Group

Property	Type	Description
UriKey	string
GuestuserId	string
GroupAccountId	string
Comment	string
ExecutionDate	string	An optional execution date.

GroupWizardConfigurationEntry

Data model used by the API endpoints.

Property	Type	Description
UriKey	string
IsEnabled	bool
GroupStrategy	string
Categories	List<Category>
GroupConfiguration	GroupConfiguration
PathConfiguration	PathConfiguration
Format	string
DefaultOU	string

JobStatusModel

Delivers information about a job.

Property	Type	Description
Status	string	Verbose status of a job. i.E. finished, running etc.
StatusId	int
LastError	string

LdapAttributePickerFormTemplate

Form template for a UI for adding multiple LDAP attributes with values. The property <see cref="ContainerFormTemplateBase{TChildTemplates}.Templates"/> contains the chosen LDAP attributes and MUST be a subset of <see cref="AvailableAttributes"/> (modulo the respective values).

Property	Type	Description
AvailableAttributes	KeyValuePair<string, IHasValueFormTemplate>[]

LightAccountPermissionCompositionModel

Data model used by the API endpoints.

Property	Type	Description
PermissionCompositionModels	LightPermissionCompositionModel[]
Account	LightAccountModel

ModifyUserArguments

Assign and remove the Azure Active Directory user role to the guest user.

Property	Type	Description
UriKey	string
GuestuserId	string
ProviderName	string
UserPrincipalName	string
UserRoleId	string
Comment	string
ExecutionDate	string	An optional execution date.

MultipleAccountsRequestParameter

MVC model for GetMultipleAccounts

Property	Type	Description
Keys	string[]
Options	AccountModelOptions

OrderItemModel

Represents a single item in an OrderModel

Property	Type	Description
OrderItemKey	string
OrderedResource	ResourceModel
OrderStatus	OrderStatus
OrderStatusName	string	The <see cref="OrderStatus"/> as localized string.
OrderProblemStatus	OrderProblemStatus
OrderProblemStatusString	string
ChangeContextId	Guid?
ApproveHistory	ApproveHistoryEntry[]
IsInFinalApprovalState	bool
NextApprovers	string[]
ShouldSelectNextApprover	bool	Next approver must be selected from the current Approver
OrderItemLabel	string	A label for a more human being readable identification to the order item.
HasNotBeenUpdatedRecently	bool	Indicates if the last time that the item was changed is more than AuthorizationConfiguration.MaxResponseTimeDays ago and the <see cref="OrderStatus"/> is <see cref="persistedObjects.OrderStatus.Open"/>.
FinalizationDate	DateTime?

OrderModel

Represents a single order (possibly containing multiple resources in possibly multiple technologies).

Property	Type	Description
MetaKey	string
Requester	AccountModel
Grantees	AccountModel[]
RequestDateTimeString	string
RequestDate	DateTime	The creation date time of the order request
Comment	string
Resources	OrderItemModel[]

OrderPageModel

Data model used by the API endpoints.

Property	Type	Description
Orders	OrderModel[]
TotalOrders	int

OrderPreviewRequest

Data model used by the API endpoints.

Property	Type	Description
ResourceModelJsonStrings	string[]
GranteesAccountModelJsonStrings	string[]

OrdersRequestedByPageModel

Data model used by the API endpoints.

Property	Type	Description
Orders	OrderModel[]
TotalOrders	int

OrdersWaitingForPageModel

Data model used by the API endpoints.

Property	Type	Description
Orders	OrderModel[]
TotalOrders	int

PersonalAccountInformation

Data model used by the API endpoints.

Property	Type	Description
FirstnameLabel	string
Firstname	string
SurnameLabel	string
Surname	string
JobTitleLabel	string
JobTitle	string
CompanyLabel	string
Company	string
DepartmentLabel	string
Department	string
MailLabel	string
Mail	string
PhoneLabel	string
Phone	string
Photo	string

PreventionReasonModel

Data model used by the API endpoints.

Property	Type	Description
UriKey	string
PreventionReason	uint

ProfileAssignmentModel

Model class encapsulating a single profile assignment.

Property	Type	Description
ProfileId	Guid	The profile ID.
UserId	Guid	The user ID.
Fqdn	string	The FQDN of the user account.
UserName	string	The user's display name.
IsNonCompliant	bool	Indicates if the user account is non-compliant.

ProfileModel

Model class for displaying profiles.

Property	Type	Description
Id	Guid	The unique profile ID.
Name	string
Description	string
Color	int	A symbolic color, to be used for displaying purposes.
Initials	string	The initials of this profile, to be used for creating a coloured icon.
CreationDateTimeLocal	string
LastModifiedDateTimeLocal	string
Groups	AccountModel[]
LdapAttributes	KeyValuePair<string /* localized */, object>[]

PurposeGroupModel

Contains all Purpose Group information

Property	Type	Description
Identifier	string
Icon	string
AliasName	string
Description	string

RecertificationEnhancedSessionInfo

Data model used by the API endpoints.

Property	Type	Description
IsOpenSessionOutdated	bool
RecertificationCanBeExecuted	bool
EntryPointsResourceTreeArray	ResourceTree[]

RecertificationMailTypeInfo

Information about different recertification email types

Property	Type	Description
MailTypeValue	int	Numeric value of <see cref="RecertificationMailTypes"/>
EmailType	RecertificationMailTypes
IsActive	bool	Indicates if the email type is deactivated
TemplateName	string	Corresponding template name

RecertificationSession

A persisted snapshot of an FS recertification session.

Property	Type	Description
SessionInfo	RecertificationSessionInfo
Entries	RecertificationSessionEntry[]

RemoveAccountRequest

Data model used by the API endpoints.

Property	Type	Description
UriKeys	string[]
AccountIds	string[]
Comment	string

ResourceActionModel

Data model used by the API endpoints.

Property	Type	Description
UriKey	string
SupportedActions	Guid[]
AvailableActions	ScenarioActionDefinitionModel[]

ResourceKey

Private class for uniquely addressing resources using a <see cref="ResourceType"/>, a provider name and a UniqueObjectKey. See confluence glossar for detailed information <see cref="http://confluence.protected-networks.local/display/8mandev/ResourceKey" />

Property	Type	Description
ResourceType	ResourceType
ProviderName	string
UniqueObjectKey	string

ResourceModel

Data model class representing a resource that can be ordered.

Property	Type	Description
UriKey	string
ResourceType	ResourceType	The resource technology's primary key.
Name	string
ResourceTypeDescription	string
DisplayPath	string
CategoryName	string
CanBeOrdered	bool	Indicates if the resource can be ordered. (A resource may be non-orderable even though it has children that are orderable.)
HasChildren	bool	Indicates if the resource has child resources.
OrganizationId	Guid	The id of the organization from which the <see cref="ResourceModel"/> was ordered. If this model is an organization, then this is the organization ID itself.
Description	string
TemplateSummary	string
Properties	List<KeyValuePair<string, string>>
ResourceOrderFormTemplate	IFormTemplate
IsCreationalResource	bool	Indicates whether the resource represents the creation of a new object (e.g. new account creation).
HasCreationalResourceChild	bool	Indicates whether the resource has at least one child resource that is a creational resource. If true, then it is possible to browse into it even if browsing hierarchical resources is disabled in the configuration.
IconBase64	string
IsManualInteractionRequired	bool
UriKeyComparer	static IEqualityComparer<ResourceModel>

ResourceOwnerConfigurationEntryModel

Model class for web-based data owner configuration entry.

Property	Type	Description
DataOwners	AccountModel[]
ErrorMessages	string[]

ResourceOwnerConfigurationModel

Model class for web-based data owner configuration.

Property	Type	Description
EntriesByResource	Dictionary<string /* uriKey */, ResourceOwnerConfigurationEntryModel>
ResourceNodes	Dictionary<string /* uriKey*/, ResourceOwnerConfigurationResourceModel>
EntriesByTechnology	Dictionary<ResourceType, ResourceOwnerConfigurationEntryModel>
TechnologyNodes	Dictionary<ResourceType, ResourceTypeModel>
RootEntry	ResourceOwnerConfigurationEntryModel

ResourceOwnerConfigurationResourceModel

Model class for web-based data owner configuration resource (the key to which a <see cref="ResourceOwnerConfigurationEntryModel"/> is associated).

Property	Type	Description
Resource	LightResourceModel
HasChildren	bool	Indicates if the resource has children.
HasConfigurationEntry	bool	Indicates if the resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
DescendantHasConfigurationEntry	bool	Indicates if a descendant of this resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.

ResourceTreeItemModel

represents a data model to be displayed in a resource tree

Property	Type	Description
Id	string	uri Key
Name	string	display name
TypeId	int	typeIdfor icon
ResourceType	ResourceType	resourceType for icon, if applicable
Path	string	displayPath
NextReview	DateTime?	if applicable
Size	long	if applicable
DirectChildCount	int
UsersHaveAccess	int
GroupsHaveAccess	int
DataOwners	ResourceOwnerConfigurationModel[]
SidAccountId	string	SidAccountId (ResourceKey)
ResourceKeyValue	ResourceKey	Value of ResourceKey
AlertDefinitionIds	Guid[]	Alert Definition Id

ResourceTypeModel

Represents a <see cref="ResourceType"/> with a localized display name.

Property	Type	Description
DisplayName	string	Gets or sets the localized display name.
ResourceType	ResourceType
TypeId	int	Gets or sets the type ID (for displaying an icon).

RiskAssessmentDashboardResultSummary

Represents a summarized RAD scenario result.

Property	Type	Description
Score	double	The risk assessment score ranging between 0 and 100.
Count	int	The number of issues found within this scenario (e.g. the number of recursive groups).
TotalCount	int	The total number of entities to be compared against (e.g. the total number of groups).

RiskAssessmentScenarioDetails

Encapsulates the contents of the details view for a RAD scenario.

Property	Type	Description
Paragraphs	KeyValuePair<string /* title */, string /* body */>[]	A list of paragraphs with headers.
PositionOfOverallData	int	The position of the overall data (score, total counts) relative to the <see cref="Paragraphs"/>. The value must be between 0 and <see cref="Paragraphs"/>.Length, inclusively. (0 means before the first paragraph, and <see cref="Paragraphs"/>.Length means after the last paragraph.)
PositionOfDetailedData	int	The position of the detailed data (e.g. split according to providers) and diagrams. <seealso cref="PositionOfOverallData"/>

ScannableResource

Data model used by the API endpoints.

Property	Type	Description
ResourceName	abstract string
ResourceScanConfiguration	ResourceScanConfiguration
MaxParallelRequests	int
TenantId	string
Type	abstract ResourceType
HasScans	abstract bool	True, if this technology can have scans (we guess)

ScannableResourcesRequest

Request model for discovering scannable resources with credentials

Property	Type	Description
Username	string	The username for the credential
Domain	string	The system/domain name for the credential
Password	string	The password for the credential
VendorName	string	The vendor name for the credential
TechnologyId	int	The technology ID for the credential
Uri	string	Optional URI for specific resource discovery

ScenarioActionDefinition

A localized scenario-specific definition of a supported action on a <see cref="IGridEntry"/> row.

Property	Type	Description
ActionId	Guid	Uniquely refers to the supported action.
Label	string
Description	string
TypeId	int	References a <see cref="WellKnownTypeIds"/> to indicate an icon for this action
TargetObjectDisplayNameProperty	string
IsWithoutComment	bool	Indicates if this action does not require a comment to be entered.
IsDirectExecutable	bool	Indicates if this action does not require an selected elements and can be executed directly.
ActionParameterPropertyNames	string[]
NumberOfSteps	int
IsForInfoOnly	bool	Indicates if this action is only for displaying information and cannot be executed.

ScenarioConfiguration

Encapsulates configuration parameters to specify a complete customized scenario.

Property	Type	Description
DisplayName	string	The name of this customized scenario.
ScenarioId	Guid	Gets the ID of the scenario.
InputParameters	IFormTemplate
GridConfiguration	ScenarioGridConfiguration

ScenarioReportRequest

MVC model for ScenarioReportRequest

Property	Type	Description
GridDataJson	string
ReportConfiguration	ScenarioReportConfiguration
GridConfiguration	ScenarioGridConfiguration

ScenarioResultSummary

Represents a summarized scenario result, e.g. to be displayed on a tile.

Property	Type	Description
Title	string
ScenarioId	Guid	The ID of the scenario.
Text	string
SystemStatus	virtual ScenarioResultSummaryStatus	Specifies further display options (e.g. to be visualized by icons or colors).
Diagram	ScenarioDiagramElement[]

SimpleResultModel

Data model used by the API endpoints.

Property	Type	Description
Success	bool
Message	string

SuccessResult

Obsolete, please do NOT use this typ as a result for controller action. <para>In terms of REST: Use the HttpCodes 200 for a positive response and the direct data type as return type of the controller action.</para>

Property	Type	Description
success	bool
data	object

SwisNodeO365ExternalAccountDataSet

Data model used by the API endpoints.

Property	Type	Description
CreateTime	DateTime
Entries	IEnumerable<SwisNodeO365ExternalAccountEntry>

SwisNodesWideOpenShareDataSet

Data model used by the API endpoints.

Property	Type	Description
CreateTime	DateTime
Entries	IEnumerable<SwisNodesWideOpenShareEntry>

SwisRiskAssessmentEntry

Data model used by the API endpoints.

Property	Type	Description
ScenarioId	Guid
Scenario	string
Score	double	A positive numerical value representing the score of this element.
Resource	string
AffectedCount	int	Gets the count of affected items.
TotalCount	int
ResourceElementText	string

TechnologyPackageModel

Data model used by the API endpoints.

Property	Type	Description
ResourceType	ResourceType
Guid	Guid	The unique guid
Vendor	string	The unique name of the package vendor.
TechnologyId	int	The technology id is unique for the vendor and identifies the instance of this package.
Name	string	The name of the technology
Description	string	The description of the technology
IsModifySupported	bool	Determines if this technology can be modified. (<see cref="pn.technologies.interfaces.modify.ITechnologyModifyService"/> is implemented)
IsTenantSupported	bool	Determines if this technology belongs to a tenant. (<see cref="pn.technologies.interfaces.modify.ITechnologyModifyService"/> is implemented)
SystemDescription	string	Description of the system
SystemIcon16	string
SystemIcon24	string
SystemIcon48	string
DisplayName	string	The culture-dependent display name for the technology
AccountDefinitions	GenericAccountDefinitionModel[]

TechnologyProvider

Represents a technology provider, e.g. an Active Directory domain or a SharePoint server.

Property	Type	Description
TechnologyKey	string
TechnologyDisplayName	string
ProviderName	string

TemplateValidationResultModel

Encapsulates the sandbox validation result of the requested action

Property	Type	Description
Successful	bool
ValidationDetails	KeyValuePair<string, string>[]

UniquenessConstraintModel

Encapsulates the common model class for application in the Uniqueness constraint handling.

Property	Type	Description
PropertyName	string
PropertyValue	string
PropertyScope	string
OpCode	string
Context	string

WebClientConfigModel

Class which encapsulates the web client configuration former 'config.json'

Property	Type	Description
DefaultDomain	string
ShowFeedbackButton	bool	Controls the visibilty of the feedback button.
AllowTypeIdGrouping	bool
UseAppInsights	bool	Controls the usage of insights.
RequestAdminScenario	string
ADInactiveAccountsIncludesNullInactiveDays	bool
AllowSso	bool	Controls the possibility of logon with single sign-on.
RedirectSso	string
MaxSearchResults	Int32	Class for customization details.
RetainComments	bool	Maximum number of resource search results
Customization	WebClientConfigCustomizationModel	Controls if successive comment dialogues retain the value of the previous one.