Du kan provisjonere og administrere brukere i Motimate ved å koble kildesystemet ditt til vår REST API. Dette gjør det mulig å automatisere og håndtere flere administrative oppgaver i Motimate via API, som å opprette, oppdatere, og slette brukere, opprette og administrere grupper, samt tilordne brukere til riktige grupper.
For generell informasjon om Motimate Public API og hvordan du kommer i gang, se her.
Bakgrunnsinformasjon:
- Alle brukere og grupper har sine unike Motimate-ID-er som kan brukes med API-et, men du kan også definere en "external ID" som du kan bruke med API-et. Denne "external ID" er vanligvis satt til å matche ID-en du har for brukeren eller gruppen i din egen datakilde.
- Grupper brukes til å opprette en hierarkisk struktur eller gruppetre. Dette vil vanligvis speile organisasjonsstrukturen din og brukes til å delegere opplæring og hente ut rapporter. Strukturen er ofte basert på enten avdelinger og team eller regioner. Vi anbefaler å opprette grupper før du oppretter brukere, slik at du kan tildele brukere direkte til grupper ved opprettelse. Se her for mer informasjon om gruppestruktur.
- En brukers stilling lar deg delegere opplæring basert på deres rolle i organisasjonen. Se her for mer informasjon om stillinger.
- Vi anbefaler å sette opp et testmiljø for å teste kallene dine og integrasjonen som helhet før du overfører til produksjonsmiljøet. Ta kontakt med din Customer Success Manager eller support@motimateapp.com for assistanse.
- Motimate sitt API bruker JSON-format.
Opprette grupper
For å opprette grupper, bruk følgende kall:
Legg til payload i body med nødvendig informasjon om gruppen. Feltet "parent_id" brukes til å opprette en gruppestruktur. Hvis du oppgir ID-en til en annen gruppe i dette feltet, vil den gruppen bli satt som foreldregruppe.
⚠ Viktig: Nivået på gruppen må være lavere i hierarkiet enn foreldregruppen, hvor "Level 1" er det høyeste nivået. Dette lar deg importere gruppestrukturer til din Motimate-konto.
Oppdatere grupper
For å oppdatere en gruppe i Motimate, bruk følgende kall (hvor {group_id} er Motimate-gruppe-ID-en):
Legg til payload i body med de dataene du ønsker å oppdatere. Dette kan brukes når en gruppe må flyttes til et annet nivå eller hvis strukturen må justeres.
Slette grupper
For å slette en gruppe i Motimate, bruk følgende kall (hvor {group_id} er Motimate-gruppe-ID-en):
Sett force til 1 for å slette gruppen permanent (hard delete). Dette kan ikke angres.
Kjøring av dette kallet vil slette den valgte gruppen, men det returneres ingen respons.
Opprette brukere
For å opprette brukere, bruk følgende kall:
Legg til payload i body med nødvendig informasjon om brukeren. Enten e-postadresse eller telefonnummer vil være obligatorisk, avhengig av kontoinnstillingene i Motimate.
Du kan tilordne brukeren til grupper ved å bruke group assignments-feltet. Oppgi gruppe-ID-en og rollen brukeren skal ha i gruppen (member, admin eller observer).
Vi anbefaler å sette assign_ancestors til true i de fleste tilfeller. Dette sikrer at brukeren også blir medlem av overordnede grupper til de tildelte gruppene.
Oppdatere brukere
For å oppdatere en brukers informasjon i Motimate, bruk følgende kall (hvor {user_id} er Motimate-bruker-ID-en):
Legg til payload i body med kun de dataene du ønsker å oppdatere for brukeren.
Slette brukere
For å slette en bruker i Motimate, bruk følgende kall (hvor {user_id} er Motimate-bruker-ID-en):
- force=1 → Sletter brukeren permanent (hard delete). Kan ikke angres.
- force=0 → Utfører en soft delete, slik at brukeren kan gjenopprettes senere om nødvendig.
Kjøring av dette kallet vil slette den valgte brukeren, men det returneres ingen respons.
Gjenopprette brukere
Hvis en bruker er slettet ved en feil og har blitt soft deleted (ikke hard slettet), kan de gjenopprettes med følgende kall (hvor {user_id} er Motimate-bruker-ID-en):