Legacy and Utility APIs
Parse Creation Rules (POST)
Parses creation rules for account templates.
Route
|
URI |
/creationRule/ParseCreationRules |
|
Method |
POST |
|
Result |
JSON – ParsedCreationRulesModel |
Parameters
Body: Creation rule definitions
Example
POST http://localhost/creationRule/ParseCreationRules
Content-Type: application/json
{creation rules}
Precheck Value (GET)
Performs a precheck validation for a value.
Route
|
URI |
/api/v1/{suffix} |
|
Method |
GET |
|
Result |
JSON – varies based on suffix |
Parameters
The endpoint suffix.
Example
GET http://localhost/api/v1/precheck/validateusername
Data Models
This section describes the common data models used across the API endpoints.
CockpitData
Encapsulates the complete data for the web cockpit page.
|
Property |
Type |
Description |
|---|---|---|
|
AccountManageActions |
ScenarioActionDefinition[] |
Available actions for account management |
|
GroupMembershipActions |
ScenarioActionDefinition[] |
Available actions for group memberships |
|
ServiceActions |
ScenarioActionDefinition[] |
Available actions for services (scripts) |
|
MyEmployees |
ScenarioConfiguration |
Optional scenario for “my employees” |
|
SelfServiceActions |
ScenarioActionDefinition[] |
Actions for self service |
|
RiskAssessmentResultNotifications |
ScenarioInfo[] |
RAD scenario information |
|
CockpitOptions |
CockpitOptions |
Configuration for available options/bubbles |
|
MyContacts |
ScenarioActionDefinition[] |
Actions for contacts |
|
GroupMembershipActionsOnContacts |
ScenarioActionDefinition[] |
Membership actions for contacts |
PersonalAccountInformation
Contains personal account information for display purposes.
|
Property |
Type |
Description |
|---|---|---|
|
FirstnameLabel |
string |
Localized label for firstname |
|
Firstname |
string |
User’s first name |
|
SurnameLabel |
string |
Localized label for surname |
|
Surname |
string |
User’s surname |
|
JobTitleLabel |
string |
Localized label for job title |
|
JobTitle |
string |
User’s job title |
|
CompanyLabel |
string |
Localized label for company |
|
Company |
string |
User’s company |
|
DepartmentLabel |
string |
Localized label for department |
|
Department |
string |
User’s department |
|
MailLabel |
string |
Localized label for email |
|
|
string |
User’s email address |
|
PhoneLabel |
string |
Localized label for phone |
|
Phone |
string |
User’s phone number |
|
Photo |
string |
Photo as base64 encoded string |
AccountModel
Encapsulates display information about a user or group account.
|
Property |
Type |
Description |
|---|---|---|
|
ResourceTypeGuid |
Guid |
Technology identifier |
|
SerializedAccountId |
string |
Serialized account identifier |
|
UriKey |
string |
Unique key identifying the account |
|
DisplayName |
string |
Friendly display name (e.g., “Anna Meise”) |
|
Provider |
TechnologyProvider |
Provider of this account (optional) |
|
IsGroup |
bool |
Indicates if the account is a group |
|
Sid |
string |
Security identifier (optional) |
|
Guid |
Guid? |
Account GUID (optional) |
|
Description |
string |
Account description (optional) |
|
Attributes |
KeyValuePair<string, string>[] |
Attribute name-value mappings (optional) |
|
ExtendedAttributes |
KeyValuePair<string, string>[] |
8MAN specific attributes (optional) |
|
Children |
string[] |
Array of child account URI keys (optional) |
|
TypeId |
int |
Well-known TypeId for icons |
ResourceModel
Data model representing a resource that can be ordered.
|
Property |
Type |
Description |
|---|---|---|
|
UriKey |
string |
Resource’s primary key |
|
ResourceType |
ResourceType |
Resource technology’s primary key |
|
Name |
string |
Resource’s display name |
|
ResourceTypeDescription |
string |
Display string describing the resource type |
|
DisplayPath |
string |
Resource’s path |
|
CategoryName |
string |
Used to group resource order items |
|
CanBeOrdered |
bool |
Indicates if resource can be ordered |
|
HasChildren |
bool |
Indicates if resource has child resources |
|
OrganizationId |
Guid |
Organization from which resource was ordered |
|
Description |
string |
Optional description (e.g., “Premium mobile phone”) |
|
TemplateSummary |
string |
Localized summary of template values |
|
Properties |
List<KeyValuePair<string, string>> |
Extra information properties |
|
ResourceOrderFormTemplate |
IFormTemplate |
Parameter structure for input forms |
|
IsCreationalResource |
bool |
Indicates if resource represents new object creation |
|
HasCreationalResourceChild |
bool |
Has at least one creational child resource |
|
IconBase64 |
string |
Optional icon encoded as base64 |
|
IsManualInteractionRequired |
bool |
Requires manual interaction to finalize |
|
IsOrganization |
bool |
Indicates if object is a data owner organization |
OrderModel
Represents a single order (possibly containing multiple resources in possibly multiple technologies).
|
Property |
Type |
Description |
|---|---|---|
|
MetaKey |
string |
Key identifying the order (letters, digits, hyphens, underscores) |
|
Requester |
AccountModel |
Account info of the requester |
|
Grantees |
AccountModel[] |
Accounts for whom the order is/was requested |
|
RequestDateTimeString |
string |
Creation date time as display string in requester’s time zone |
|
RequestDate |
DateTime |
Creation date time of the order request |
|
Comment |
string |
Comment set by the requester |
|
Resources |
OrderItemModel[] |
Resources contained in the order |
OrderItemModel
Represents a single item within an order.
|
Property |
Type |
Description |
|---|---|---|
|
ResourceModel |
ResourceModel |
The ordered resource |
|
Status |
OrderItemStatus |
Current status of the order item |
|
ApprovalHistory |
ApprovalHistoryEntry[] |
History of approvals/rejections |
OrderPageModel
Paginated order results.
|
Property |
Type |
Description |
|---|---|---|
|
Orders |
OrderModel[] |
Array of orders in current page |
|
TotalOrders |
int |
Total number of orders across all pages |
ResourceActionModel
Represents available actions for a resource.
|
Property |
Type |
Description |
|---|---|---|
|
UriKey |
string |
Resource URI key |
|
SupportedActions |
Guid[] |
Array of supported action identifiers |
|
AvailableActions |
ScenarioActionDefinitionModel[] |
Array of available action definitions |
LoginCredentials
Credentials for user authentication.
|
Property |
Type |
Description |
|---|---|---|
|
username |
string |
User name |
|
password |
string |
User password |
|
domain |
string |
Domain name (optional) |
SessionModel
Represents an authenticated session.
|
Property |
Type |
Description |
|---|---|---|
|
SessionId |
string |
Unique session identifier |
|
User |
AccountModel |
Authenticated user information |
|
ExpiresAt |
DateTime |
Session expiration time |
WorkflowModel
Represents a workflow definition for approvals.
|
Property |
Type |
Description |
|---|---|---|
|
WorkflowId |
Guid |
Unique workflow identifier |
|
Name |
string |
Workflow name |
|
Description |
string |
Workflow description |
|
ApprovalSteps |
ApprovalStepModel[] |
Sequence of approval steps |
|
IsActive |
bool |
Whether workflow is active |
|
ResourceFilters |
ResourceFilterModel[] |
Filters for which resources this applies to |
ApprovalStepModel
Represents a single approval step in a workflow.
|
Property |
Type |
Description |
|---|---|---|
|
StepNumber |
int |
Order of this step in the workflow |
|
ApproverType |
string |
Type of approver (user, role, manager, data owner) |
|
ApproverIdentifier |
string |
Identifier for the approver |
|
IsRequired |
bool |
Whether approval from this step is required |
|
AllowModification |
bool |
Whether approver can modify the request |
AlertModel
Represents an alert configuration.
|
Property |
Type |
Description |
|---|---|---|
|
AlertId |
Guid |
Unique alert identifier |
|
Name |
string |
Alert name |
|
Description |
string |
Alert description |
|
AlertType |
string |
Type of alert (violation, threshold, change) |
|
IsActive |
bool |
Whether alert is active |
|
NotificationRecipients |
string[] |
Email addresses for notifications |
|
Conditions |
AlertConditionModel[] |
Conditions that trigger the alert |
|
Schedule |
AlertScheduleModel |
When to check for alert conditions |
ProfileModel
Represents a user profile definition.
|
Property |
Type |
Description |
|---|---|---|
|
ProfileId |
Guid |
Unique profile identifier |
|
Name |
string |
Profile name |
|
Description |
string |
Profile description |
|
Color |
string |
Color for visual representation |
|
Attributes |
KeyValuePair<string, string>[] |
Profile attributes |
|
Groups |
string[] |
Groups associated with this profile |
|
IsActive |
bool |
Whether profile is active |
ScenarioActionDefinitionModel
Represents an action that can be executed in a scenario.
|
Property |
Type |
Description |
|---|---|---|
|
ActionId |
Guid |
Unique action identifier |
|
Name |
string |
Action name |
|
Description |
string |
Action description |
|
Icon |
string |
Icon identifier or base64 image |
|
RequiresInput |
bool |
Whether action requires user input |
|
FormTemplate |
IFormTemplate |
Form template if input required |
RecertificationSessionModel
Represents a recertification session.
|
Property |
Type |
Description |
|---|---|---|
|
SessionId |
Guid |
Unique session identifier |
|
Name |
string |
Session name |
|
Description |
string |
Session description |
|
StartDate |
DateTime |
Session start date |
|
EndDate |
DateTime |
Session end date |
|
Status |
string |
Session status (new, in_progress, completed) |
|
ResourceType |
string |
Type of resources being recertified |
|
TotalItems |
int |
Total number of items to recertify |
|
CompletedItems |
int |
Number of completed items |
|
Reviewer |
AccountModel |
Account performing the recertification |
TechnologyPackageModel
Represents a technology package/provider.
|
Property |
Type |
Description |
|---|---|---|
|
PackageId |
Guid |
Unique package identifier |
|
Name |
string |
Package name (e.g., “Active Directory”, “SharePoint”) |
|
Description |
string |
Package description |
|
Version |
string |
Package version |
|
IsEnabled |
bool |
Whether package is enabled |
|
SupportedFeatures |
string[] |
List of supported features |
|
Icon |
string |
Icon identifier |
OrderSubmissionResult
Result of order submission.
|
Property |
Type |
Description |
|---|---|---|
|
OrderId |
Guid |
Identifier of the created order |
|
Success |
bool |
Whether submission was successful |
|
Message |
string |
Status or error message |
|
ValidationErrors |
string[] |
List of validation errors if any |
OrderApprovalResult
Result of order approval operation.
|
Property |
Type |
Description |
|---|---|---|
|
Success |
bool |
Whether approval was successful |
|
Message |
string |
Status or error message |
|
ApprovedItems |
Guid[] |
IDs of successfully approved items |
|
FailedItems |
Guid[] |
IDs of items that failed to approve |
OrderRejectionResult
Result of order rejection operation.
|
Property |
Type |
Description |
|---|---|---|
|
Success |
bool |
Whether rejection was successful |
|
Message |
string |
Status or error message |
|
RejectedItems |
Guid[] |
IDs of successfully rejected items |
|
FailedItems |
Guid[] |
IDs of items that failed to reject |
ActionExecutionResult
Result of action execution.
|
Property |
Type |
Description |
|---|---|---|
|
Success |
bool |
Whether action executed successfully |
|
Message |
string |
Result message |
|
Data |
object |
Action-specific result data |
|
Errors |
string[] |
List of errors if any |
PagedResult
Generic paginated result set.
|
Property |
Type |
Description |
|---|---|---|
|
Items |
T[] |
Items in the current page |
|
TotalCount |
int |
Total number of items across all pages |
|
PageNumber |
int |
Current page number |
|
PageSize |
int |
Number of items per page |
|
TotalPages |
int |
Total number of pages |
ErrorResponse
Standard error response model.
|
Property |
Type |
Description |
|---|---|---|
|
Message |
string |
Error message |
|
Details |
string |
Detailed error information |
|
ErrorCode |
string |
Error code identifier |
|
Timestamp |
DateTime |
When the error occurred |