Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The menu dedicated to security asset management such as API Key, Server Key.
With secure mode off, Amity SDK generates an access token on the client side when given a userId
and apiKey
. This can lead to malicious users abusing the endpoint and spying on someone else's session.
With secure mode on, an additional authentication token that is generated from your own backend server using a separate Server Key is required. You must turn on secure mode in your production system or the system will be vulnerable to such kind of attack.
Amity provides a way to get the server key easily via the ASC Console as followed:
Login to your ASC Console
Go to Setting -> Security
Enable secure mode via the toggle.
4. Click "Generate new server key" to generate your server key
5. Click Continue (please make sure you read the warning message and are aware of the impact)
6. The server key will be shown, please copy and securely store into your backend system. The key will only be shown once.
User must not be a super-admin to be able to generate the key.
Once secure mode is enabled and server key is generated, all client authentication request will require an authentication token and your backend server will need to make a server-to-server call, while passing server key into Amity Social Cloud server in order to get the authentication token. Please follow the following steps to generate auth token:
Client initiates a call to the backend.
Client's servers make a request to endpoint https://api.<region code>.amity.co/api/v4/authentication/token
on SDK API server, with server key
and userId
. Refer to the table below for the correct region code and endpoint.
For EU and US, you need to specify the region in the endpoint link. For SG, however, it is optional.
Receive the auth token back and find a way to pass it up from server-side to client-side and give it to the SDK.
To use auth token on the client side, please see the Getting Started guide.
An API key will be provided when you create the application.
Open Amity Social Cloud Console.
On the left menu, select Settings to expand its submenu.
Select Security.
On the Security page, you will find the apiKey.
API key does not contain any information of who the user is. It only contains the networkId
of the network that the user is in.
There are 2 modes of Authentication:
Unsecure mode
Secure mode
With secure mode disabled, you can connect directly to the Amity server.
1. Call /api/v3/session using the API key and user id. Refer to Get API key section for the instructions on how to get the API key.
The request body contains information about user and devices that he/she use to connect to. If displayName
is provide, that user display is updated as well.
If userId
doesn't exists, new user will be created.
2. In the Responses, you will find that the server will return an access token in the Response body.
Access token will be valid for one day. However, it will be invalidated if a different user will use the same token to register the same device.
With secure mode enabled, it provides an additional layer of security because it requires server-level authentication.
If Secure mode is enabled, you will need the server key. Refer to our documentation on How to generate the server key from console.
1. Call /api/v3/authentication/token using the server key.
Provide a userId
to get a token for that user
2. The server will return an authentication token in the Response body.
Authentication token will expire after ten minutes.
Banning a user, whether it is on a global or channel level, will not invalidate the token.
3. Call /api/v3/session using the returned token.
4. In the Responses section, you will find that the server will return an access token in the Response body.
Access token is different from the authentication token returned when calling /api/v3/authentication/token.
Access token will be valid for 30 days. However, it will be invalidated if a different user will use the same token to register the same device.
Mutual Transport Layer Security or mTLS, is a two-way mutual authentication technique. It helps two parties to authenticate at both ends of a network if they have the correct private key. mTLS ensures that the people at both ends of a network connection are who they claim to be.
Authentication Token and Admin Token will be protected by mTLS and provide an extra layer of security.
In the Console, go to Settings > Security tab
Click +Create Certificate option to create the certificate
In order to use this feature, you must first enable "secure mode."
There is a maximum upload of 2 certificates.
Specify the Certificate Name and Certificate Signing Request (CSR)
Certificate Name and Certificate Signing Request fields are mandatory.
Certificate Name can be up to 30 characters.
Activate the mTLS feature
We strongly recommend that you enable the mTLS feature only after the certificate has been created.
Enabling the mTLS feature is optional.
Region | Region code | Endpoint |
---|---|---|
Europe
eu
https://api.eu.amity.co/
Singapore
sg
https://api.sg.amity.co/ or https://api.amity.co/
United States
us
https://api.us.amity.co/
The Amity Social Cloud console allows Super Admins to customize the permissions of Admin users. This gives organizations finer control over their admin structure and improves security by limiting actions that could lead to misuse or compromised data. Super Admins can control whether an Admin can access the following sensitive functionality:
Access Secure Mode: Allows the Admin to access secure mode features such as generating Admin Token that Allows the admin to generate an API token for secure authentication.
Manage Admin: Allows the Admin to create new Admin accounts and configure general admins' permissions. Any new admins they create will have permissions disabled by default.
This feature enhances the admin access control on the console by introducing two different admin roles: super admin and general admin. This allows for more granular control over who has access to what features on the console.
Super Admin
The super admin role has full access to all features on the console. This includes the ability to create, edit, and delete admins, as well as manage admin tokens.
General Admin
The general admin role has limited access to the console. This includes the ability to create and edit admins, but not delete them. General admins also cannot manage admin tokens.
As a Super Admin, you can configure admin permissions from the Admin Users page in the console. Each Admin user will have an associated set of permissions that you can configure, as well as their basic information.
Only a Super Admin can configure General Admins' Permissions.
To edit the permissions for an Admin:
Go to the Admin Users page.
Click on the "Edit name & Permissions" button for the Admin you want to configure.
Adjust permissions and basic information as desired.
Click 'Update'. The Admin user will now be restricted from performing any actions you have disabled permissions for.
As a Super Administrator, you have the authority to create new Administrator accounts. Here's how to proceed:
Go to the Admin Users page.
Click on the "Create New Admin" button.
Fill in the required information for the new Administrator, such as username, email, and basic information.
Determine and set the permissions for the new Administrator. Remember, all permissions are initially disabled for a new Administrator.
Once all details and permissions are correctly filled, click on the 'Create' button to create the new Administrator account.
The new Administrator account is now created. The permissions you've set will define the extent of this new Administrator's access and capabilities within the console. The Administrator will not be able to perform any functions for which you've not granted permission, thereby ensuring the secure and controlled management of your console.
This feature presents a dedicated page, accessible via the Manage Users menu, then Chat activities tab . By selecting a specific user ID, admins can gain insights into the comprehensive chat activities of that user. This encompasses key metrics such as total messages sent, channels joined, and flagged messages. Further, a detailed table offers a deep dive into each user's chat interactions within specific channels, coupled with options to remove users or address flagged content. This user-centric design guarantees a streamlined experience for businesses.
Amity offers a ton of moderation tools and capabilities designed to offer greater control for the user. Moderation can occur both at the user level and the admin level.
The SDK comes alongside a specialized Amity Social Cloud Console that acts as a dashboard where administrators will be able to observe and control data belonging to their network. The ASC Console provides a variety of moderation features and customizable settings for you to use to moderate your applications.
To access the console, you will need an ASC Portal account.
First navigate to the console for your application by clicking on the "Go to console" button on the "My Applications" Screen of your ASC Portal.
You can see the API key - that you'll need to connect to the client - under the "Settings/ Security" section of the console, as pictured below.
Many of the moderation functions supported in ASC Console's UI interface are exposed as APIs accessible with an Admin Access Token. If you would like to moderate some features this way instead of using the console, please refer to the Amity Social Cloud API documentation.
In that tab, an admin can manage entirely the communities of its network. It will be possible to use a filter by name (from the start, case insensitive), and to close (terminate) communities from this panel. The table will also contain the number of posts as a clickable number linking to the post section of the admin panel.
By pushing the "+" button, an admin will be invited to fill a form to create communities. Communities can either be:
Public - any user can join the community.
Private - user needs to be added by the community moderator or admin.
Several options will be presented to customize the community. Once submitted, the community will be automatically visible in the table.
Categories can be accessed from the "Categories" menu in the Communities management section. This page allows any admin to add or remove categories which are used for classifying communities.
Admin can also edit category name and avatar by selecting the category and going to the Settings page.
You cannot update the settings of a deleted category.
This page will show the posts attached to a given context. A context can be: an external content, a community or a user. For communities and users, it will be mandatory to input the respective ID.
For example:
To see all the external contents of an admin's network, simply choose "Content" from the filter bar.
To see all the posts of a community's feed, choose "community" and input the chosen community's ID.
To see all the posts of a user's feed, choose "user" and input the chosen user's ID.
There are options to filter posts and reveal only ones that are flagged, as well as deleting a post if admin's deem it to be necessary.
By pushing the "+" button, an admin will be invited to fill a form to create a post. Several options will be presented to customize the post. Admin will have to fill the "target" type and ID to be able to post.
Once submitted, the post will be automatically visible in the table. In case of having attachments, children posts will be automatically created.
The table comes with 2 sets of numbers which are clickable:
The "sub posts" column link will bring an admin to see the posts attached to a parent one.
The "comment" column link will redirect to the comment section with given context of the chosen post.
When creating the post content, you can mention users to call their attention. To mention, just type the @ symbol followed by the user's display name. Typing @ will also show the user list pop-up. From the list, you can select the users that you want to mention.
In the Post management page, you can see the mentioned users in every post in the Mentioned Users column.
You can mention up to 30 users in one post.
The comment management section comes empty at first. To see and filter the comments, an admin must fill the context of these comments in the filter bar. It can be an external content, or a post, which for both it needs to fill the corresponding ID.
For example:
To see all the comments of an external content, simply choose "Content" and input the content's ID.
To see all the comments of a post, choose "Post" and input the chosen post's ID.
In this section too are options to filter comments and reveal only flagged ones, as well as deleting a comment if necessary.
In this table, an admin can find the following information:
Comment id - ID of the comment
Content - the text or comment body
Mentioned Users - list of users that are being mentioned in the comment
Author id - ID of the user who created the comment
Sub-comments - link to see "sub comments", as in "threaded comments" list. Simply click on the number to reveal the new list of attached comments
Reactions - comment reaction count
Flags - number of flags the comment has received
Last activity - the time stamp when a user last did something related to the comment
Actions - flag or delete the comment
When a user reacts to a post or comment on Amity Social Cloud, a summary of all the reactions will be displayed in the console. The reaction column will indicate the total number of users who have reacted to the specific post or comment. However, reactions to child-posts will not be included in this count.
By clicking on the reaction number, the console will open a reaction list page that displays all the reactions to that post or comment. The list will only show the reaction types that users have selected. This reaction list may differ for each post. The first column of the reaction list displays the reaction name, while the second column shows the total number of users who have used that reaction name to react.
To view the user list for a particular reaction, users can click on the number displayed in the second column. The user list page will display the usernames of all the users who have used that particular reaction type to react to the post or comment. By clicking on the user ID displayed in the first column, users can access more information about the user.
Admin can modify various settings for the SDK from this panel. Admin can also see their SDK API and Webhook keys from this panel.
If the Admin wishes to set up their own webhooks, they can do so by adding a URL to the Webhook section. This will generate a secretKey for that URL webhook. Admin will also be able to delete and previous webhook URLs.
For more information, please have a look at our documentation on Real-Time Events
If the Admin wishes to set up push notifications for their SDK; they may do so by uploading a PNS certificate*. Once a push notification is active, Admin can set what events are push notifiable.
*Note: If client has not enabled Push Notifications with Amity before. Please contact us first so that we can set up the preliminary certificate credentials.
Admin can see what certificates are currently active for their Push Notifications. More than one certificate can be uploaded for one platform (i.e. You can have a staging and a production certificate for iOS), however, only one certificate may be active at a time per platform and/or provider.
Admin can upload new certificates:
For more information, please have a look at our documentation on:
IOS Push Notifications
Android Push Notifications
If you want to make request to Amity Social Cloud APIs as an admin, you will need an access token. You can get the Access token from the Admin Users Management section in console.
You must be logged in as an admin to generate an Admin Access token.
The root/super-admin account cannot generate an Admin Access token because you will not be able to see a Settings button if you are logged in using that account.
Once logged in as an admin, you can generate the access token with these steps:
Go to Settings > Admin Users.
3. Click Generate and a token will be generated in the Access Token box.
Admin Access token is valid for ten years. However, it will be invalidated if the admin user is deleted.
Click the settingsbutton. Admin Settings will pop-up.
Action
Description
Certificate Name
Set the name of the certificate (for Admin tracking purpose)
Platform
Set which platform the certificate is for
Provider (Android Only)
Choose which provider the certificate is for
API Key (Android Only)
Firebase - Server Key , Baidu - API Key & Secret Key
Upload p12 (iOS Only)
Upload the p12 certificate file
Credential Password (iOS Only)
Add the password for the p12 file
Admins are able to view a list of all users from this tab. They will also be able to search for and filter users by certain parameters.
In changing a user's role, admin can either promote a member to a moderator role or demote a moderator to a member role.
There is no limit to the number of moderators a community can have. This means that if there are hundreds of users in the community, all of them can be moderators. However, every community must have at least one moderator. Thus, the sole remaining moderator in the community cannot be demoted to a member.
For more information on how to change a user's role, refer to Moderation, Roles & Privileges.
Admins are able to see all current Admin accounts on the SDK as well as create new Admin accounts. The username that is selected will be used as the login name. The display name is the name that users will see when the Admin broadcasts a message.
Admins are able to view and manage a list of all blocked expressions from this tab.
Blocked expressions can either be exact or partial matches. This choice of behavior needs to be defined when an admin adds an expression to the list.
Admins can also set the auto mute period (in milliseconds) for when a user uses a blocked expression.
Adding blocked expressions in bulk can be done using the post /api/blacklist/records API. Here is the format:
Admins can view and manage a list of all allowed links from this tab.
Admin can add links to the allow list and only the links in the list will be allowed. All other links not in the list will be blocked. By default, link restriction is enabled, thus, all links will be blocked.
You can enable/disable this feature by toggling the on and off button.
Name | Data Type | Description |
---|---|---|
Action
Description
Update global role
Change the role of the user
Global ban user
Kick the user from all channels. Then ban the user from accessing the SDK
Global unban user
Unban the user from accessing the SDK
Action
Description
Edit Admin
Change the Admin's Display Name, First Name and Last Name
Edit password
Change the Admin's password
Settings
Get an Admin's settings
Admins can see all current Admin accounts on the SDK as well as create new Admin accounts. The username that is selected will be used as the login name. The display name is the name that users will see when the Admin broadcasts a message.
regexs
Array.<string>
Blocked expressions to add to the block list
isMatchExactWord
Boolean
true
: will block if an exact match is found
false
: will block even if the expression is just a subset
Example:
Expression: "hell"
Will block: "hell", "hello", "shell", "seashells", etc...
Admins have the capability to view all channels both open and closed. Additionally, creating a new channel is facilitated here.
Admins can effortlessly search for and filter channels based on specific criteria. Both active and deleted channels are displayed in the list. To differentiate the state of the channel:
Active channels are standard.
Navigate to "Channels" in the sidebar.
The channel types that you can create in console are:
Community
Live
Broadcast
To create a channel:
Navigate to the side menu and select Channels.
A Create New Channel pop-up will appear. Fill in the required information:
Channel ID: Enter the ID for the channel.
Display Name: Provide a name that will be visible to all channel members.
Channel Type: Choose the desired channel type from the available options: Community, Live, or Broadcast.
Mute Channel: Check this option if you wish to mute all members within the channel.
Click Submit.
The Amity Social Cloud console offers the capability to delete a channel using the following steps:
Navigate to the side menu and select Channels.
Under the Channels Management section, locate the actions row corresponding to each channel.
Identify and click on the trash icon associated with the channel you wish to delete.
Confirm the deletion by clicking on the confirmation dialogue that appears.
To view the list of current members in the channel, select Members. Here, you will be able to manage users in the channel, such as:
Mute or unmute a channel member
Ban a user from the channel or unban them
Change a user's role within the channel
Remove a user from a channel
You will also be able to see if a user has been banned from the channel, as their user ID will be displayed in red. To unban this user, simply select on the ellipses under "Actions" and select "Unban User". Once a user has been unbanned from the channel, they will no longer appear as part of the channel member list and will be able to rejoin or be re-added into the channel.
Do note that if you remove a banned channel member, their banned status will be cleared and they will be able to join or be added back into the channel as well.
See also: Channel Ban, Muting & Unmuting Channel Users
Deleted channels feature a gray-tinted trash icon .
Muted channels are indicated by a mute icon .
Stopped channels display a gray-tinted stop icon .
On the top right corner, you'll find the search and filter options.
Filter | Description |
---|---|
Action | Description |
---|---|
Under the Channels Management section, click on the icon.
Show All Channels
Display every channel in the system—this includes active, deleted, and muted channels.
Hide Deleted Channels
This will exclude deleted channels from view, presenting only active and muted channels.
Flagged Messages
Display channels that contain user-flagged messages.
Mute
Channels members will no longer be able to send new messages in the channel
Unmute
Channels members are able to send new messages in the channel
Stop Channel
Closes a channel. All channel members will be immediately kicked from the channel
Delete Channel
The channel will be disappeared from the non-admin users. The admins will still be able to see the deleted channels on the console with a gray-tinted trash icon.
Creating safer online communities for all!
Image moderation is a feature that allows all uploaded images on posts and messages to be scanned and moderated for inappropriate, offensive, and unwanted content before images are published.
To this end, we're partnering with Amazon's Rekognition AI technology to detect and moderate images that contain violence, nudity, suggestive, or disturbing content; allowing you to create a safer online community for your users without requiring any human intervention. For more information on how Rekognition works, click here!
Please note that image moderation is disabled by default. Read below for instructions on how to enable image moderation for your network.
The following steps will allow you to enable Image Moderation for your network:
Log into Console
Go to Settings > Image Moderation
Toggle “Allow Image Moderation” to "Yes"
Do note that once you've enabled image moderation, you will need to also set the confidence level for each moderation category. By default, the confidence levels set are "0" for each category. Allowing any one category to be set to '0' confidence level will likely result in all images to be blocked from being uploaded, regardless of whether the image contained any inappropriate elements.
Setting confidence levels at a higher threshold is likely to yield more accurate results when it comes to detecting images for said content. If you specify a confidence value of less than 50, a higher number of false positives are more likely to be returned compared to a higher confidence value. You should only specify a confidence value of less than 50 only when lower confidence detection is acceptable for your use case.
To disable image moderation, simply toggle "Allow Image Moderation" to "No". Any images uploaded will no longer go through the image recognition service, and any inappropriate content will no longer be detected.
Can we set confidence levels for just one category and leave the rest at '0'? Doing so will result in all images being blocked from being uploaded, even if it didn't contain any offensive or unwanted imagery. This is because Amazon Rekognition will scan the uploaded image for all categories (i.e. "Nudity", "Suggestive", "Violence", and "Disturbing) and return a confidence score for each category. If the confidence score returned is equal to or higher than the confidence level set in ASC Console, the image will be blocked. Currently, we don't have a feature to allow image moderation for just one element - but you could try setting different confidence levels for each element to see what works best for your use case.
What happens when an uploaded image is detected to have unwanted imagery? It depends on the confidence threshold set in ASC Console for each moderation category. For example, if your settings are ("Nudity: 99; Suggestive: 80; Violence: 10; Disturbing: 50"), based on the image uploaded, Amazon Rekognition will scan and return a confidence score for each moderation category. If the confidence score returned by Amazon Rekognition equals to, or is higher than the confidence levels set in Console for that category, ASC will block this image from being uploaded, as illustrated below:
Settings in Console: "Nudity: 99; Suggestive: 80; Violence: 10; Disturbing: 50"
Amazon Rekognition Confidence Level for Image Uploaded: "Nudity: 80, Suggestive: 85; Violence: 5; Disturbing: 49"
Image blocked: YES - because the confidence score returned for "Suggestive" category is higher than the confidence threshold set on ASC Console Settings in Console: "Nudity: 99; Suggestive: 80; Violence: 10; Disturbing: 50"
Amazon Rekognition Confidence Level for Image Uploaded: "Nudity: 80, Suggestive: 79; Violence: 5; Disturbing: 49"
Image blocked: NO - because the confidence level returned for all the categories are not equal to or higher than the confidence thresholds set on ASC Console.
The Broadcast channel is heavily adopted by corporate users who constantly promote or advertise their products, or make the announcement to drive awareness. Unlink other channel types, broadcast channels only allow admin users to send messages from Console, and everyone else in the channel will be under read-only mode. Here are the steps to follow to send a broadcast message on Console.
1. Create a channel and select Broadcast in Channel Type. Refer to the Create Channel page for the instructions on how to create a channel.
2. Select the broadcast channel that you created and click Broadcast Message.
3. Chose the message type, and write your message.
5. Click Broadcast.
You can mention channel members in your broadcast messages by typing @ to activate mention suggestion and selecting their names in the suggestion list. Up to 30 channel members can be mentioned per message.
Admins can join a channel and view messages being sent in real-time. They also will be able to filter messages by certain parameters, check current members in the channel and modify channel details such as tags and metadata.
Admins will also be able to broadcast messages directly in the channel.
The SDK supports the sending and receiving of 5 types of messages:
For more information on each of the message types, see Amity Message Types
Because the messages are being sent in real-time, sometimes an Admin will have difficulty moderating when the messages are appearing quickly. In this scenario, Admins can pause the incoming data stream so that they can take action on a message. This pause does not prevent users from sending messages in a channel but simply stops the Admin Panel from receiving new messages. Once the live message has been unpaused, Admin will see all the messages again.
Admins can filter what messages are to be shown on the live message stream. Currently, the SDK supports two types of filters:
Filter by Flagged Show only messages that have been flagged by admin or users
Filter by Threaded Show only messages that are parent message
The mention feature in chat can be used to call attention to all or specific members in a channel. To view the members being mentioned in a message:
Go to Channels Management and select a channel.
In the channel's page, the Mentioned users column will list the members mentioned by a specific user in a message.
Mentioning @all
members in the channel can be turned OFF:
Go to Settings > Feature Settings.
In Feature Settings page, uncheck Allow to mention everyone in channel under Events. You can check to turn ON @all
mention again.
Turning OFF@all
mentioning will only disable mentioning all members in the channel. However, you can still mention individual members because mentioning@user
cannot be turned OFF.
*Note: Message will still be marked as sent by user but with no text.
Type
Description
Text
A message that contains only text
Image
A message that contains an image
File
A message that contains a file
Audio
A message that contains an audio
Custom
A message that contains any data the user wants to store
Mention
Description
Mentioned users format
@user
Mentions a specific channel member
userDisplayName(UserId)
@all
Mentions all channel members
All channel members
Action
Description
Clear flagged
Clears all flags on a message
Delete message
Deletes the message*
Add to blocklist
Admin can select from the message any word or letter they wish to add to the blocklist
Mute user
User will be unable to send messages in channel
Ban user
User will be immediately kicked from channel and have all messages deleted from channel
The first step in using push notifications is to enable network-level push notifications settings. Please follow the steps below to achieve this.
*Only 'Super Administrator' and 'Administrator' have the ability to disable or enable this feature.
In the Console page, navigate to Settings > Push Notifications
Turn ON the Network Notification Settings toggle button.
Important Note : When the network level settings' toggle is turned off, all chat and social notification events will be turned off immediately.
Double-check that all events such as Chat, Post and Comments are correctly enabled. After the network level settings are turned ON, the notification events can be adjusted individually.
In order to have moderation privileges, a user has to be assigned a role. Currently, we offer three tiers of roles for users and one tier for admins
We determine a user's moderation capabilities based on their current role.
*This role cannot be assigned to a user, but only to an Admin.
When you are routed to ASC Console after clicking Go to console in your newly created application in Amity Portal, you will be logged in as a super-admin. This is different from the global-admin and must NOT be used for normal administration tasks for the following reasons:
It cannot generate an Admin API access token used in making server-to-server API calls.
It must be reserved for operations that only a super-admin can perform such as uploading a push notification certificate.
You must create a new admin account for normal administration tasks.
You can promote a user's role from a member to a moderator. Alternatively, a community moderator can also be demoted to a member.
These are the steps to change a user's role:
In the left menu, select Community > Communities.
In the Community Management page, select a community.
In the community's page, click Members tab.
In the Change role pop-up, select the user's new role and click Save to submit.
You can create a new role with customized permissions by following these steps:
in the left menu, select Users > Roles.
In the Create role page, provide a name for the role that you will create.
Customize the permissions by selecting from the list in the Permissions section on the right.
Click Create.
Amity Social Cloud Console provides administrators the ability to observe and control messages in channels.
Moderation tools range from automatic operations such as the blocklisting of words/phrases to controlled operations such as the manual banning and muting of users.
Blocklisting is used to block certain words from being sent in Amity's Chat and Social SDK. When a word is blocklisted, anytime a user attempts to send a message, comment, or a post with that word, it will not be sent.
Contents that are moderated are:
Messages
Posts
Comments
Poll questions and answers
Contents that are not moderated include:
Community names
Community category names
Channel names
User display names
File names
Reaction names
Network names
Role names
Amity by default prevents any link or URL from being sent. However, websites can be whitelisted so that links with that website domain can be sent.
You can enable or disable this feature.
There are 2 types of ban that can be performed on a user:
Global Ban
Channel Ban
Admins have the ability to global ban a user. When a user is globally banned, they will no longer be able to authenticate with ASC and will be forcibly removed from all their existing channels. All the globally banned user's messages will also be deleted. If the SDK has already cached the messages, they will only disappear when refreshed. Note that the global banned user's social content, such as posts, comments, and community membership, will not be removed.
The globally banned user will not be able to authenticate with Amity's network again until they have been globally unbanned.
To perform a global ban on a user:
In ASC Console, go to Users.
Select the user you wish to ban.
In Actions, click the ban user icon.
Click Confirm in the confirmation pop-up.
When a user is global-banned, it can take up to 30 seconds before the user is disconnected from the network. Global ban also does not emit channel ban event and there would be no update via Live Collection.
To unban a user who has been globally banned:
In ASC Console, go to Users.
Select the user you wish to unban.
In Actions, click the unban user icon.
Click Confirm in the confirmation pop-up.
Admins also have the ability to ban a user at the channel level. When a user is banned in a channel, unlike global ban, the user will not get disconnected but will only get an event on both user and channel level. All messages of the banned user in the specified channel will be soft deleted.
There is a real-time event telling online users in the channel that a user has been banned. Therefore, SDK can do soft delete locally and reflects the changes on to the message list right away via LiveCollection.
To perform a channel ban on a user:
In ASC Console, go to Channels.
Select the channel where the User is a member.
Click Members button.
Select the User in the channel that you wish to ban.
In Actions, click the ban user icon.
Click Confirm in the confirmation pop-up.
To unban a user who has been banned in the channel:
In ASC Console, go to Channels.
Select the channel where the User is a member.
Click Members button.
Select the User in the channel that you wish to ban.
In Actions, click the unban user icon.
Click Confirm in the confirmation pop-up.
These moderation tools are available to all admins and users with moderator and super-moderator roles
Moderators can mute and unmute users. When a user is muted, they cannot send messages in a channel. However, muted users will still be allowed to observe messages in a channel. The status of being muted is indefinite but is only applied at the channel level.
Moderators can ban and unban users. When a user is banned in a channel, they are forcibly removed from the channel and may no longer participate or observe messages in that channel. All their previous messages in the channel will also be automatically deleted.
A user that has been banned from a channel can not rejoin the channel until they have been unbanned.
Any frontend user of a network can be promoted into a moderator. There are two types of moderators:
Network Level Moderators They can moderate all posts, comments, and users in all communities across the entire network.
Community Level Moderators They have the same set of permissions as the Network Level Moderators but are only limited within the community wherein they are the moderator.
UIKit for iOS and Android supports both moderation levels so all moderators can see more menus not available to non-moderators.
UIKit for web supports community-level moderation only.
Making a user an administrator allows them to:
Create, edit, or delete roles
Create, edit, or delete community categories
Delete or edit communities
Add, edit, ban, or remove community users
Edit, review, or delete community posts
Edit or delete community comments
Manage posts, comments, and communities
To promote a user to a network-level moderator, perform these steps:
In ASC Console, go to Users.
Select the user you wish to upgrade.
In Actions, click the Change role icon.
Select Network Moderator from the user role dropdown.
Promoting a user to a community-level moderator can be done via API, SDK, or by the Change User Role settings in the Console.
Select the member and click the Change user role button.
In the Roles & Permissions page, click the Create a new role button on the upper right.
Roles
Description
None
The user has no moderation privileges
Moderator
The user can assert general moderation privileges on other users
Super-Moderator
The user can assert general moderation privileges and be exempt from moderation from other users
Global-Admin (Admin Only)*
The user can assign the roles of others, assert all moderation privileges and be exempt from moderation
Learn how to manage your communities with ASC Console
The Community tab serves as a central hub that allows you to manage all communities within your network. Here, you'll be able to easily create a new community, manage community permissions and memberships, and moderate community content such as posts and comments.
Under the Community tab, you will find two pages - Categories and Communities.
The Categories page gives you an overview of all the categories created and which communities the categories are tagged to. Here, you can also create new categories and edit existing ones.
Categories essentially act like classifications, allowing you to tag communities that fall under the same interest area. For example, if you have 5 fitness-related communities, you can create a "Fitness" category and tag those communities under "Fitness". Tagging communities with a category enables your end users to explore other communities within the same interest area.
Read more about creating & managing categories here.
The Communities page gives you an overview of all communities that have been created in your network, including communities that have been deleted. To manage a community, simply select the community you want to manage, and you'll be able to manage the community's activity, memberships, and settings & permissions. You can also create a new community by selecting the "+" button on the top right.
To easily identify communities that require moderation, simply select the flag icon to filter a list of communities that contain flagged content.
Once you've selected a community, select the "Activity" tab to view and manage all posts and comments that have been created in the community. Here, you can also schedule posts to be published, and approve or decline pending posts that require approval before it is posted onto the community's feed.
If a post has been flagged by community members, it will show you the number of times the post has been flagged; and whether the post has any reported comments. The actual content, image, and videos posted by users will be displayed here, even if the post was soft-deleted. This allows you to review flagged posts. You can then choose to either clear the flags of the posts and comments, or delete the post altogether.
To see the community's member list, select the "Members" tab.
You'll be able to see a list of current community members, including users who have been community-banned or deleted. You can use the search feature to search for members by their user ID or display name, or filter to show only banned members. Banned and deleted users will have an icon displayed next to their User ID indicating their status.
Currently, the following community management functionalities are available on ASC Console:
Adding a member to the community
Changing an existing member's role in the community to another default role (either member, or moderator)
Community banning or unbanning a user
If you want to change any of the settings and permissions of a community that was created, simply go to the 'Permissions' tab and 'Settings' tab.
Under 'Permissions', you'll be able to configure the community's posting permissions.
If your community is a community that's mainly for important announcements, you can set permissions to enable "Only admins can post". This means that community members who are not moderators will not be able to create a post in the community. Read more about roles & privileges here.
If you'd like to allow members to contribute, but would like to review their posts first, you can enable "Approve member posts". When this setting is enabled, all posts created will need to be approved or declined by any moderator of the community. Only approved posts will be published in the community feed.
Do note that you can't enable both of these post settings at the same time. If both of these settings are disabled, it means that all members of the community will be able to post freely in the community feed.
Changed your mind about making the community private? Made a typo when creating the community?
If you want to update any of the settings that were configured when a community was created, go to the "Settings" tab.
You'll be able to:
Remove or upload a new community avatar
Update the community's name
Remove or update a community's description
Change the community's category
Mark community as an official community
Mark community as public or private
You can also close a community, although we'd recommend that this should be an intentional decision as you won't be able to restore a deleted community.
To increase the security of our admin tokens, we have enhanced the ability to generate new admin tokens with shorter expiration time and the ability to revoke admin tokens.
Previously, all generated access tokens had an expiration time of 10 years by default. From now on, the expiration time for all newly generated access tokens will be reduced to 1 year. This new enhancement only affects the newly generated tokens. So if you want a token with a shorter expiration time, you will need to generate a new token through the console.
This is not available for Super Admin.
To retrieve your current admin token:
In the Console, go to Settings > Admin Users
Click the ellipses (...) next to your user name to retrieve your current admin token.
Click the Generate button to generate (create) a new token, which will invalidate the existing token.
Click the Confirm button.
Once the new token is generated, the admin will be notified to get switched from the old token to the new token within 24 hours.
Please remember to generate a new token before it expires. Otherwise, you will get "token expired" error if you use an expired token for API calls.
In case the admin token has been compromised, admin users can now revoke their own admin token, and Super Admins can revoke another admin's token. Revoking tokens are done by passing the username
parameter.
After revocation, that admin's token becomes invalid and the admin will be automatically logged out of Console. When that admin logs in again, a new token will be generated. The admin must use this new token for future API calls, otherwise they will receive an "Invalid token' error.
You will encounter error:
When a non-admin tries to revoke any admin token
When the username
doesnt exist
Supported the ability for admins and super admins to soft delete channels directly from the console.
Added a double confirmation pop-up to prevent accidental deletions.
Added an option to for admins and super admins to choose whether they want to include or exclude deleted channels based on their preferences.
Added two new options including "Show All Channels" and "Hide Deleted Channels".
Introduced remove channel members feature, allowing users to remove another member from a particular channel.
Updated the maximum character limit on the functionality of adding an allow list.
Support the ability to get details reactions for post, comment and subpost on console.
The Comments page in the console now displays flagged child comments in addition to the flagged parent comments.
Fixed issue where non-flagged items could have their flags 'cleared'.
Fixed issue where admin could not send broadcast message to the channel.
Disabled the "+" button for deleted communities.
Fixed issue with activating PNS certificates on Console.
Enhanced the Usage tab in the Historical Monthly Usage table to show the total number of moderated images per billing cycle.
Enhanced the PAYG Portal Billing Center and invoice to display any image moderation usage and billing amount that was incurred for the cycle.
Fixed issue where creating a broadcast with mention was not possible.
In the Broadcast, Live, and Community channels all message types (text, image, file and video) are now grouped into a single event.
In the Conversation channel all message types (text, image, file and video) are now grouped into a single event.
In ASC Console, you can now download the Usage report in CSV format.
Community query is now case-insensitive! You no longer have to match the case sensitivity of the community’s display name when querying for a community.
Fixed issue where user ID or display name weren’t appearing in the user search result, if the keyword has a special character or if it is more than 30 characters long.
Removed the validation that prevented deleted category names from being reused when you create a new category, or when you want to update an existing category’s name. You’re now free to reuse any category name that was deleted!
SDK Upgrade
Fixed issue that limits the ability to play .mov video type
Fixed issue that prevented administrators from sending broadcast messages
Fixed issue where signing in to the portal, redirects to the console's login page
Fixed issue with message sorting in the channels management page. Messages will now be sorted according to newest created date to oldest created date
Admin will no longer be able to enable both Post Review and Admin Can Post Only settings at the same time
Fixed alignment issue for permissions settings under Community
channelId
is now optional when creating channels
Fixed issue where ASC Console was crashing upon selecting Channel Settings
Renamed "Chat Event" to "Network Level Settings"; and "header.pns_events" to "Chat Event"
Support the ability to enable and disable ‘Network Level Push Notification Settings’ via ASC Console
Fixed issue with avatar upload progress indicator
Renamed "PNS Events" to "Chat Events"
Fix JavaScript sample code in Settings / Security page
Block list / Allow list loads all data without pagination
Unable to delete filter items in allow list and block list
FileUploader
and VideoUploader
refactoring
Remove permission to manage user feed
Sorting of content (Channels, Livestream, Communities, Categories, Users, Roles, Posts, and Comments) by first and last created and first and last updated
Long file name of community avatar overlaps in UI when creating community
Save button in Streaming details page not changed to disabled state after uploading video
Region fallback constant set as environment variable
Can enable/disable Allow list feature in console
Roles will now show role name and role ID in the Role dropdown when updating the user’s global role
Category detail page ID will show community ID
Unban button will be blocked after banning user from a channel
Global-banned user shows unban button inside members list in Channel Management page
Can set push notifications for the following events:
When there’s a post sent for review in the community
Notification to member when the post is approved
Global-banned user show 'unban' button inside members list in channel management
Mentioned users column in Comment Management page
Edit the category display name and avatar
Community member will receive a notification if the post is approved in the feed
Moderator will receive a notification when there’s a post sent for review
Add 'Mentioned Users' column in the Post Management page
Create posts with mentioned user(s)
Create posts with members of a private community
Can search and see the list of users to select by typing the @ symbol when mentioning
Update image and name of the category
Demote a member to a User role
Show both role ID and role name when updating global role of the user
Disable demoting a Moderator to a Member if there is only one remaining moderator
Promote Member to Moderator role
Creator/Moderators will now get “community-moderator” & “channel-moderator” roles
Removed Community Creator privilege logics
Add Community Moderator and Channel Moderator roles
Now utilizing v4 API endpoints for Promote/Demote users in community
Changed the size of the “Mentioned User” column for “channel”
Cannot create mention from broadcast
Incorrect message is shown when mentioning more than 30 users
Mentionees is not shown in 'mentioned user' column when mentioning from a community post
Can mention non-members in a private community
'Mentioned user' column width is not specified
Moderator role is not selected in the “Change Role” page for the community creator
Disable submit button if there's no input in Push Notification message composer
“Authorization info not found” error pops when staying in console for a few hours
Edit role and Delete role buttons are disabled for Super-moderator, Moderator, and Global-admin roles
Unnamed file is shown after sending broadcast with file attachment, page needs to be refreshed.
User cannot get moderator privileges even after updating to moderator role
No error popup is shown if internet connection is lost when searching for channel
Select members dropdown does not close after a selection
Mention users in Broadcast channel
Text Caption not shown when sending a broadcast message with an image to a channel
When creating a post, OK button will enable even while still uploading a video attachment
Added functionality to support .
Enhanced the ability to with shorter expiration time.
Introduced the ability to .