Appendix D - Parameter captions
Helper parameter captions
The table below shows the captions that will be shown as tool tip texts for the Helper initialization parameters in the demo site tool. See Table 9 for a complete description of the parameters.
helperParams | Caption - English | Caption - Norwegian |
|---|---|---|
frameMode | Governs the browsing context of the client. | Angir visningsmodus for klienten. |
cid | A unique clientID received previously in initSession() response. | En unik klient-ID som mottas i initSession()-responsen. |
callback | A function that Helper will call upon client termination. If not provided the last received nextURL over a secure channel will be used to return control instead. | En funksjon Helper kaller når klienten terminerer. Hvis callback ikke er spesifisert vil sist mottatte nextURL benyttes. |
containerID | A reference to an element id in DOM where the client will be injected. | En referanse til elementid i DOM-noden hvor klienten blir injisert. |
height | The height of the iframe or window provided to the client. | Høyden på iframe eller vinduet klienten har tilgjengelig. |
width | The width of the iframe or window provided to the client. | Bredden på iframe eller vinduet klienten har tilgjengelig. |
positionX | Integer representing the left position of the window on the screen. | Integer som representerer venstre posisjon av vinduet på skjermen. |
positionY | Integer representing the top position of the window on the screen. | Integer som representerer øverste posisjon av vinduet på skjermen. |
errorRedirectUrl | Location to redirect to in case of an initialization error if frame mode is "redirect". | Adresse for viderekobling hvis det oppstår en initialiseringsfeil når visningsmodus "redirect" er valgt. |
sessionCookie | Key/value pair for transferring any merchant cookies back to Merchant through the Client proxy. Optional. | Nøkkel/Verdi-par for å kunne sende brukerstedscookies tilbake til brukerstedet via Client proxy. Valgfri. |
windowWidth | The desired window width in pixels provided to the Web-client if frameMode == window. Optional. Default value: 350. | Den ønskede vindusbredden i piksler tildelt Web-klienten hvis frameMode == window. Valgfri. Defaultverdi = 350. |
windowHeight | The desired window height in pixels provided to the Web-client if frameMode == window. Optional. Default value: 500. | Den ønskede vindushøyden i piksler tildelt Web-klienten hvis frameMode == window. Valgfri. Defaultverdi = 500. |
Table 19 – Helper parameter captions
initSession parameter captions
The table below shows the captions that will be shown as tool tip texts for the BankID Web-client initialization parameters in the demo site tool. See Table 11 for a complete description of the parameters.
Key | Caption - English | Caption - Norwegian |
|---|---|---|
action | The type of BankID operation to be initiated. | Type BankID-funksjon som skal starte. |
localeId | The wanted language of the client. | Ønsket språk for klienten. |
nextURL | An error fallback URL used by the client if any error occurs. Note: The URL must use SSL. Optional. | Fallback URL som brukes av klienten hvis det oppstår feil (må bruke SSL). Valgfri. |
merchantURL | The merchant endpoint of the merchant protocol, must use SSL. | Brukerstedets endepunkt i brukerstedsprotokollen (må benytte SSL). |
timeout | The time, in milliseconds, the client will wait for a response from the merchant application. Optional. Default value: 40000. | Tiden (i millisekunder) klienten vil vente på respons fra brukerstedsapplikasjonen. Valgfri. Defaultverdi: 40000. |
sid | A sessionID set by merchant. Optional. | Sesjons-ID satt av brukerstedet.Valgfri. |
certType | Lists the BankID certificate types that the application accepts. Optional. Default value: comes from the merchant config. | Lister BankID sertifikattyper brukerstedet aksepterer. Valgfri. Defaultverdi: hentes fra brukerstedskonfigurasjonen. |
showUnderstanding | Determines if the text "Jeg har lest og forstått innholdet" (including the checkbox) will be visible or not. Optional. Default value: "Y". | Bestemmer om teksten "Jeg har lest og forstått innholdet" (inkludert avkrysningsboks) skal vises eller ikke. Valgfri. Defaultverdi: "Y". |
showConfirmation | During a signing process where an SDO receipt is received at the client, this flag controls whether a "confirmation of signing complete" message is to be presented. Optional. Default value: "Y". | Bestemmer om bekreftelse på fullført signering skal vises i signeringsprosessen hvor en SDO-kvittering mottas i klienten. Valgfri. Defaultverdi: "Y". |
suppressBroadcast | Suppress any broadcast message from COI. Optional. Default value: "N". | Skjuler kringkastingsmeldinger fra FOI. Valgfri. Defaultverdi: "N". |
extPDFDomain | Display of PDF by external application. Conditional. Only mandatory if action = "sign. | Ekstern visning av PDF. Betinget. Kun påkrevd hvis action = "sign".x |
docDisplayMode | Determines how external documents to be signed will be displayed. Optional. Only mandatory if action = "sign". | Bestemmer hvordan eksterne XXXocumenter til signering skal vises. Valgfri. Kun påkrevd hvis action = "sign". |
merchantFEDomain | The expected domain of the Helper, as seen from the client. | Forventet domene for Helper, sett fra klienten. |
merchantFEAncestors | The chain of domains used in an iframe in iframe-scenario. Optional. | Den nøstede rekkefølgen av domenenavn som benyttes i et iframe i iframe-scenario. Valgfri. |
userAgent | The end user's UA-string. | Sluttbrukerens UA-streng. |
withCredentials | Set CORS credentials to true in order to include any Merchant cookies. Optional. Default value: "N". Not applicable for signing in 2.1 | Setter CORS credentials til "true", for å inkludere cookies fra brukerstedet. Valgfri. Defaultverdi: "N". Ikke relevant for signering i 2.1. |
clientProxyURL1 | The URL of the Client proxy used by the Merchant. Optional. If not provided by Merchant, the default Client proxy will be used. | URL til Client proxy benyttet av brukerstedet. Valgfri, hvis ikke oppgitt benyttes sentral Client proxy automatisk. |
clientProxyPublicKey | The public RSA key the client will use to encrypt requests to the Client proxy. Optional. If not provided by Merchant, a centrally stored key will be used. | Offentlig RSA nøkkel som klienten skal benytte for å kryptere meldinger til Client proxy. Valgfri, hvis ikke oppgitt benyttes automatisk nøkkel lagret i sentral infrastruktur. |
clientSessionTimeout | The time, in milliseconds, the client session will live according to the merchant application. Optional. Default value: 1800000 ms. | Tiden, i millisekunder, klientsesjonen er gyldig i følge brukerstedsapplikasjonen. Valgfri, standardverdi er 1800000 ms. |
clientVersion | The desired BankID version to be used for document signing. Optional. Default value: "2.0". | Brukerstedets ønskede versjon for dokumentsignering, 2.0 eller 2.1. Valgfri, standardverdi er «2.0». |
Table 20 – Client parameter captions
1 Default Client proxy in production: https://cp.bankid.no/clientproxy and in pre-production: https://cp-preprod.bankid.no/clientproxy