Skip to content
NexumAPI Docs

EcaaService⁠

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

Operations⁠

authenticate⁠

POST

Performs authentication.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Namespacestringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/ecaa/authenticate
POST /nexum/627/persistent/ecaa/authenticate HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Namespace": "string",
  "AuthenticationCredentials": {
    "LDAPCredentials": {
      "UserId": "string",
      "Password": "string"
    },
    "KerberosCredentials": {
      "kerberosTicket": 0
    },
    "IMSCredentials": {
      "samlAssertion": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

authenticateWithAuthorization⁠

POST

Authenticates with authorization.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Namespacestringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/ecaa/authenticateWithAuthorization
POST /nexum/627/persistent/ecaa/authenticateWithAuthorization HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Namespace": "string",
  "AuthenticationCredentials": {
    "LDAPCredentials": {
      "UserId": "string",
      "Password": "string"
    },
    "KerberosCredentials": {
      "kerberosTicket": 0
    },
    "IMSCredentials": {
      "samlAssertion": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getPrincipals⁠

POST

Retrieves principals.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Namespacestringoptional
PrivilegeDemandstring[]optional
Principalstring[]optional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/ecaa/getPrincipals
POST /nexum/627/persistent/ecaa/getPrincipals HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "UserNumber": 1995,
    "Password": "thiswillwerkOP00!",
    "Version_1": {}
  },
  "Namespace": "string",
  "PrivilegeDemand": [
    "string"
  ],
  "Principal": [
    "string"
  ],
  "nxAttributes": {
    "customFields": {}
  }
}

initKerberosAuthentication⁠

POST

Initializes Kerberos authentication.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Domainstringrequired
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/ecaa/initKerberosAuthentication
POST /nexum/627/persistent/ecaa/initKerberosAuthentication HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Domain": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

authorizeSym⁠

POST

Authorizes Symmetric Key.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Namespacestringrequired
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/ecaa/authorizeSym
POST /nexum/627/persistent/ecaa/authorizeSym HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "UserNumber": 1995,
    "Password": "thiswillwerkOP00!",
    "Version_1": {}
  },
  "Namespace": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

changeSymitarPassword⁠

POST

Changes Symitar password.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
NewPasswordstringrequired
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/ecaa/changeSymitarPassword
POST /nexum/627/persistent/ecaa/changeSymitarPassword HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "UserNumber": 1995,
    "Password": "thiswillwerkOP00!",
    "Version_1": {}
  },
  "NewPassword": "string",
  "nxAttributes": {
    "customFields": {}
  }
}