Breadcrumbs

Add an application

The add function does not capture every element necessary to be production ready, only enough to set up the basics so that developers can move the software side forward without delay. There will be further steps to take before your application is ready to go live for our mutual customers.

Create an OpenID Connect application

  1. Log in to the service provider dashboard as an administrator and go to Applications.

    Main applications page. Following the page title and intro text is a button labeled 'Add application'.

  2. Press the Add application button. A pop-up window opens, asking you to choose the type of application.

    Pop-up window titled 'Add application'. Following the question 'What type of resource do you want to connect' is a choice of two options, 'Open ID relying party' and 'Existing SAML entity'. 'OpenID Connect relying party' is selected. At the bottom of the window are 'Next' and 'Cancel' buttons.

  3. Choose OpenID Connect relying party and click Next.

    Form headed 'New OpenID Connect application'. There are three text input fields, all marked as mandatory - 'Name', 'Application URL' and 'Redirect URL'. There is also a setting called 'Connect via', which can be set to either 'A new connection' or 'An existing connection'. At the bottom of the form are buttons marked 'Create application' and 'Cancel'.

  4. In the Name field, enter a name for your application. Eventually this will be customer facing, but for now it can be anything.

  5. In Application URL, enter the root web address of the application. For example, https://login.yourdomain.com.

  6. In Redirect URL, enter the address to which users will be returned after authentication. If you’re not yet sure of this, enter a placeholder for now and change it later.

  7. Unless you are migrating from one OIDC application to another, set Connect via to A new connection. If you are migrating from an existing application, select An existing connection.

  8. Click the Create application button. This creates the application record and a Keystone connection.

    Confirmation page titled 'New OpenID Connect application'. It reads, 'Your application has been created. A connection has also been set up to connect your application to your selected identity providers.' Links to suggested next steps follow this message.

For further configuration settings, see Edit an application.

Create a SAML application

  1. Log in to the service provider dashboard as an administrator and go to Applications.

    Main applications page. Following the page title and intro text is a button labeled 'Add application'.

  2. Press the Add application button. A pop-up window opens.

    Pop-up window titled 'Add application'. Following the question 'What type of resource do you want to connect' is a choice of two options, 'Open ID relying party' and 'Existing SAML entity'. 'Existing SAML entity' is selected. At the bottom of the window are 'Next' and 'Cancel' buttons.

  3. Choose Existing SAML entity and click Next.

    Page titled 'Add a SAML service provider, step 1 of 2'. Advisory text reads, 'To add an entity you must supply a SAML metadata document for the service provider you wish to add. You may do this by either providing a URL for uploading the metadata as a file.' Following this are an input field labeled 'Metadata URL' and a button to upload a metadata file. At the bottom of the page are 'Next' and 'Cancel' buttons.

  4. Either:

    1. Enter the URL of your SAML entity’s metadata in the Metadata URL field, or

    2. Press the Choose File button and upload an XML metadata file from your computer.

  5. Press Next.

  6. You will be shown the details of the provided metadata. Confirm that you want to use this metadata and then press Create application to finish.

  7. This creates the application record. You will still need to add the OpenAthens Federation metadata to your SP.

For further configuration settings, see Edit an application.