https://all.docs.genesys.com/index.php?action=history&feed=atom&title=PEC-DC%2FCurrent%2FAdministrator%2FAPIKeys 2026-04-11T01:26:49Z Revision history for this page on the wiki MediaWiki 1.31.1 https://all.docs.genesys.com/index.php?title=PEC-DC/Current/Administrator/APIKeys&diff=132221&oldid=prev 2023-08-07T05:00:44Z

<p>Created page with &quot;{{Article |Standalone=No |DisplayName=Manage API keys |Context=Learn how to manage API keys for Digital Channels. |ComingSoon=No |Section={{Section |alignment=Vertical |struct...&quot;</p> <p><b>New page</b></p><div>{{Article<br /> |Standalone=No<br /> |DisplayName=Manage API keys<br /> |Context=Learn how to manage API keys for Digital Channels.<br /> |ComingSoon=No<br /> |Section={{Section<br /> |alignment=Vertical<br /> |structuredtext=Digital Channels allows management of chat and secure mail API keys. You can add or revoke API keys. <br /> <br /> Access API Keys under '''Provisioning''' menu.[[File:DC_api_keys_main.png]]<br /> <br /> The following user rights are required to manage the API keys:<br /> <br /> *&lt;tt&gt;Nexus.ApiKeys.canView&lt;/tt&gt; and &lt;tt&gt;Nexus.ApiKeys.canRead&lt;/tt&gt; - to view the API Keys page<br /> *&lt;tt&gt;Nexus.ApiKeys.canCreate&lt;/tt&gt; - to create new API keys<br /> *&lt;tt&gt;Nexus.ApiKeys.canUpdate&lt;/tt&gt; - to update an existing API key<br /> *&lt;tt&gt;Nexus.ApiKeys.canDelete&lt;/tt&gt; - to delete an existing API key<br /> <br /> &lt;br /&gt;<br /> |Status=Yes<br /> }}{{Section<br /> |sectionHeading=Create or edit an API key<br /> |anchor=create<br /> |alignment=Horizontal<br /> |Media=Image<br /> |image=DC_api_keys_create.png<br /> |structuredtext=To add a new API key, click '''Add API Key'''.<br /> <br /> When you create a new API Key, the '''New API Key''' view opens on the right side of the page. To begin, give your API key a name and a permission it can use. You can choose either ''Secure Mail'' or ''Chat''. The permission cannot be changed later.<br /> <br /> The API key is enabled by default. If you want to disable it when creating the key, toggle the '''Enabled''' option ([[File:Des_PII_status.png|link=]]).<br /> <br /> If you want the API key not to expire, select the '''Will never expire''' option. Alternatively, if you want to set an expiration date for the API key, clear the '''Will never expire''' option and choose a date in the '''Expiration Date''' option.<br /> |Status=No<br /> }}{{Section<br /> |sectionHeading=Enable an API key<br /> |anchor=enable-api-key<br /> |alignment=Vertical<br /> |structuredtext=To enable an API key, toggle the '''Enabled''' option ([[File:Des_PII_status.png|link=]]) from the API keys listing or from the '''API Key Details''' view.<br /> |Status=No<br /> }}{{Section<br /> |sectionHeading=Expire an API key<br /> |anchor=expire<br /> |alignment=Vertical<br /> |structuredtext=To expire an API key, clear the '''Will never expire''' option and choose a date in the '''Expiration Date''' option.<br /> <br /> If a key is expired, the '''API Key Details''' view displays the date and time when the key expired. <br /> [[File:DC_api_keys_expire_info.png]]<br /> <br /> If you want to extend the expiry date, select a new date in the '''Expiration Date''' option.<br /> |Status=No<br /> }}{{Section<br /> |sectionHeading=Delete an API key<br /> |anchor=delete<br /> |alignment=Vertical<br /> |structuredtext=To delete a key, just click the delete icon ([[File:Des_PII_delete.png|link=]]). If you just want to disable the API key temporarily, consider changing the key's enable option instead.<br /> |Status=No<br /> }}{{Section<br /> |sectionHeading=Copy an API key<br /> |anchor=copy<br /> |alignment=Vertical<br /> |structuredtext=You can copy an existing API key with the '''Copy''' button ([[File:Des_PII_copy.png|link=]]). This opens the '''New API Key''' view with the copied API information. The name of the API key includes &quot;_''N''&quot;, where &quot;''N''&quot; is the number of the copy. For example: ''APIKEYtest_1'', ''APIKEYtest_2'', and so on.<br /> |Status=No<br /> }}{{Section<br /> |sectionHeading=Find an API key<br /> |anchor=find<br /> |alignment=Vertical<br /> |structuredtext=To search for an API key, use the search box above the table. The results filter automatically based on the text you enter in the search box. You can search for an API key name or the person who created the key.<br /> <br /> You can filter the available API keys by:<br /> <br /> *'''Status''' - ''Available'' (keys that are not revoked or expired), ''Unavailable'' (keys that are revoked or expired), and ''Soon Unavailable'' (keys that will be revoked or expire withing a month). Click on the button to toggle displaying the keys matching the selected option.<br /> *'''Permissions''' - Choose either ''Secure Mail'' or ''Chat'' from the dropdown to list keys that match the selected permissions.<br /> |Status=No<br /> }}<br /> }}</div>

WikiSysop