User Management API

The ATMS User Management API will be exposed to trusted partner systems that have access to the network the API is hosted in. Each partner will be provided with a unique API key that should be used in in a header for each request. The specific header to include the key in is called “token”. In addition, each request should Accept application/json. A sample curl command would be as follows: curl -X GET --header 'Accept: application/json' --header 'token: {API Token}' '{Host}/api/Users'

API Definition

The API is organized into method sets, based on the type of data to be managed.

• Users
• User Groups

The returned data types are described in the following sections.

Users

Methods

Resource	Url	Data Payload	Description	Returns
GET	/api/Users	None	Returns all users configured in ATMS	user[]
GET	/api/Users/{username}	None	Returns details for a single unplanned event as specified by the id included in the request	user
POST	/api/Users	UserDefinition	Adds a new user account to the ATMS	None
PUT	/api/Users/{username}	UserDefinition	Updates the account linked to the specified username	None
DELETE	/api/Users/{username}	None	Removes the account linked to the specified username	None
PUT	/api/Users/{username}/disable	None	Disables the account linked to the specified username. The account remains in the ATMS, but the user will not be permitted to access the application	None
PUT	/api/Users/{username}/enable	None	Enables the account linked to the specified username, permitting the user to access the ATMS.	None

Data Formats

User

Name	Description	Type	Additional Information
Username	Unique user name or e-mail address to apply to the account	string	This value cannot be NULL or empty.This value is not editable once an account has been created.
DisplayName	Long name to display for the user account within the ATMS	string	Required
UserGroupName	Name of the User Group the user should be assigned to	string	Required. Must match an existing User Group GroupName.
Email	Email address of the user	string	Not required
Phone	Phone number of the user	string	Not required
IsAccountDisabled	Indicates if the account is currently locked/disabled (user is not permitted to access the system).	Boolean	Required

UserDefinition

Name	Description	Type	Additional Information
Username	Unique user name or e-mail address to apply to the account	string	This value cannot be NULL or empty.This value is not editable once an account has been created.
DisplayName	Long name to display for the user account within the ATMS	string	Required
UserGroupName	Name of the User Group the user should be assigned to	string	Required. Must match an existing User Group GroupName.
Email	Email address of the user	string	Not required
Phone	Phone number of the user	string	Not required

User Groups

Methods

Resource	Url	Data Payload	Description	Returns
GET	/api/UserGroups	None	Returns all User Groups currently configured in ATMS	userGroup[]
GET	/api/UserGroups/{GroupName}	None	Returns the specified User Group	userGroup

Data Format

User Group

Name	Description	Type	Additional Information
GroupName	Unique name of the User Group	string	None
Description	A description of the User Group. This may define the types of actions users in that user group perform.	string	None