Type Definitions
LoginOptions
- Source:
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
state |
string | An opaque value used by the client to maintain state between the request and callback. It's also recommended to prevent CSRF https://tools.ietf.org/html/rfc6749#section-10.12 |
|
acrValues |
string |
<optional> |
Authentication Context Class Reference Values. If
omitted, the user will be asked to authenticate using username+password.
For 2FA (Two-Factor Authentication) possible values are |
scope |
string |
<optional> |
The OAuth scopes for the tokens. This is a list of
scopes, separated by space. If the list of scopes contains |
redirectUri |
string |
<optional> |
Redirect uri that will receive the code. Must exactly match a redirectUri from your client in self-service |
preferPopup |
boolean |
<optional> |
Should we try to open a popup window? |
loginHint |
string |
<optional> |
user email or UUID hint |
tag |
string |
<optional> |
Pulse tag |
teaser |
string |
<optional> |
Teaser slug. Teaser with given slug will be displayed in place of default teaser |
maxAge |
number | string |
<optional> |
Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated. If last authentication time is more than maxAge seconds in the past, re-authentication will be required. See the OpenID Connect spec section 3.1.2.1 for more information |
locale |
string |
<optional> |
Optional parameter to overwrite client locale setting. New flows supports nb_NO, fi_FI, sv_SE, en_US |
oneStepLogin |
boolean |
<optional> |
display username and password on one screen |
prompt |
string |
<optional> |
String that specifies whether the Authorization Server prompts the
End-User for reauthentication or confirm account screen. Supported values: |
Type:
- object
SimplifiedLoginWidgetLoginOptions
- Source:
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
state |
string | function | An opaque value used by the client to maintain state between the request and callback. It's also recommended to prevent CSRF https://tools.ietf.org/html/rfc6749#section-10.12 |
|
acrValues |
string |
<optional> |
Authentication Context Class Reference Values. If
omitted, the user will be asked to authenticate using username+password.
For 2FA (Two-Factor Authentication) possible values are |
scope |
string |
<optional> |
The OAuth scopes for the tokens. This is a list of
scopes, separated by space. If the list of scopes contains |
redirectUri |
string |
<optional> |
Redirect uri that will receive the code. Must exactly match a redirectUri from your client in self-service |
preferPopup |
boolean |
<optional> |
Should we try to open a popup window? |
loginHint |
string |
<optional> |
user email or UUID hint |
tag |
string |
<optional> |
Pulse tag |
teaser |
string |
<optional> |
Teaser slug. Teaser with given slug will be displayed in place of default teaser |
maxAge |
number | string |
<optional> |
Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated. If last authentication time is more than maxAge seconds in the past, re-authentication will be required. See the OpenID Connect spec section 3.1.2.1 for more information |
locale |
string |
<optional> |
Optional parameter to overwrite client locale setting. New flows supports nb_NO, fi_FI, sv_SE, en_US |
oneStepLogin |
boolean |
<optional> |
display username and password on one screen |
prompt |
string |
<optional> |
String that specifies whether the Authorization Server prompts the
End-User for reauthentication or confirm account screen. Supported values: |
Type:
- object
HasSessionSuccessResponse
- Source:
Properties:
Name | Type | Description |
---|---|---|
result |
boolean | Is the user connected to the merchant? (it means that the merchant id is in the list of merchants listed of this user in the database)? Example: false |
userStatus |
string | Example: 'notConnected' or 'connected'. Deprecated, use
|
baseDomain |
string | Example: 'localhost' |
id |
string | Example: '58eca10fdbb9f6df72c3368f'. Obsolete |
userId |
number | Example: 37162 |
uuid |
string | Example: 'b3b23aa7-34f2-5d02-a10e-5a3455c6ab2c' |
sp_id |
string | Example: 'eyJjbGllbnRfaWQ...' |
expiresIn |
number | Example: 30 * 60 * 1000 (for 30 minutes) |
serverTime |
number | Example: 1506285759 |
sig |
string | Example: 'NCdzXaz4ZRb7...' The sig parameter is a concatenation of an HMAC SHA-256 signature string, a dot (.) and a base64url encoded JSON object (session). http://techdocs.spid.no/sdks/js/response-signature-and-validation/ |
displayName |
string | (Only for connected users) Example: 'batman' |
givenName |
string | (Only for connected users) Example: 'Bruce' |
familyName |
string | (Only for connected users) Example: 'Wayne' |
gender |
string | (Only for connected users) Example: 'male', 'female', 'undisclosed' |
photo |
string | (Only for connected users) Example: 'http://www.srv.com/some/picture.jpg' |
tracking |
boolean | (Only for connected users) |
clientAgreementAccepted |
boolean | (Only for connected users) |
defaultAgreementAccepted |
boolean | (Only for connected users) |
pairId |
string | |
sdrn |
string |
Type:
- object
HasSessionFailureResponse
- Source:
Properties:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error |
object |
Properties
|
|||||||||||||||
response |
object |
Properties
|
Type:
- object
SimplifiedLoginData
- Source:
Properties:
Name | Type | Description |
---|---|---|
identifier |
string | Deprecated: User UUID, to be be used as |
display_text |
string | Human-readable user identifier |
client_name |
string | Client name |
Type:
- object
SimplifiedLoginWidgetOptions
- Source:
Properties:
Name | Type | Description |
---|---|---|
encoding |
string | expected encoding of simplified login widget. Could be utf-8 (default), iso-8859-1 or iso-8859-15 |
Type:
- object