Route: https://kayran.live/api/UpdateTeams
This function allow users to integrate and connect Microsoft Teams to Kayran.
*For more information regarding the use of Microsoft teams, please go to our Support*
Roles Required: Admin.
Request Syntax
{
"apiKey": "String",
"teamsWebhook": "String",
"teamsAvgThreat": Informative/Low/Medium/High,
"teamsNotify": true/false,
"teamsStartFromSchedule": true/false,
"teamsStartFromQueue": true/false,
"teamsCompleteAborted":true/false,
"teamsDelete": true/false,
"teamsStop":,true/false
"teamsAborted":true/false
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your Kayran given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
teamsWebhook
Parameter Usage and Options :
Your Microsoft Teams Webhook URL.
Type :
String
Is it Optional ? :
No.
Parameter Name :
teamsAvgThreat
Parameter Usage and Options :
Users can choose to get notified based on the average severity of the vulnerabilities Kayran has detected.
Value:
Informative/Low/Medium/High
Is it Optional ? :
Yes.
Parameter Name :
teamNotify
Parameter Usage and Options :
Enabling it means that you will get notified on all possible events.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
teamStartFromSchedule
Parameter Usage and Options :
Enabling it means that you will get notified on scheduled scans that gets initiated.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
teamsStartFromQueue
Parameter Usage and Options :
Enabling it means that you will get notified on queued scans that gets initiated.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
teamsCompleteAborted
Parameter Usage and Options :
Enabling it means that you will get notified on scans that were finished and are either completed or aborted.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
teamsDelete
Parameter Usage and Options :
Enabling it means that you will get notified on scans that were deleted.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
teamsStop
Parameter Usage and Options :
Enabling it means that you will get notified on scans that were stopped.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
teamsAborted
Parameter Usage and Options :
Enabling it means that you will get notified on scans that were aborted.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Successful Response
{
"Error": 0,
"Function": "UpdateTeams",
"Data": "Success"
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.
