Tutti gli articoli

API SCIM

Ultimo aggiornamento il

Team di documentazione Wrike

Team di documentazione Wrike

TL;DR

L’API SCIM in Wrike consente il provisioning e la gestione automatizzati degli utenti sincronizzando i dati utente dal tuo Identity Provider. Usala per creare, aggiornare e disattivare utenti mantenendo un controllo centralizzato su accesso e informazioni di identità.

Tabella 27. Disponibilità - Piani legacy


Disponibilità: Legacy Enterprise.; Non disponibilità: Legacy Free, Legacy Professional, Legacy Business.;

Tabella 28. Disponibilità


Disponibilità: Pinnacle, Apex. Non disponibilità: Free, Team, Business;

Overview

Il System for Cross-domain Identity Management (SCIM) è uno standard che automatizza lo scambio di informazioni sull’identità degli utenti tra domini di identità o sistemi IT. Sono disponibili soluzioni pronte all’uso per il provisioning SCIM in Wrike con OKTA, OneLogin e Azure AD, illustrate in dettaglio negli articoli di aiuto collegati. Questa pagina tratta del provisioning SCIM personalizzato tramite API.

Può essere utilizzato per:

  • Provisioning di nuovi utenti in Wrike

  • Provisioning e aggiornamento degli attributi utente supportati

  • Provisioning e aggiornamento degli attributi utente personalizzati

  • Disattivazione o eliminazione di utenti in Wrike

  • Creazione e aggiornamento di gruppi utente in Wrike

  • Aggiunta o rimozione di appartenenze ai gruppi

Limitazioni

  • Funziona solo con gli abbonamenti di livello Legacy Enterprise, Pinnacle e Apex.

  • La sincronizzazione è unidirezionale: dall’IDP a Wrike.

  • Le password degli utenti non vengono memorizzate in Wrike. Se un utente viene creato tramite SCIM in un account senza SAML SSO, dovrà usare la pagina di reimpostazione della password per crearne una.

  • La ricerca è supportata solo per indirizzo email.

  • Wrike usa l’indirizzo email come nome utente. Durante il provisioning o l’integrazione, Wrike cercherà un’email valida in userName o in emails da utilizzare come login.

Note

Poiché i metodi di implementazione di SCIM variano notevolmente tra i diversi Identity Provider (ad esempio per messaggi di errore e azioni supportate o meno), gli aspetti specifici del funzionamento SCIM e dei relativi messaggi di errore devono essere esaminati dai tuoi amministratori IdP in stretta collaborazione con loro. La risoluzione dei problemi e la consulenza sulle specificità dell’implementazione SCIM nei diversi Identity Provider non rientrano nell’ambito di lavoro del Team di assistenza Wrike.

Prima di cominciare

  1. Devi avere un account con abbonamento Legacy Enterprise, Pinnacle o Apex ed essere un Amministratore con i diritti “modificare nomi ed email, aggiungere/rimuovere persone dai gruppi, esportare un elenco utenti, disattivare ed eliminare singoli account utente”, “Configurare impostazioni di sicurezza avanzate” e “Concedere/revocare diritti di amministratore” abilitati.

  2. Add approved domains. Solo gli utenti provenienti da domini approvati verranno automaticamente sottoposti a provisioning in Wrike.

  3. Genera un token API permanente.

  4. In App e integrazioni, recupera l’URL SCIM del tuo account dalla scheda SCIM della card di OKTA, OneLogin o Azure AD.

  5. Puoi utilizzare Postman per usare il nostro ambiente preimpostato e la raccolta di chiamate. Per preparare un ambiente Postman, scarica e importa:

    1. Raccolta di chiamate Wrike SCIM per Postman: Wrike SCIM.postman_collection.json

    2. Scarica e importa l’ambiente Wrike SCIM, aggiungi il tuo URL di base + token permanente: Wrike_SCIM_API.postman_environment.json

Azioni disponibili

. Utenti

  • Elenca gli utenti integrati - GET {{base_url}}/Users - restituisce un JSON con le informazioni sugli utenti dell’account già integrati tramite SCIM. Si tratta di utenti creati tramite invito e poi collegati con la chiamata POST /Users, NONCHÉ di utenti forniti direttamente tramite SCIM. Se hai creato manualmente alcuni utenti e non li hai ancora integrati con la chiamata n. 2, non compariranno nel JSON.

    • Ottieni utente integrato - GET {{base_url}}/Users/ - aggiungi l’ID utente per ricevere un JSON con le informazioni su quell’utente, ad esempio GET {{base_url}}/Users/KUAH4WFR dove KUAH4WFR è l’ID API dell’utente.

    • Cerca utenti integrati usando il filtro eq - GET {{base_url}}/Users?filter=userName eq \"jerome.chef@scim.test\" - cerca l’utente tramite l’indirizzo email primario completo.

  • Creazione utente - POST {{base_url}}/Users + request body formattato correttamente (un esempio con spiegazione è riportato sotto) - crea un utente con gli attributi specificati nel request body.

  • Sostituzione attributi utente - PUT {{base_url}}/Users/{{user_id}} + request body formattato correttamente (un esempio con spiegazione è riportato sotto) - riscrive tutti gli attributi utente in base al request body. Questa chiamata può essere utilizzata per aggiornare il tipo di utente e disattivare/attivare l’utente.

  • Patch attributi utente - PATCH {{base_url}}/Users/{{user_id}} + request body formattato correttamente (un esempio con spiegazione è riportato sotto) - simile al precedente, ma il request body contiene solo gli attributi da aggiornare e i relativi nuovi valori.

  • Eliminazione utente - DELETE {{base_url}}/Users/{{user_id}}.

Attributi utente personalizzati

  • Attributi utente personalizzati possono essere forniti e aggiornati tramite l’estensione Wrike SCIM come parte delle chiamate POST /Users, PUT /Users/{{user_id}} e PATCH /Users/{{user_id}}.

Gruppi

  • Elenca gruppi - GET {{base_url}}/Groups - restituisce un JSON con le informazioni sui gruppi utente Wrike sottoposti a provisioning.

  • Ottieni gruppo - GET {{base_url}}/Groups/{{group_id}} - restituisce un JSON con le informazioni su quel gruppo.

  • Creazione gruppo - POST {{base_url}}/Groups + request body formattato correttamente - crea un gruppo utente Wrike.

  • Patch gruppo - PATCH {{base_url}}/Groups/{{group_id}} + request body formattato correttamente - aggiorna gli attributi del gruppo e le modifiche di appartenenza.

  • Eliminazione gruppo - DELETE {{base_url}}/Groups/{{group_id}}.

Spiegazione di un request body

Ecco un esempio di request body per creare un utente, collegarne uno esistente o aggiornare gli attributi di un utente:

Image-2024-09-30_13_49_49.png

*userName, email principale e secondarie:

  1. Il campo userName è obbligatorio.

  2. Le email (primaria e non primaria) sono opzionali; in questo blocco possono essere incluse tutte le email necessarie.

  3. Se NON è presente un’email primaria nel body della richiesta, userName viene aggiunto come indirizzo email primario dell’utente in Wrike.

  4. Se è presente un’email primaria nel body della richiesta, questa viene utilizzata come indirizzo email primario dell’utente in Wrike.

  5. Se nel campo emails sono presenti indirizzi e nessuno è contrassegnato come primario, userName viene aggiunto come indirizzo principale dell’utente in Wrike e gli altri come email secondarie.

**Lingue disponibili e relative descrizioni:

possible_locales.png

Ecco un esempio di request body per modificare (patch) gli attributi di un utente:

Image-2024-09-30_13_53_36.png

Spiegazione dell’attributo wrikeUserType

L’integrazione Wrike-SCIM consente di definire i tipi di utente degli utenti collegati via SCIM nelle richieste di provisioning o aggiornamento utilizzando il parametro wrikeUserType.

I valori accettati per l’attributo wrikeUserType corrispondenti ai tipi di utente predefiniti sono "Regular", "External", "Collaborator", "Viewer" e "Contributor" (con o senza maiuscole).

Nota

"Viewer" e "Contributor" sono accettati se questi tipi di utente sono abilitati nel tuo account.

Tipi di utente e UID

Il collegamento ai tipi di utente predefiniti rimane attivo anche se i tipi predefiniti vengono rinominati/modificati (es. se "Regular user" è stato rinominato in External, la richiesta con valore “Regular” verrà comunque collegata allo stesso tipo di utente).

I valori degli ID dei tipi di utente predefiniti sono i seguenti:

  • Owner: -1

  • Admin: -2

  • Regular: -3

  • External: -4

  • Collaborator: -5

  • Viewer: -8

  • Contributor: -10

    Note

    I tipi di utente Viewer e Contributor potrebbero essere o meno abilitati nel tuo account. Se hai dubbi, contatta il tuo referente customer success per chiarire se sono abilitati.

Un metodo più solido e affidabile consiste nel fare riferimento ai tipi di utente tramite i relativi UID API: ti consigliamo quindi di preferirlo sempre. Gli UID possono essere recuperati con uno dei metodi seguenti:

  • con il metodo GET /user_types nella API Wrike.

  • dalla risposta dei metodi CREATE, GET o PATCH per gli utenti esistenti.

  • Il Team di assistenza Wrike può fornirti gli UID dei tipi di utente presenti nel tuo account in seguito a una richiesta del proprietario o di un amministratore dell’account.

    Importante

    Nota che l’attributo name.formatted non può essere modificato con il metodo PATCH. Il suo valore viene generato automaticamente in base agli attributi utente name.familyName e name.givenName.

Mappatura attributi personalizzati utente

Wrike supporta i campi personalizzati a livello di utente. Questi possono essere forniti tramite SCIM utilizzando un’estensione SCIM personalizzata:

Screenshot_2026-04-27_at_2_12_46_PM.png

Ogni campo personalizzato utente è referenziato come:

Screenshot_2026-04-27_at_2_14_13_PM.png

Esempio:

Screenshot_2026-04-27_at_2_15_26_PM.png

Provisioning gruppi

Il provisioning dei gruppi consente:

  • Creazione automatica dei gruppi utente Wrike in base ai gruppi definiti nell’IdP

  • Aggiunta e rimozione di membri dal gruppo

  • Eliminazione del gruppo quando viene rimosso dall’IdP

  • Aggiornamenti delta continui

I gruppi vengono sincronizzati tramite l’endpoint SCIM /Groups.

E adesso?

Inizio