COMM100 RESTFUL API
Introduction
LiveChat Agent Private Message Android Push Audio & Video Chat Auto Distribution Campaign Chat Custom Variable Custom Variable Config Dynamic Campaign Installation Integration Calendly IOS Push LiveChat_BannedIp LiveChat_BannedVisitor LiveChat_CampaignAutoInvitation LiveChat_ConversionAction LiveChat_Field LiveChat_Segment LiveChat_Shift LiveChat_Wrap-Up Field Offline Message SecureForm_Label Segment Config Shift Config Visitor History Visitor Single Sign-On (SSO) Webhook Wrapup Category Config Chat Server Real Time
Ticketing Agent Preference Auto Distribution Channel Channel App Channel Contact Identity Type Draft Event log Field Mapping Junk Message Note Operating Hours & Holidays Routing Config Tag Ticket Ticket Recycle Bin Ticketing_BlockedSender Ticketing_ChannelAccount Ticketing_Field Ticketing_Holiday Ticketing_SLAPolicy Ticketing_Trigger View
Bot Agent Assist Learning Question Bot_AgentAssistSynonym Bot_Chatbot Bot_ChatbotCannedQuickReply Bot_ChatbotEntity Bot_ChatbotIntentCategory Bot_ChatbotSmartTrigger Bot_Taskbot Chatbot Intent Chatbot Intent Answer Chatbot Intent Question Chatbot Learning Question Chatbot Message When A Visitor Start A Chat Chatbot Message When Not Helpful Chatbot Message When Providing Possible Answer Chatbot No Answer Message Level2Menu_AgentAssist Prebuilt Entity Taskbot Booked Calendly Meeting Taskbot Version
KB KnowledgeBase_Article KnowledgeBase_Category KnowledgeBase_CustomPage KnowledgeBase_Design KnowledgeBase_Image KnowledgeBase_KnowledgeBase KnowledgeBase_Tag Preview
Global Action Type Agent Agent Single Sign-On Config Audit Log Auto Translation Contact Contact identity Credit Card Masking Config Custom Agent Away Status Config Department Config Global_AgentAwayStatus Global_Loginipallowlist Global_PrivateCannedMessage Global_PrivateCannedMessageCategory Global_PublicCannedMessage Global_PublicCannedMessageCategory Global_Role Global_Skills LiveChat_Department Login IP Allowlist Config Module Password Policy Config Permission Restricted Words Config Role Config Site Profile SkillConfig System Avatar Visitor
Reporting Cube Report
Visitor Side JavaScript API Agent Console JavaScript API
Password Policy Config

Password Policy Configs
- Password Policy Configs Manage
GET global/passwordPolicyConfig
- Get a single Password Policy Config
PUT global/passwordPolicyConfig
- Update the Password Policy Config
Model
Password Policy Config JSON Format

Password Policy Config is represented as simple flat JSON objects with the following keys:

Name Type Description
isMinimumPasswordLengthEnabled bool Whether the Minimum Password Length is enabled or not.
isReusePreviousPasswordsPrevented bool Whether the Reuse Previous Passwords Prevented is enabled or not.
isPasswordExpiredInCertainDays bool Whether the Password Expired In Certain Days is enabled or not.
isPasswordComplexityRequired bool Whether the Password Complexity Required is enabled or not.
isPasswordContainingUsernamePrevented bool Whether the Password Containing Username Prevented is enabled or not.
isDailyPasswordChangeTimesLimited bool Whether the Daily Password Change Times Limited is enabled or not.
isSimplePasswordPrevented bool Whether simple and commonly used passwords are restricted or not.
isAgentLockedAfterCertainAttempts bool Whether the Agent Locked After Certain Attempts is enabled or not.
siteId integer Id of the site.
minimumPasswordLength integer Minimum length of the password.
previousPasswordsRemembered integer Number of the last passwords that can not be used this time.
maximumDailyPasswordChangeTimes integer Maximum number of password changes allowed daily.
maximumLoginAttemptsBeforeLock integer Maximum number of login attempts allowed before the account is locked.
passwordExpiredInCertainDays integer Number of days the password is valid for.
Endpoint
Get a single Password Policy Config

GET global/passwordPolicyConfig

Parameters:
No Parameters
Response:

Password Policy Config

Example

Sample Request:

curl https://api15.comm100.io/v4/global/passwordPolicyConfig \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isMinimumPasswordLengthEnabled":false,"isReusePreviousPasswordsPrevented":false,"isPasswordExpiredInCertainDays":false,"isPasswordComplexityRequired":false,"isPasswordContainingUsernamePrevented":false,"isDailyPasswordChangeTimesLimited":false,"isSimplePasswordPrevented":false,"isAgentLockedAfterCertainAttempts":false,"siteId":10000,"minimumPasswordLength":6,"previousPasswordsRemembered":1,"maximumDailyPasswordChangeTimes":2,"maximumLoginAttemptsBeforeLock":6,"passwordExpiredInCertainDays":1}
Update the Password Policy Config

PUT global/passwordPolicyConfig

Parameters:
Name Type In Required Description
isMinimumPasswordLengthEnabled bool body no Whether the Minimum Password Length is enabled or not.
isReusePreviousPasswordsPrevented bool body no Whether the Reuse Previous Passwords Prevented is enabled or not.
isPasswordExpiredInCertainDays bool body no Whether the Password Expired In Certain Days is enabled or not.
isPasswordComplexityRequired bool body no Whether the Password Complexity Required is enabled or not.
isPasswordContainingUsernamePrevented bool body no Whether the Password Containing Username Prevented is enabled or not.
isDailyPasswordChangeTimesLimited bool body no Whether the Daily Password Change Times Limited is enabled or not.
isSimplePasswordPrevented bool body no Whether simple and commonly used passwords are restricted or not.
isAgentLockedAfterCertainAttempts bool body no Whether the Agent Locked After Certain Attempts is enabled or not.
minimumPasswordLength integer body no Minimum length of the password.
previousPasswordsRemembered integer body no Number of the last passwords that can not be used this time.
maximumDailyPasswordChangeTimes integer body no Maximum number of password changes allowed daily.
maximumLoginAttemptsBeforeLock integer body no Maximum number of login attempts allowed before the account is locked.
passwordExpiredInCertainDays integer body no Number of days the password is valid for.
Response:

Password Policy Config

Example

Sample Request:

curl https://api15.comm100.io/v4/global/passwordPolicyConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isMinimumPasswordLengthEnabled":false,"isReusePreviousPasswordsPrevented":false,"isPasswordExpiredInCertainDays":false,"isPasswordComplexityRequired":false,"isPasswordContainingUsernamePrevented":false,"isDailyPasswordChangeTimesLimited":false,"isSimplePasswordPrevented":false,"isAgentLockedAfterCertainAttempts":false,"minimumPasswordLength":6,"previousPasswordsRemembered":1,"maximumDailyPasswordChangeTimes":2,"maximumLoginAttemptsBeforeLock":6,"passwordExpiredInCertainDays":1}'

Response:

 HTTP/1.1 200 OK

{"isMinimumPasswordLengthEnabled":false,"isReusePreviousPasswordsPrevented":false,"isPasswordExpiredInCertainDays":false,"isPasswordComplexityRequired":false,"isPasswordContainingUsernamePrevented":false,"isDailyPasswordChangeTimesLimited":false,"isSimplePasswordPrevented":false,"isAgentLockedAfterCertainAttempts":false,"siteId":10000,"minimumPasswordLength":6,"previousPasswordsRemembered":1,"maximumDailyPasswordChangeTimes":2,"maximumLoginAttemptsBeforeLock":6,"passwordExpiredInCertainDays":1}
© 2021 | Comm100