IMS Rest API Reference

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
Request	Description	Status	Response
GET /api/account
none	Retrieves logged in user details and roles	200	`{ "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 page	302
POST /api/account
{ "login": "", "firstName": "", "lastName": "", "email": "", "langKey": "" }	Update logged in user user profile changes to crowd	200	200 status code
		500	500 - if user is invalid or not found in the system
		400	400 - if email updated is already used by some other user
POST /api/account/change_password
{password}	Updates logged in user password	200
		400	400 - if invalid password ie 50 > password > 5 character,
POST /api/activate
?key=activationkey	Activate a newly registered user	200
		400	400 - if invalid of expired key
POST /api/forgot_password
{username}	Send a resets password link to user identified with given user name	200	200
POST /api/reset_password
{key=resetKey}	Validate reset key and reset password with new password provided	200
		500	500 - if reset key is invalid.
POST /api/register
{ "login": "", "password": "", "firstName": "", "lastName": "", "email": "", }	Register a new user	200
		400	400 - if user supplied email is already used by registered user
		400	400 - if given username already exist
POST /j_security_check
j_username j_password	Authenticate user with given credentials	200
		401	401 - Unauthorized message - Authentication failed
POST /j_spring_security_logout
	Sign-out currently logged in user	200

Audit Resource (Administrative Resource only. Available to designated role ihtsdo-ops-admin)
Request	Description	Status	Response
GET /api/audits/all
none	Retrieves audit logs of login/logout events	200
GET /api/audits/byDates
	Retrieves audit logs of login/logout events for specified dates	200

Log Resource (Administrative Resource only. Available to designated role ihtsdo-ops-admin)
Request	Description	Status	Response
PUT /api/logs
{ "name": "", "level": "" }	Updates application logging levels	200
GET /api/logs
	Retrieves application logging levels for application packages	200	[ { "name": "", "level": "" } ]

Page tree

IMS Rest API Reference

GET /api/account

POST /api/account

POST /api/account/change_password

POST /api/activate

POST /api/forgot_password

POST /api/reset_password

POST /api/register

POST /j_security_check

POST /j_spring_security_logout

GET /api/audits/all

GET /api/audits/byDates

PUT /api/logs

GET /api/logs