Keys & IDs

Details on your OneSignal App Id, REST API Key, User Auth Key management, and manually disabling your app.

Settings > Keys & IDs

This section contains details on the selected OneSignal App.

App ID

Your OneSignal App ID (or just App ID) is the main identifier we use to differentiate your app from all other OneSignal apps. You will use this in all your SDK initialization codes and API calls. The App ID should not be treated as private.



Do not share this key

Treat your REST API Key as though it is a password - do not add it to your app code or public repositories (e.g. github) and do not share it with anyone.

The App Auth Key serves as the API Key to our REST APIs. You can find this key on your app's Keys & IDs page in the OneSignal Dashboard. Include this key in the Authorization header using the Basic Authentication scheme e.g., Basic REST_API_KEY.

Resetting your REST API Key

Visit Settings > Keys & IDs and click Generate New API Key to destroy the current REST API key and generate a new one.

Disabling Your App

You may disable your app to prevent new and scheduled notifications from being delivered.

You will still receive new subscribers if you disable the app. You must remove or comment out the OneSignal code to stop new subscriptions.

Apps you manually disable can be instantly re-enabled at any time.

User Auth Key

Your User Auth Key, which can be found at the top right within Account & API Keys, manages operations outside of an app (e.g. creating an app). Click on the account dropdown on the top right of your dashboard and scroll down to the User Auth Key section. It is past the section that displays each of your app's auth keys.

The User Auth Key is unique to each user and is used for adding and modifying apps through the API. Please see the create an app and Update an app endpoints for how to use this.

Generate New User Auth Key

If you reset your User Auth Key, you will receive an email letting you know this occurred.

What’s Next