Product: Partner Portal 

Audience: Partner Admin, Partner Developer

 

My Apps is the dashboard you will be directed to when logging onto Classlink’s Partner Portal. Here you will be able to add and manage connections based on apps. 

 

 

Each app contains a Roster Server Connection, a Production OAuth2 Configuration, and a Test OAuth2 Configuration. The status of these connection setups can be easily identifiable by the status circle. 

• Green: Complete
• Orange: Incomplete
• Gray: Not Configured

 

Adding an App

To add an app to the dashboard, follow these steps:

1. Click Add App in the top left section of the page.

    

   

    

2. Enter the App Name.
3. Click Select to upload a logo or select from an existing one. When uploading, make sure the following conditions are met:
• The image format is PNG, JPG, or SVG 
• It is at least 100x100px (the image's width and height must be equal)
• Less than 500kb
  
  
  
  
4. Use the drop down under Domains to select an existing domain or add a new one. To add a domain, type in the name of the domain in the search box and then click Add New.

 

5.  If you would like to link the app to an existing Roster Server Connection, click Advanced Options on the bottom of the slide over and use the drop down to select a Roster Server Connection.

 

6.  Once finished, click Save

 

Managing Apps

 

To manage an app, click into the app on the My Apps Dashboard. On this screen you will be able to view the app's Connections and Details, as well as delete the app.

 

 

Connections

 

Partner Portal apps have two types of connections: Roster Server Connections and OAuth2 Configurations. A Roster Server Connection is a link between an app in the Partner Portal and an app in Roster Server. An OAuth2 Configuration is where Single Sign On for the app in LaunchPad is set up.

To add a Roster Server Connection:

1. Next to Roster Server Connection, click +.
   
   
   
   
2. Use the list on the slideover to choose a Roster Server Connection by clicking Link.
   
   
   
   
3. To add a new Roster Server Connection to link, click Add New.

 

If adding an initial Roster Server Connection, follow these steps:

1. Enter a Roster Server Connection Name.
2. The toggle button next to Production will mark the connection as Production or Beta.
3. Click Select to upload or select an existing app icon.
4. Click Save.
5. Use the next tab, Associated App, to select the app intended for the connection.
   
   

 

6.  OAuth2 Configurations are also edited on this page. Click on existing domains under Domains to manage and verify domains.

 

 

7.  Click the settings icon under LaunchPad Authorization URI to manage the OAuth2 Launchpad connection under the Authorization URL tab.

 

 

8.  Partners can certify an app by clicking Request Certification. The app’s connections and details are sent to a ClassLink Administrator when requesting a certification. Once a ClassLink Administrator has approved the app, the app will show that it is certified.

 

 

 

Note: Editing an app will decertify an app and a request to certify the app will be needed again. 

 

Details

 

On an app’s Details tab, you can add online links to easily access websites and online documents that give more information to the app. The App Links section provides a place to link your app's Website, Terms of Service, Privacy Policy, and Data Sharing Agreement. The Additional Links section allows you to link to any other relevant website. Click Save when finished to add your links. 

 

 

App Deletion

 

To delete an app, just click the Delete App button.

 

 

 

 Updated: June 2020