Virima API

Home
Commons
Constructs
Error Codes
Tester

SERVICES
CertificateManagementService
AgentResourceMonitor
AndroidService
AnnouncementService
AssetLicenseEntitlementService
ConsumableService
HardwareAssetService
OtherAssetService
SoftwareLicenseAssetService
StockRoomService
StockRoomTypeService
UserLicenseEntitlementService
AuditRecordService
BSMService
AvailabilityService
CommitmentScheduleService
OutagesService
OutScopeService
BusinessService
ServiceCommitment
ServiceOffering
InScopeService
ChangeAttributeService
ChangeApprovalServices
CherwellIntegrationService
CmdbAuditService
CMDBCIRelationship
CMDBCIVersion
CMDBCIService
CommentService
CommonService
ConfigurationServices
ContractService
CorrelationService
CostCenterService
CredentialService
CustomerService
CustomizedColumnsService
CyberArkService
DemandService
DesignationService
DevOpsService
DiscoveryService
DiscoveryMonitoringProfileService
DiscoveryClientService
DiscoveryPattern
DiscoveryScanService
DiscoveryScanSplitService
Document
DuplicatesAndRemediation
EMEmailService
EventService
ExternalAlertService
FederationService
FileService
FinanceService
GetRecordService
GroupProbeService
HelpDeskDashboardService
HomePageService
ImportCIService
ImportITILService
IncidentService
PriorityService
TimescaleService
IncidentAttributeService
InfoBloxService
AssetsAuditService
ITILMetricService
ITSMChangeService
ITSMTicketMgtService
IvantiIntegrationService
JiraIntegrationService
KnowledgeAttributeService
KnowledgeManagementService
LocationService
LoginService
MajorSoftwareService
MFAService
MMCCertificateService
OwnerService
PreprocessorService
PurchaseOrderService
PurchaseOrderLineItemService
ReceivingSlipService
ReceivingSlipsLineService
RequestItemService
RequestProcurementService
TransferOrderService
ProbeService
ProblemService
ProblemAttributeService
ProcessNetworkConnections
ProcessjobsService
ProgramService
ProjectService
PropertyGroupService
ReleaseManagementService
ReportDashBoardService
ReportingService
ReportingClauseService
ReportingOrderService
ReportPresentationService
RequestService
RequestAttributeService
AssessmentMasterAndQuestionService
RiskMangaementService
RoleAccessService
RuleService
RunBookService
SAMLService
SampleService
ScanService
SDPService
SearchService
SensorService
ServiceCatalog
ServiceNowMappingService
ServiceNowRecordService
SLAService
SoftwareMetricsService
ImportSpiceWorkTicketsService
SurveyMastersAndQuestions
TagService
TaskService
TaskTimeTrackingService
TimeTrackingExportService
TimeTrackingService
UCFADService
UnfuddleService
UserDepartmentService
UserGroupService
UserRoleService
UserService
VCenterHeirarchyService
VCenterTagsService
VendorService
WorkflowService
MenuService

Virima API Specification - MFAService Services

The requests documented in this section are directed to MFAService resources, which represent .

Contents

1 generateOTP POST Interface
2 verifyOTP POST Interface
3 generateSecretKey POST Interface

generateOTP POST Interface

Method: POST

Relative URL: mfa/generate-otp

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
mfa	MFA

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GENERATEOTP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "mfaEmail":"?",
   "otpEmail":"?",
   "mfaOTP":"?",
   "mfaResendOTP":"?",
   "mfaCustomerId":"?",
   "mfaType":"?",
   "mfaUserName":"?",
   "mfaToken":"?",
   "userId":"?",
   "mfaTwoFactorSecretKey":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

verifyOTP POST Interface

Method: POST

Relative URL: mfa/verify-otp

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
mfa	MFA

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

VERIFYOTP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "mfaEmail":"?",
   "otpEmail":"?",
   "mfaOTP":"?",
   "mfaResendOTP":"?",
   "mfaCustomerId":"?",
   "mfaType":"?",
   "mfaUserName":"?",
   "mfaToken":"?",
   "userId":"?",
   "mfaTwoFactorSecretKey":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

generateSecretKey POST Interface

Method: POST

Relative URL: mfa/generate-secret-key

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
mfa	MFA

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GENERATESECRETKEY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "mfaEmail":"?",
   "otpEmail":"?",
   "mfaOTP":"?",
   "mfaResendOTP":"?",
   "mfaCustomerId":"?",
   "mfaType":"?",
   "mfaUserName":"?",
   "mfaToken":"?",
   "userId":"?",
   "mfaTwoFactorSecretKey":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}