Via API

Log brugere ind via API med brugerdefinerede sessionstokens.

Brugerdefineret login via API er kun muligt, når det er aktiveret fra backend af Ideanote. Kontakt os, hvis du gerne vil bruge denne godkendelsesmetode.

Denne artikel beskriver, hvordan du logger brugeren ind i browseren ved hjælp af Ideanote API. Denne teknik kan bruges, når JWT, SAML eller OpenID ikke er en mulighed. Følg disse trin for at logge brugeren ind:

  1. Opret eller opdater brugeren, og hent brugerens sessionstoken.
  2. Generér et link ved hjælp af sessionstokenet, som kan bruges til automatisk at logge brugeren ind i browseren.

Opret eller opdater brugeren, og hent sessionstokenet.

Følgende JSON-endpoint opretter automatisk brugeren, hvis vedkommende ikke findes, eller opdaterer brugeren, hvis vedkommende allerede findes. Endpointet returnerer et sessionsobjekt med et sessionToken.

POST https://api.ideanote.io/v1/session?fields=kind,user.id,sessionToken

Parametre for brødtekst:

Navn

Beskrivelse

spaceId

ID'et på dit workspace

type

Denne nøgle skal altid have værdien: CUSTOM

oplysninger

Et dataobjekt, der beskriver brugeroplysningerne
Navn
Beskrivelse
email (påkrævet)
Brugerens e-mailadresse. Vi afgør, om der allerede findes en bruger på workspacet, ved at finde en eksisterende bruger med denne e-mailadresse.
apiToken (påkrævet)
API-tokenet for en ejerkonto på dit workspace. Dette API-token kan hentes på /settings/profile i Ideanotes webapp
sub
Valgfrit unikt ID, der bruges til at finde en eksisterende bruger på Ideanotes workspace. Hvis sub ikke er angivet, bruges email i stedet til at finde en eksisterende bruger.
name
Brugerens navn
avatarUrl
Et link til et billede, der skal bruges som avatar for denne bruger.
team
Et teamnavn, som brugeren skal føjes til. Teamet oprettes, hvis det ikke allerede findes.
locale
Brugerens lokalitet

Navn

Beskrivelse

e-mail (påkrævet)

Brugerens e-mailadresse. Vi afgør, om der allerede findes en bruger på workspacet, ved at finde en eksisterende bruger med denne e-mailadresse.

apiToken (påkrævet)

API-tokenet for en ejerkonto på dit workspace. Dette API-token kan findes under /settings/profile i Ideanotes webapp

under

Valgfrit unikt ID, der bruges til at finde en eksisterende bruger på Ideanote-workspacet. Hvis sub ikke angives, bruges e-mail i stedet til at finde en eksisterende bruger.

navn

Brugerens navn

avatarUrl

Et link til et billede, der skal bruges som avatar for denne bruger.

team

Et teamnavn, som brugeren skal føjes til. Teamet oprettes, hvis det ikke allerede findes.

sprogindstilling

Brugerens landestandard

Eksempel på anmodning:

Bash

 
curl "https://api.ideanote.io/v1/session?fields=kind,user.id,sessionToken" \
  -H "Content-Type: application/json" \
  -d '{
"spaceId": "b06f0a9a-4813-4515-81a0-29e8f2d193ec",
"kind": "CUSTOM",
"data": {
  "email": "john@doe.com",
  "apiToken": "f2dacce1fe557c7f140a3f7e85",
  "name": "John Doe",
  "avatarUrl": "https://avatars.githubusercontent.com/u/1234"
}
}'

Eksempel på resultat:

JSON

 
{  "sessionToken":"41b0d309e0e4a341eccf611f9a70cbb91a6a_164864564232",  "user": ...}

Når du har hentet brugerens sessionToken, kan du generere et link, der kan bruges til at logge brugeren direkte ind i browseren.

https://{{SUBDOMAIN}}.ideanote.io/login/session/{{SESSION_TOKEN}}

Eksempel:

Automatisk

https://mysubdomain.ideanote.io/login/session/41b0d309e0e4a341eccf611f9a70cbb91a6a_164864564232

Først skal du hente et widgetlink. Du finder det ved at dele en mission, redigere indlejringskoden og hente et widgetlink til en "full page".

Derefter skal du udvide URL'en med forespørgselsparameteren: &auth.sessionToken={{SESSION_TOKEN}}.

https://idea-widget.ideanote.io/idea-confirmation?config={{WIDGET_ID}}&auth.sessionToken={{SESSION_TOKEN}}

Eksempel:

Automatisk

https://idea-widget.ideanote.io/idea-confirmation?config=df828665bf&auth.sessionToken=41b0d309e0e4a341eccf611f9a70cbb91a6a_164864564232