Methods
Response
The user's preferred email address for email notifications
The user's full name
The email address associated with the user's IBM ID
The user's alternative email address for email notifications
The names of all groups the user belongs to
Possible values: contains only unique items
The user's preferred mobile phone number for text and voice notifications. The mobile phone number format is +[country code][phone number] without spaces or separators
A list of roles the user fills, can be 'User' or 'Manager'
Possible values: [
User,Manager]Possible values: contains only unique items
Status Code
Successful request
Authorization failed
Forbidden
Internal system error
No Sample Response
Request
Custom Headers
Allowable values: [
application/json,text/plain]
Query Parameters
Set true to send the user a welcome email upon successful creation
User object
The user's preferred email address for email notifications
The user's full name
The email address associated with the user's IBM ID
The user's alternative email address for email notifications
Default:
user@example.comThe names of every group the user belongs to. All names that do not match existing groups are ignored
Possible values: contains only unique items
The user's preferred notification channels while on duty, on call, and off duty
The user's preferred mobile phone number for text and voice notifications. The mobile phone number format is +[country code][phone number] without spaces or separators
Default:
+15551231234A list of roles the user fills, can be 'User' or 'Manager'
Allowable values: [
User,Manager]Possible values: contains only unique items
The user's work hours and related preferences
Response
The user's preferred email address for email notifications
The user's full name
The email address associated with the user's IBM ID
The user's alternative email address for email notifications
The names of every group the user belongs to. All names that do not match existing groups are ignored
Possible values: contains only unique items
The user's preferred notification channels while on duty, on call, and off duty
The user's preferred mobile phone number for text and voice notifications. The mobile phone number format is +[country code][phone number] without spaces or separators
A list of roles the user fills, can be 'User' or 'Manager'
Possible values: [
User,Manager]Possible values: contains only unique items
The user's work hours and related preferences
Status Code
User successfully created
Invalid request
Authorization failed
Forbidden
User already exists
Invalid media type
Internal system error
No Sample Response
deleteUser
Delete a user. Will fail for users that:
1. a policy depends on
2. are assigned to a current or future shift
3. were created outside of Alert Notification
DELETE /users/v1/{id}getUser
Get a user's contact information, preferences, group membership, and roles.
GET /users/v1/{id}Request
Custom Headers
Allowable values: [
application/json,text/plain]
Path Parameters
IBM ID of the user or 'current' for the current user
Response
The user's preferred email address for email notifications
The user's full name
The email address associated with the user's IBM ID
The user's alternative email address for email notifications
The names of every group the user belongs to. All names that do not match existing groups are ignored
Possible values: contains only unique items
The user's preferred notification channels while on duty, on call, and off duty
The user's preferred mobile phone number for text and voice notifications. The mobile phone number format is +[country code][phone number] without spaces or separators
A list of roles the user fills, can be 'User' or 'Manager'
Possible values: [
User,Manager]Possible values: contains only unique items
The user's work hours and related preferences
Status Code
Successful request
Authorization failed
Forbidden
Unable to locate user
Internal system error
No Sample Response
modifyUser
Set a user's contact information, preferences, group membership, and roles.
PUT /users/v1/{id}Request
Custom Headers
Allowable values: [
application/json,text/plain]
Path Parameters
IBM ID of the user or 'current' for the current user
User object
The user's preferred email address for email notifications
The user's full name
The user's alternative email address for email notifications
Default:
user@example.comThe names of every group the user belongs to. All names that do not match existing groups are ignored
Possible values: contains only unique items
The user's preferred notification channels while on duty, on call, and off duty
The user's preferred mobile phone number for text and voice notifications. The mobile phone number format is +[country code][phone number] without spaces or separators
Default:
+15551231234A list of roles the user fills, can be 'User' or 'Manager'
Allowable values: [
User,Manager]Possible values: contains only unique items
The user's work hours and related preferences
Response
The user's preferred email address for email notifications
The user's full name
The email address associated with the user's IBM ID
The user's alternative email address for email notifications
The names of every group the user belongs to. All names that do not match existing groups are ignored
Possible values: contains only unique items
The user's preferred notification channels while on duty, on call, and off duty
The user's preferred mobile phone number for text and voice notifications. The mobile phone number format is +[country code][phone number] without spaces or separators
A list of roles the user fills, can be 'User' or 'Manager'
Possible values: [
User,Manager]Possible values: contains only unique items
The user's work hours and related preferences
Status Code
Successful request
Invalid request
Authorization failed
Forbidden
Unable to locate user
Invalid media type
Internal system error