This page list IMS rest APIs and their usages. For a interactive reference Swagger based API documentation is available for ihtsdo-ops-admin roles on IMS server (https://{env}-ims.ihtsdotools.org/#/docs).

Account Resource

RequestDescriptionStatusResponse

GET /api/account

noneRetrieves logged in user details and roles200
{
  "login": "pnema",
  "password": null,
  "firstName": "Prashant",
  "lastName": "Nema",
  "email": "pnema@icloud.com",
  "langKey": null,
  "roles": [ "ROLE_auths-external-consultants", 
"ROLE_confluence-users"
,
"ROLE_confluence-users-project-auths"
,
"ROLE_confluence-users-project-refset"
,
"ROLE_ihtsdo-ops-admin"
,...    ]

 If user not logged in it redirect to default login page302 

POST /api/account

{

  "login": "",

  "firstName": "",

  "lastName": "",

  "email": "",

  "langKey": ""

}

Update logged in user user profile changes to crowd200200 status code
  500500 - if user is invalid or not found in the system
  400400 - if email updated is already used by some other user

POST /api/account/change_password

{password}Updates logged in user password200 
  400400 - if invalid password ie 50 > password > 5 character,

POST /api/activate

?key=activationkeyActivate a newly registered user200 
  400400 - if invalid of expired key

POST /api/forgot_password

{username}Send a resets password link to user identified with given user name200200

POST /api/reset_password

{key=resetKey}Validate reset key and reset password with new password provided200 
  500500 - if reset key is invalid.

POST /api/register

{

  "login": "",

  "password": "",

  "firstName": "",

  "lastName": "",

  "email": "",

}

Register a new user200 
  400400 - if user supplied email is already used by registered user
  400400 - if given username already exist

POST /j_security_check

j_username

j_password

Authenticate user with given credentials200 
  401

401 - Unauthorized

message - Authentication failed

POST /j_spring_security_logout

 Sign-out currently logged in user200 

Audit Resource (Administrative Resource only. Available to designated role ihtsdo-ops-admin)

RequestDescriptionStatusResponse

GET /api/audits/all

noneRetrieves audit logs of login/logout events200

GET /api/audits/byDates

 Retrieves audit logs of login/logout events for specified dates200 
    

Log Resource (Administrative Resource only. Available to designated role ihtsdo-ops-admin)

RequestDescriptionStatusResponse

PUT /api/logs

{

  "name": "",

  "level": ""

}

Updates application logging levels200

GET /api/logs

 Retrieves application logging levels for application packages200 [ { "name": "", "level": "" } ]