ldap_backend/README.md

Skynet LDAP backend

Basic information on the Skynet ldap backend for use on https://sso.skynet.ie

Error: HTTP 500

No indication of the issue is returned to teh frontend.

Routes

Base URL: https://api.sso.skynet.ie

POST /ldap/update

Fields:

• userPassword
• mail
• sshPublicKey
• cn
• sn
• skDiscord

{ 
  "user" : "username", 
  "pass" : "password",
  "field": "field to change",
  "value": "new value of field"
}

Success:
Each value is either a string or null.

{
  "result": "success",
  "success": {
    "cn": "Firstname Surname",
    "mail": "Email address",
    "skDiscord": null, 
    "sshPublicKey": "ssh key"
  }
}

Changing userPassword requires the existing password in teh apssword field and the new one in teh value field.

POST /ldap/new/email

Kickstarts teh process of signing up to Skynet

{ 
  "email" : "User's wolves email"
}

POST /ldap/new/account

Verifies teh user has access to this email

{ 
  "auth" : "Authcode from the email",
  "user" : "username the user wants", 
  "pass" : "password teh user wants"
}

Username taken:

{"result": "error", "error": "username not available"}

Invalid Auth:

{"result": "error", "error": "Invalid auth"}

Responses

Generic responses which is used unless otherwise specified above.

POST /ldap/recover/password

{
  "user" : "[OPTIONAL] username looking for reset",
  "email" : "[OPTIONAL] email looking for reset"
}

All responses:

{"result": "success"}

POST /ldap/recover/password/auth

{ 
  "auth" : "Auth key from teh email",
  "pass" : "Password the user chooses"
}

Early Errors:

{"result": "error"}

LDAP error:

{"result": "error", "error": "ldap error"}

Success:

{"result": "success", "success": "Password set"}

Responses

Generic responses which is used unless otherwise specified above.

Success: HTTP 200

{
    "result": "success"
}