Oomnitza API tokens FAQ

What happens if a user does not have access permissions when using the API token?

When using an API token, the token will inherit the permissions of the role that the user is assigned. If the user does not have access permissions to a particular object, attempting to access that object will result in a Forbidden (403) error. To avoid this, it is recommended that you check the role permissions for the user in the Credentials tab under Security > Roles > Permissions before using the API token.

What happens if a user is revoked when using the API token?

If a user is revoked, attempting to use their API token will result in an Unauthorized (401) error. To resolve this, simply create a new API token.

What happens if a user is archived when using the API token?

If a user is archived, attempting to use their API token will result in an Unauthorized (401) error. To fix this, you can either restore the archived user or create a new user and generate a new API token for them.

When credentials are migrated that use Oomnitza API tokens, do you need to generate a new API token?

API tokens that you generate in Oomnitza are specific to that Oomnitza instance. Let's say you migrate credentials that use an Oomnitza API token from a development or test Oomnitza instance to a production instance. In the production instance, you must edit the credentials and replace the Oomnitza API token with a new API token that you generate in the production instance.