Api Keys

The API Keys screen lets administrators manage the API keys used to authenticate external applications and integrations with ROGER365. Each key is limited to one or more scopes, which determine what the key is allowed to access.

API key list

The page header shows the Total number of configured API keys. Use Rows per page to change how many entries are shown at once. Each row shows:

• ID: the unique number of the API key.
• Description: a name that helps you recognize what the key is used for, for example Custom Replicator. The column can be filtered.
• Value: the API key itself. Only the first characters are shown, and the rest is masked for security.
• Scopes: the scope(s) the key is allowed to use, for example Replicator. The column can be filtered.
• Actions: the buttons at the end of each row (see below).

‍

Actions per API key

• Edit (pencil icon): change the settings of the API key.
• Regenerate (circular arrow icon): generates a new value for the key. As with a new key, the full value is only shown once. Applications that still use the old value can no longer authenticate until they are updated with the new value.
• Delete (red trash icon): remove the API key. Applications that use this key lose access.

‍

Adding an API key

Select Add New in the top right to open the Create API Key form. Fill in the following fields:

• Description (required): a name that helps you recognize what the key is used for, for example Example Custom Replicator.
• Scopes: select one or more scopes from the drop-down list to define what the key is allowed to access.

Select Save to create the API key. Use the X in the top right to close the form without saving.

‍Important: The full value of the API key is only shown once, when you create it. Copy it immediately and store it securely, as it cannot be viewed again later. If you lose the value, use the regenerate action to get a new one.