Manage API access Praxis Desk

The overview shows all API access credentials you've created. You can change their permissions afterwards and revoke them at any time.

Where do I find API access credentials?

Open Settings > OAuth / API. The list shows all access credentials you've created.

Prerequisites

• You have the OAuth API-Clients verwalten permission in your Offisy account.
• You're an employee of the company. As a cooperation partner, you can't manage another company's API access.

Data table

The list shows the following information for each access credential:

Column	Description
Name	The name assigned to this access credential.
Created by	Which user created it.
Created on	Date of creation.
Active scopes	Which permissions this access credential has.
Permissions changed	Date and user of the last change. Shown only if the permissions have been changed at least once.

The list shows only the most recent change, not a full history.

Change permissions

You can adjust the permissions of an existing access credential at any time, without revoking it.

1. Open the action menu of the access credential and select Edit permissions.
2. Choose Full access or Custom.
3. With Custom, set the permissions you want. See Understanding scopes for details.
4. Click Save.

If you remove permissions, the dialog shows a warning naming the affected permissions before you save.

Save stays disabled as long as you haven't changed anything, or if no permission at all is selected.

You cannot change the name and description of an access credential, only its permissions.

Note: The change takes effect immediately, in both directions. Existing tokens gain new permissions without being renewed, and a removal applies just as immediately and can break a running integration right away. Client ID and Client Secret stay the same.

Revoke API access

1. Select the access credential you want to revoke.
2. Click Revoke.
3. Confirm in the confirmation dialog.

All tokens for this access credential become invalid immediately. External applications using it lose access right away.

Note: A revoked access credential cannot be restored. You need to create a new one. If you only want to correct the permissions, use Edit permissions instead. Client ID and Client Secret stay the same.

Note: An API access credential works only as long as its owner is active. When the owner is deleted, Offisy revokes their API access credentials automatically.