EcaaService

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

Symitar eDocs References: Coming soon.

Operations

authenticate

post

Performs authentication.

Authorizations
Body
NamespacestringOptional
Responses
200

Successful operation.

application/json
post
/authenticate
POST /nexum/627/persistent/ecaa/authenticate HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "Namespace": "text",
  "AuthenticationCredentials": {
    "LDAPCredentials": {
      "UserId": "text",
      "Password": "text"
    },
    "KerberosCredentials": {
      "kerberosTicket": 1
    },
    "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
/authenticateWithAuthorization
POST /nexum/627/persistent/ecaa/authenticateWithAuthorization HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "Namespace": "text",
  "AuthenticationCredentials": {
    "LDAPCredentials": {
      "UserId": "text",
      "Password": "text"
    },
    "KerberosCredentials": {
      "kerberosTicket": 1
    },
    "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
/getPrincipals
POST /nexum/627/persistent/ecaa/getPrincipals HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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
/initKerberosAuthentication
POST /nexum/627/persistent/ecaa/initKerberosAuthentication HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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
/authorizeSym
POST /nexum/627/persistent/ecaa/authorizeSym HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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
/changeSymitarPassword
POST /nexum/627/persistent/ecaa/changeSymitarPassword HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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
/authenticateMember
POST /nexum/627/persistent/ecaa/authenticateMember HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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
/authenticateService
POST /nexum/627/persistent/ecaa/authenticateService HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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
/changeMemberHBPassword
POST /nexum/627/persistent/ecaa/changeMemberHBPassword HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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
/convertToJWT
POST /nexum/627/persistent/ecaa/convertToJWT HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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": "text"
  }
}

convertToSAML

post

Converts to Security Assertion Markup Language (SAML).

Authorizations
Body
JwtTokenstringRequired
Responses
200

Successful operation.

application/json
post
/convertToSAML
POST /nexum/627/persistent/ecaa/convertToSAML HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

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

Successful operation.

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

Last updated

Was this helpful?