Welcome

Welcome to the MyLogin API documentation.

The MyLogin API allows you to authenticate your users using OAuth2 or SAML, providing users with one identity provider for their Chromebooks and Windows devices as well as your app.

We provide child-friendly login methods to your application by allowing your users to login with Emoji and Magic passwords to quickly authenticate children. We also support traditional username and password for older children.

View an example Laravel app here.

Testing

Once you have completed the integration development work we just need to test your flow is working properly.

Accessing test users in development mode

Until we have approved your application you are in ‘development mode’. While in this state we have set up some accounts that you can use for testing. If you add a 'Log in with MyLogin' button to your environment and then kick off the login flow you will be presented with these 4 users. You must be logged in to the developer account in your browser to access these test users, this prevents anyone else logging into your application.

Accessing test users - not logged in

If you are not logged in to the developer portal you will need to log in before you can access these test users

Accessing test users once approved

If your app has been approved, you can still access the test users if there’s something you need to test. Simply kick of the SSO flow from your app, search for Furlong School then click the 'Login as Developer' link which will give you access to the test users

SSO from Student Dashboard

Once you are happy that this flow works we need to test from our end. Please create accounts for the 4 test users (also found here) in your production environment. We can then test that we can log into your application from our dashboard with these users. There is no need to include the ‘Log In with MyLogin’ in your production environment at this stage, we can test from our dashboard. You can set that link up once the product is launched and your application has been approved. A working integrated app will look like this:

We redirect users to the redirect URI marked as primary in your developer area. Please ensure this is pointing at a redirect URI that will log one of our test users in for testing before your app is approved for organisation use.