About the URLs

GUI flows describe transitions between different GUI states. Some states visible to the user and wait for user input while other states are only for computation and immediately trigger events for transitioning to other states. Transitions between states are caused by events and flows may specifiy that certain states should be selected when certain events are triggered. If an event is not mentioned anywhere in the flow then the next state will be selected. For example, a continueEvent usually has no specific state connected to it but instead causes the next state to be selected.

Sequences are fragments of a flow that can be re-used in different URLs, like the simpleAuthenticationSequence. Sequences and states can be used interchangably in flows, as both result in new events being triggered. The difference is that for a sequence, some events will be handled internally in the sequence. Only events which are not handled internally in the sequence will cause a transition to a state outside the sequence.

Access the URLs using the loginServer.

GUI: createUserUrl

You can redirect a user’s browser to this URL in order to ensure that the user has a ConnectID account and is logged in.

If the user already is logged in with the specified credential, or the user already is logged in and no credential parameter is specified, then the user’s browser will immediately be redirected back to the returnUrl.

Otherwise, the user is asked to log in using a one time password but can also log in using an existing ConnectID account or create a new account. The credential field will have the value of the credential parameter when the GUI is shown, but the user can edit this field and thus log in with a different credential.

If the user already is logged in with a different credential then the user will be logged out from that credential and logged in with the new credential. If the user leaves the the remember me option checked then the rememberMeCookie for this client will be set according to the new credential. If the the user unchecks the the remember me option but a rememberMeCookie exists for this client then that cookie will be not be removed.

This URL behaves similarly to the loginUrl but is better suited if it is likely that the user does not already have a ConnectID account.

Server: loginServer

Relativ path: createUser

Method: GET

URL parameters	Description	Required
clientId	The unique ID of the client, e.g. no.mediaconnect.test	✔
returnUrl	A URL to redirect the user’s browser back to on success (the user will be logged in)	✔
errorUrl	A URL to redirect the user’s browser back to if something goes wrong (the user might not be logged in)	✔
credential	If specified, the credential field will have this value when the GUI is shown but will still be editable by the user (however, no GUI will be shown if the user already is logged in with this credential or if the user already is logged in and this parameter is not specified)
credentialSubmit	If this parameter is set (credentialSubmit=true) will be submit the form with credential given as credential parameter.
assumeNewUser	If true then ask for verification code password first, if false then ask for account password first. Default true for this URL.

GUI: loginUrl

You can redirect a user’s browser to this URL to let the user log in.

Otherwise, this URL works just like the oauthAuthorizationEndpoint except that it does not return an oauth authentication code to the caller. The user can either log in using an existing ConnectID account or create a new account. The credential field will have the value of the credential parameter when the GUI is shown, but the user can edit this field and thus log in with a different credential.

If the user already is logged in with a different credential then the user will be logged out from that credential and logged in with the new credential. If the user leaves the the rememberMeCheckbox checked then the rememberMeCookie for this client will be set according to the new credential. If the the user unchecks the the rememberMeCheckbox but a rememberMeCookie exists for this client then that cookie will be not be removed.

This URL behaves like the createUserUrl but is better suited if it is likely that the user already has a ConnectID account.

Server: loginServer

Relativ path: login

Method: GET

URL parameters	Description	Required
clientId	The unique ID of the client, e.g. no.mediaconnect.test	✔
returnUrl	A URL to redirect the user’s browser back to on success (the user will be logged in)	✔
errorUrl	A URL to redirect the user’s browser back to if something goes wrong (the user might not be logged in)	✔
credential	If specified, the credential field will have this value when the GUI is shown but will still be editable by the user (however, no GUI will be shown if the user already is logged in with this credential or if the user already is logged in and this parameter is not specified)
assumeNewUser	If true then ask for verification code first, if false then ask for account password first. Default false for this URL.

GUI: loginCheckUrl

Check whether a user is already logged in and redirect to either the returnUrl if she is logged in or to the errorUrl if she is not.

This URL be used in many ways:

Redirect here before displaying a page to known whether to display on your page that the user is logged on or not.

Send an ajax request to let javascript on your page know wheter the user is logged in.

Use as the src parameter in a <script> tag to load different script depending on whether the user is logged in, e.g.

If the user is logged in, you can redirect to the oauthAuthorizationEndpoint to get a token to use with the API calls in order to find out the customer number and other information.

This URL will look for the user’s rememberMeCookie and automatically log in the user if it is valid.

This URL will extend the lifetime of the user’s session, preventing automatic logout in the same way as if the user had visited the GUI.

If the user is not logged in but has a valid remember me cookie, then the user will be logged in and the user’s browser will immediately be redirected back to the returnUrl.

If the user is not logged in and does not have a valid remember me cookie, then user’s browser will immediately be redirected back to the errorUrl.

Server: loginServer

Relativ path: loginCheck

Method: GET

URL parameters	Description	Required
clientId	The unique ID of the client, e.g. no.mediaconnect.test	✔
returnUrl	A URL to redirect the user’s browser back to on success (the user will be logged in)	✔
errorUrl	A URL to redirect the user’s browser back to if something goes wrong (the user might not be logged in)	✔
credential	If specified, the “already logged in” check will be done with this credential

URL: azure

This url is used to setup an already logged in connectid user for azure active directory (Microsoft Entra ID).

This only works if the user is already logged in, there exists a configuration for azure active directory, if the user havent already registered for this service, that the user is registered in their respective azure active directory tenant.

Server: loginServer

Relativ path: azure/{id}?returnUrl={returnUrl}

Method: GET

URL parameters	Description	Required
id	The id for which is the configuration to use for this process.	✔
returnUrl	A URL to redirect the user’s browser back to. If success (the user will be logged in and validated for azure active directory access) this will be {returnUrl}/callback?azureStatus=success. If something went wrong (error occured) this will be {returnUrl}/callback?azureStatus=error.	✔

URL: logout

You can redirect a user’s browser to this URL to log the user out. This will invalidate the user’s ConnectID session so that the user must log in on the next visit to this client (and to other clients which do not have rememberMeCookies).

If the user did not uncheck the rememberMeCheckbox during a previous login to this client and therefore has a rememberMeCookie for this client then this rememberMeCookie will also be removed.

However, rememberMeCookies for other clients will not be removed. If the user logs out from the client specified by the clientId parameter (let’s call that client A) but has a rememberMeCookie for another client (client B) and visits client B after logging out from client A then the user’s ConnectID session will be recreated. If the user then visits client A again before the ConnectID session expires (20 minutes) then the user will be automatically logged back in to client A.

If a user is using a shared computer, for example in an internet cafe, and visits protected content belonging to two different clients (let’s call them A and B) within a period of time shorter than the ConnectID session duration (20 minutes) then the ConnectID login prompt will only be displayed for the first client (let’s call that client A). If the user does not uncheck the rememberMeCheckbox during login to client A then the user must remember to log out of client A before leaving the internet cafe to prevent the next user of the shared computer from gaining access to the ConnectID account.

Server: loginServer

Relativ path: logout

Method: GET

URL parameters	Description	Required
clientId	The unique ID of the client, e.g. no.mediaconnect.test	✔
returnUrl	A URL to redirect the user’s browser back to on success (the user will be logged in)	✔
errorUrl	A URL to redirect the user’s browser back to if something goes wrong (the user might not be logged in)	✔

URL: register

You can redirect a user’s browser to this URL to let the user search for an existing subscription registered in Connect and tie the ConnectID user to that subscription.

If the user is not already logged in or the credential parameter is specified but the user is logged in with a different credential then the user will first be required to either log in or verify a credential using a one time password.

Server: loginServer

Relativ path: register

Method: GET

URL parameters	Description	Required
clientId	The unique ID of the client, e.g. no.mediaconnect.test	✔
returnUrl	A URL to redirect the user’s browser back to on success (the user will be logged in)	✔
errorUrl	A URL to redirect the user’s browser back to if something goes wrong (the user might not be logged in)	✔
credential	If specified, the credential field will have this value when the GUI is shown but will still be editable by the user (however, the credential field will not be editable if the user already is logged in with this credential or if the user already is logged in and this parameter is not specified)
credentialSubmit	If this parameter is set (credentialSubmit=true) will be submit the form with credential given as credential parameter.

URL: resetPassword

You can redirect a user’s browser to this URL to let the user change password.

Server: loginServer

Relativ path: resetPassword

Method: GET

URL parameters	Description	Required
clientId	The unique ID of the client, e.g. no.mediaconnect.test	✔
returnUrl	A URL to redirect the user’s browser back to on success (the user will be logged in)	✔
errorUrl	A URL to redirect the user’s browser back to if something goes wrong (the user might not be logged in)	✔
credential	If specified, the credential field will have this value when the GUI is shown but will still be editable by the user (however, the credential field will not be editable if the user already is logged in with this credential or if the user already is logged in and this parameter is not specified)
credentialSubmit	If this parameter is set (credentialSubmit=true) will be submit the form with credential given as credential parameter.

URL: merge

You can redirect a user’s browser to this URL to let the user merge with other user/credential or just add other e-mail or mobile phone as new login credential. After that user will have possibility to log in with added credential using same password.

User shall be already logged in, but if the user is not already logged in will be prompt to login.

Server: loginServer

Relativ path: merge

Method: GET

URL parameters	Description	Required
clientId	The unique ID of the client, e.g. no.mediaconnect.test	✔
returnUrl	A URL to redirect the user’s browser back to on success (the user will be logged in)	✔
errorUrl	A URL to redirect the user’s browser back to if something goes wrong (the user might not be logged in)	✔
abortUrl	A URL to redirect the user’s browser back to if user click on close widget (X) in gui, close component is not visible as default.
heading	It is possible to change the default heading in the gui, just with sending this param in url
credentialType	If type is not specified then is allowed to put e-mail or mobile, if is set to A - then e-mail is required, if B - mobile is required. Texts on gui will change depends of this credential type.

URL: activateMembership

You can redirect a user’s browser to this URL to let the user search for an existing subscription registered in other partner membership system and tie the ConnectID user to that subscription.

Server: loginServer

Relativ path: activateMembership

Method: GET

URL parameters	Description	Required
clientId	The unique ID of the client, e.g. no.mediaconnect.test	✔
returnUrl	A URL to redirect the user’s browser back to on success (the user will be logged in)	✔
errorUrl	A URL to redirect the user’s browser back to if something goes wrong (the user might not be logged in)	✔
credentialType	If specified, the credential field will have this value when the GUI is shown but will still be editable by the user (however, the credential field will not be editable if the user already is logged in with this credential or if the user already is logged in and this parameter is not specified)

URL: fulfillment

After placing an order to the client order API or order API, redirect the user to this URL for fulfillment. Depending on the payment method on the order the user will be further redirected to an external payment service.

Server: loginServer

Relativ path: fulfillment

Method: GET

URL parameters	Description	Required
orderId	Order ID returned from the order API. Can be list of orders, but orders need to be from same merchant group id and with same paymentMethod - creditcard.	✔
returnUrl	The (absolute) URL the user will be redirected to after the fulfillment is completed.	✔

Return URL parameters:

When the user is redirected a parameter is added to the return URL. The parameter is fulfillmentStatus and will it will have one of the following values:

fulfillmentStatus value	Description
success	Indicating that the fulfillment was successful.
cancel	Some payment methods allow the user to cancel the payment.
error	An error occured.
unknown	Unknown status, is only when was send with more than one order, and something goes wrong with at least one of them.

GUI: createUserUrl#

GUI: loginUrl#

GUI: loginCheckUrl#

URL: azure#

URL: logout#

URL: register#

URL: resetPassword#

URL: merge#

URL: activateMembership#

URL: fulfillment#

GUI: createUserUrl

GUI: loginUrl

GUI: loginCheckUrl

URL: azure

URL: logout

URL: register

URL: resetPassword

URL: merge

URL: activateMembership

URL: fulfillment