Feature: Authentication Keys

From Yombo
Jump to: navigation, search


Authentication Keys (authkeys) are used by applications and script to remotely access the Yombo Gataway API without requiring them to have the login credentials. Authkeys can be created by users or modules.


If a script, program, other other tool wants to access the Yombo Gateway API, an authkey can be used in place of the login credentials. This helps keep the account more secure by not having authentication credentials in various places. When needed, authkeys can be revoked or disabled.

Best practices

For every application or script that needs access, it's best to create a new authentication key for each one. This allows you to revoke access to a single application or replace the authkey if that application or script has been compromised.

Creating Authentication Keys

Authkeys can be created by users or modules. For creating authkeys inside modules, see Library: Authentication Keys.

To create a new authkey see Web Interface: Authentication Keys.

See Also

see: Atoms @ Yombo Python API Docs

This page was last edited on 23 July 2019.