Manage registered cloud apps

Registered cloud apps in the Knox Developer Portal allow you to integrate your applications with Knox cloud services using OAuth 2.0 authentication. Each registered app is assigned a unique client ID and client secret that are used to obtain access tokens for API calls.

Before you begin managing your registered cloud apps, ensure you have:

• A Knox Developer account

• Access to the Knox Developer Portal

• The super admin role in Knox Admin Portal, which enables you to view, create, update, or delete cloud apps

Rotate the client secret for your registered cloud app

To rotate the client secret for a registered app:

1. In the Knox Developer Portal, go to WEB INTEGRATIONS > Cloud Apps from the landing page, or go to Cloud Apps on the navigation pane.

2. Follow one of the following options:

   • If the client secret wasn’t created or rotated in the current session — find your registered app in the APP NAME column, and click on the gear icon in the corresponding CLIENT SECRET field.

     This method doesn’t work if the client secret is created or rotated in the current session.

     

   • If the client secret was created or rotated in the current session — click the name of the registered app in the APP NAME column. The App Details page opens.

     

3. Click ROTATE SECRET to get a new client secret for your app.

   This action can’t be undone.

   

4. The Client Credentials page opens, where you can view and copy the new rotated client secret from the Your Client Secret field.

   

Update a registered cloud app

To modify details of your registered app:

1. In the Knox Developer portal, go to WEB INTEGRATIONS > Cloud Apps from the landing page, or go to Cloud Apps on the navigation pane.

2. In the APP NAME column, click an app to modify its attributes.

3. In the App details page, modify values as needed. You can modify fields under BASIC INFORMATION, GRANT TYPES, CONSENT SCREEN, EXPIRATION TIME, and SCOPE.

4. Click SAVE CHANGES.

Delete a registered cloud app

To delete your registered app:

1. In the Knox Developer portal, go to WEB INTEGRATIONS > Cloud Apps from the landing page, or click on Cloud Apps in the navigation pane.

2. In the APP NAME column, click the app you want to delete.

3. Scroll down on the App details page, and click DELETE APP.

4. The Delete confirmation pop-up appears. To confirm deletion, type the name of the app you want to delete, and click DELETE APP.

   This action can’t be undone.

   

Troubleshooting

Issue: I can’t see my client secret

• Solution: Client secrets are only visible when created in the current session. If you need to retrieve a client secret created in a previous session, you must rotate the secret to generate a new one.

Issue: I can’t rotate my client secret using the gear icon

• Solution: This method only works for client secrets created in previous sessions. If the secret was created or rotated in the current session, you must use the App Details page to rotate it.

Issue: My app doesn’t appear in the Cloud Apps list

• Solution: Verify you’re looking in the correct section (WEB INTEGRATIONS > Cloud Apps) and that you have the proper permissions to view the app.

Best practices

1. Regularly rotate client secrets: For security reasons, rotate your client secrets periodically, especially if you suspect they may have been compromised.

2. Limit scope permissions: Only grant the minimum scopes required for your application to function properly.

3. Secure storage: Never store client secrets in plain text or in version control systems. Use secure storage mechanisms appropriate for your environment.

4. Monitor app usage: Regularly review your app’s access logs and permissions to ensure they align with your security policies.

5. Backup configuration: Keep a secure backup of your app configurations, especially before making significant changes.