Our SSO API

You can use our Single Sign On (SSO) API to perform different tasks, for example you can use it to register for an account, or use it to sign into an existing account in our system.

When you register for an account in our portal, it does two things:

• Sets up an account in our SSO database,
• Adds you as a user to the portal you're registering to (this essentially gives you very minimal access to the portal, further access has to be applied for).

To understand more about our SSO API, you can view more details about the possible requests you can make in our SSO Metadata grid.

Registering using our API

The first thing you have to do is build out your registration request, this will look something like this:

HTTP POST https://<AppURL>/Api/Account/Login

        {
            DisplayName: "Joe Bloggs",
            Email:"joe.bloggs@corporatelinx.com",
            Password:"superSecretPassword123!!",
            Culture: "en-GB",
            PhoneNumber: "01234 567 890",
            AppId: 0
        }

AppId is an optional field (it doesn't matter if you don't have one, providing one will automatically register the account with in the app with that particular Id).

The rest of this information is standard information that you would expect to have to provide on any account creation.

Logging in using our API

You can now use the details you just set up to authenticate and get a token. This request will look something like this:

HTTP POST https://<AppURL>/Api/Account/Login

        {
            User: “joe.bloggs@corporatelinx.com”,
            Pass: “superSecretPassword123!!"
        }

When this request is made, the server responds with a token which can be used in all subsequent calls you make to the API.