NexumAPI Docs
NexumAPI Docs
  • Introduction
  • Authentication
  • Quickstart
  • NaaS Endpoints
  • Capabilities
  • Changelog
  • Links
    • NexumAPI
    • GitHub
  • Resources
    • Symitar Playground
    • Help & Feedback
  • SymXchange
    • API Reference
      • Persistent
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InformationService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
      • v2022.01
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CashMachines
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • EpisysInformationService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParameterService
          • AccountDefault
          • AccountFieldName
          • AcctLimit
          • AcctMembGrpDesc
          • AcctRelCodeDesc
          • AcctTrackingType
          • AcctTypeName
          • AcsGlobal
          • AcsService
          • ActivityFm
          • AnalysisFloat
          • AnalysisGlobal
          • AnalysisPlan
          • ApPmtTermsTablePagedList
          • ApWorkFlow
          • Atm
          • Audio
          • BatchRc
          • CardDefault
          • CardWiz
          • CashOrderVendor
          • Cdm
          • CheckOrderDefault
          • CollateralType
          • CollatrlTrackingType
          • Comment
          • ConsoleFm
          • CorpTransfer
          • CpLetter
          • CpWorkCard
          • CreditReport
          • Crs
          • CurrencyCtrl
          • DailyPost
          • DealerStatement
          • DebtRatio
          • Disclosure
          • DivIndexGlobal
          • DivIndexLocal
          • DivTable
          • DocExcpNotice
          • DocTypeDefault
          • DocumentNumber
          • EpisysDbExtract
          • EscrowAnalysis
          • EscrowType
          • ExtLoan
          • GlCategory
          • GlCode
          • GlTable
          • GlTrackingType
          • GlxLate
          • IdentIdTypeDesc
          • Imaging
          • InqDefinition
          • InsTable
          • InsType
          • Institution
          • IntIndex
          • IntType
          • InventoryCopiedFlds
          • InventoryDefault
          • InventoryFieldName
          • InventoryType
          • IrsBkupWithhold
          • IrsContriLimit
          • ItcFraud
          • ItcInstallation
          • LateChg
          • LnSegmentDefault
          • LoanAppCopiedFlds
          • LoanAppDefault
          • LoanAppDenial
          • LoanAppFieldName
          • LoanAppFormPkt
          • LoanAppMisc
          • LoanAppPrintApp
          • LoanAppReusedFlds
          • LoanAppVerForm
          • LoanAppViewApp
          • LoanAppWorkFlow
          • LoanDefault
          • LoanFieldName
          • LoanTypeIdRange
          • LookupTypeName
          • Misc
          • MoProduct
          • NameFieldName
          • Ncua5300
          • NonRegCc
          • Notice
          • OnlineBlock
          • OnlineCard
          • OnlineFee
          • OnlineFile
          • OnlineMain
          • OnlineNet
          • OnlineOutlet
          • OnlineSbAddOn
          • OnlineSba
          • OnlineSbi
          • Param360View
          • Parameter
          • PartStatement
          • PartTrackingType
          • ParticipantFieldName
          • PayCalc
          • PeriodicMtg
          • PlanDefault
          • PlanFieldName
          • PmtAppMethod
          • PositivePay
          • PreferenceDefault
          • PrivGroup
          • RegCc
          • ScreenDefinition
          • SecField
          • Security
          • ShareDefault
          • ShareFieldName
          • Statement
          • StmtMailName
          • StmtMessages
          • Stock
          • SycClient
          • SycGeneral
          • SymXClient
          • SymXDeviceMap
          • SymXGeneral
          • SymXInstance
          • SynapsysMrm
          • TcProduct
          • TellerFee
          • TellerTranFee
          • TellerTranValidate
          • Tpt
          • TrackingCode
          • UserFm
          • UserTrackingFm
          • UserTrackingType
          • Warnings
          • WdFee
          • WestUnCommCode
          • WireBfc
          • WireCorpVer
          • WireIdCode
          • WireInCmtCode
          • WireMisc
          • WireOutCmtCode
          • WireTypeCode
          • WorkFlowRepGen
          • YellowHammer
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • SymXchangeVerificationService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
    • Credentials
    • Device Information
Powered by GitBook
On this page

Was this helpful?

  1. SymXchange
  2. API Reference
  3. Persistent

EcaaService

PreviousDealerServiceNextExceptionItemService

Last updated 10 months ago

Was this helpful?

Manage the Symitar Combined Authentication and Authorization Service (ECAAS).

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTauthenticate
  • POSTauthenticateWithAuthorization
  • POSTgetPrincipals
  • POSTinitKerberosAuthentication
  • POSTauthorizeSym
  • POSTchangeSymitarPassword
  • POSTauthenticateMember
  • POSTauthenticateService
  • POSTchangeMemberHBPassword
  • POSTconvertToJWT
  • POSTconvertToSAML

authenticate

post

Performs authentication.

Authorizations
Body
NamespacestringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/authenticate HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "Namespace": "text",
  "AuthenticationCredentials": {
    "LDAPCredentials": {
      "UserId": "text",
      "Password": "text"
    },
    "KerberosCredentials": {
      "kerberosTicket": null
    },
    "IMSCredentials": {
      "samlAssertion": "text"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "AuthenticateResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "SAMLAssertion": "text",
    "AuthorizedSym": [
      "text"
    ]
  },
  "nxAttributes": {
    "attachments": "This is a test from Libum. Yeehaw."
  }
}

authenticateWithAuthorization

post

Authenticates with authorization.

Authorizations
Body
NamespacestringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/authenticateWithAuthorization HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "Namespace": "text",
  "AuthenticationCredentials": {
    "LDAPCredentials": {
      "UserId": "text",
      "Password": "text"
    },
    "KerberosCredentials": {
      "kerberosTicket": null
    },
    "IMSCredentials": {
      "samlAssertion": "text"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "AuthenticateWithAuthorizationResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "SAMLAssertion": "text",
    "AuthorizedSym": [
      "text"
    ],
    "AuthorizationProfiles": [
      {
        "Namespace": "text",
        "PrivilegeNames": [
          "text"
        ]
      }
    ]
  },
  "nxAttributes": {
    "attachments": "This is a test from Libum. Yeehaw."
  }
}

getPrincipals

post

Retrieves principals.

Authorizations
Body
NamespacestringOptional
PrivilegeDemandstring[]Optional
Principalstring[]Optional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/getPrincipals HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "Credentials": {},
  "Namespace": "text",
  "PrivilegeDemand": [
    "text"
  ],
  "Principal": [
    "text"
  ],
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "PrincipalsResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "Information": [
      {
        "Principal": "text",
        "Name": "text",
        "Phone": "text"
      }
    ]
  }
}

initKerberosAuthentication

post

Initializes Kerberos authentication.

Authorizations
Body
DomainstringRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/initKerberosAuthentication HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "Domain": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "InitKerberosAuthenticationHostResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "ServicePrincipalName": "text"
  }
}

authorizeSym

post

Authorizes Symmetric Key.

Authorizations
Body
NamespacestringRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/authorizeSym HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "Credentials": {},
  "Namespace": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "AuthorizeSymResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "SAMLAssertion": "text",
    "PrivilegeNames": [
      "text"
    ]
  }
}

changeSymitarPassword

post

Changes Symitar password.

Authorizations
Body
NewPasswordstringRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/changeSymitarPassword HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "Credentials": {},
  "NewPassword": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "ChangeSymitarPasswordResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "SAMLAssertion": "text"
  }
}

authenticateMember

post

Authenticates a member.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/authenticateMember HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "Credentials": {},
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "AuthenticateMemberResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "SAMLAssertion": "text"
  }
}

authenticateService

post

Authenticates a service.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/authenticateService HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "AuthenticateServiceResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "SAMLAssertion": "text"
  }
}

changeMemberHBPassword

post

Changes member's Home Banking password.

Authorizations
Body
NewPasswordstringRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/changeMemberHBPassword HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "Credentials": {},
  "NewPassword": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "ChangeMemberHBPasswordResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "SAMLAssertion": "text"
  }
}

convertToJWT

post

Converts to JSON Web Token (JWT).

Authorizations
Body
SAMLAssertionstringRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/convertToJWT HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "SAMLAssertion": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "ConvertToJWTResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "JwtToken": null
  }
}

convertToSAML

post

Converts to Security Assertion Markup Language (SAML).

Authorizations
Body
JwtTokenJwtTokenRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/ecaa/convertToSAML HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "JwtToken": null,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Status": {
    "StatusCode": 1,
    "Message": "text"
  },
  "ConvertToSAMLResult": {
    "ErrorCode": "text",
    "ErrorMessage": "text",
    "Result": "text",
    "SAMLAssertion": "text"
  }
}