Gestione utente

Ultimo aggiornamento: 27 novembre 2024
  • Argomenti:

Creato per:

  • Amministratore

Riferimento endpoint gestione utenti

Marketo fornisce una serie di endpoint per la gestione degli utenti che consentono di eseguire operazioni CRUD sui record degli utenti in Marketo. Gli utenti vengono creati inviando un invito a un utente, che imposta una password e ottiene l’accesso a Marketo per la prima volta.

A differenza di altre API REST di Marketo, quando si utilizzano le API User Management:

  • Per inviare il token di accesso per l’autenticazione, è necessario utilizzare il metodo HTTP header. Impossibile passare il token di accesso come parametro della stringa di query. Ulteriori informazioni sull'autenticazione sono disponibili qui.

  • È necessario selezionare un'autorizzazione per il ruolo da due diversi gruppi durante la creazione del ruolo utente per Servizio personalizzato per API REST:

    1. Autorizzazione "Accedi agli utenti" dal gruppo Accesso amministratore
    2. "Accedere all'API User Management" dal gruppo Access API

  • I corpi di risposta non contengono l’attributo booleano "success" che indica l’esito positivo o negativo di una chiamata. È invece necessario valutare il codice di stato della risposta HTTP. Se una chiamata ha esito positivo, viene restituito un codice di stato 200. Se una chiamata non riesce, viene restituito un codice di stato non di livello 200 e il corpo della risposta contiene l’array standard "errors" con codice di errore e messaggio di errore descrittivo.

  • Il formato delle stringhe datetime è yyyyMMdd'T'HH:mm:ss.SSS't'+|-hhmm. Questo vale per i seguenti attributi: createdAt, updatedAt, expiresAt.

  • Come per gli altri endpoint, gli endpoint API per la gestione degli utenti non hanno il prefisso "/rest".

Query

Il supporto delle query per la gestione degli utenti include la possibilità di recuperare tutti gli utenti, i ruoli e le aree di lavoro. Inoltre, puoi recuperare un singolo record utente per ID utente o un record ruolo/area di lavoro per ID utente.

Utente per ID

L'endpoint Get User by Id accetta un singolo parametro di percorso userid e restituisce un singolo record utente per un utente che ha accettato l'invito.

GET /userservice/management/v1/users/{userid}/user.json

{
  "userid": "jamie@houselannister.com",
  "firstName": "Jamie",
  "lastName": "Lannister",
  "emailAddress": "jamie@lannister.com",
  "optedIn": false,
  "failedLogins": 0,
  "failedDeviceCode": 0,
  "isLocked": false,
  "lockedReason": null,
  "id": 0,
  "apiOnly": false,
  "userRoleWorkspaces": [
    {
      "accessRoleId": 1,
      "accessRoleName": "Admin",
      "workspaceId": 0,
      "workspaceName": "AllZones"
    },
    {
      "accessRoleId": 2,
      "accessRoleName":
      "Standard User",
      "workspaceId": 1008,
      "workspaceName": "World"
    }
  ],
  "expiresAt": "2020-12-31T08:00:00.000t+0000",
  "lastLoginAt": "2020-02-05T01:02:23.000t+0000"
}

Utente invitato per ID

L'endpoint Get Invited User by Id accetta un singolo parametro di percorso userid e restituisce un singolo record utente per un utente "in sospeso" (l'invito non è stato ancora accettato).

GET /userservice/management/v1/users/{userid}/invite.json

{
    "id": 25112,
    "firstName": "Jamie",
    "lastName": "Lannister",
    "emailAddress": "jamie@lannister.com",
    "userId": "jamie@lannister.com",
    "subscriptionId": 3381,
    "status": "pending",
    "expiresAt": "20200807T20:49:54.0t+0000",
    "createdAt": "20200731T20:49:54.0t+0000",
    "updatedAt": "20200731T20:49:54.0t+0000"
}

Ruoli e aree di lavoro per ID

L'endpoint Get Roles and Workspaces by Id accetta un singolo parametro di percorso userid e restituisce un elenco di record di ruoli utente e area di lavoro. La risposta contiene un array con un oggetto che contiene l’ID del ruolo e dell’area di lavoro e il nome dell’utente specificato.

GET /userservice/management/v1/users/{userid}/roles.json

[
  {
    "accessRoleId": 1,
    "accessRoleName": "Admin",
    "workspaceId": 0,
    "workspaceName": "AllZones"
  },
  {
    "accessRoleId": 2,
    "accessRoleName": "Standard User",
    "workspaceId": 1008,
    "workspaceName": "World"
  }
]

Sfoglia utenti

L'endpoint Get Users restituisce un elenco di tutti i record utente. Il parametro facoltativo pageSize è un numero intero che specifica il numero massimo di voci da restituire. Il valore predefinito è 20. Il massimo è 200. Il parametro facoltativo pageOffset è un numero intero che specifica dove iniziare a recuperare le voci. Può essere utilizzato con pageSize. Il valore predefinito è 0.

GET /userservice/management/v1/users/allusers.json

[
  {
    "userid": "jamie@lannister.com",
    "firstName": "Jamie",
    "lastName": "Lannister",
    "emailAddress": "jamie@houselannister.com",
    "id": 6785,
    "apiOnly": false
  },
  {
    "userid": "jeoffery@housebaratheon.com",
    "firstName": "Jeoffery",
    "lastName": "Baratheon",
    "emailAddress": "jeoffery@housebaratheon.com",
    "id": 7718,
    "apiOnly": false
  },
  {
    "userid": "rickon@housestark.com",
    "firstName": "Rickon",
    "lastName": "Stark",
    "emailAddress": "rickon@housestark.com",
    "id": 8612,
    "apiOnly": false
  }
]
NOTE
Nell'esempio di codice riportato sopra, l'elemento userid visualizzato è per un cliente che è stato trasferito ad Adobe IMS. I clienti che devono ancora effettuare la migrazione visualizzeranno un indirizzo e-mail regolare nel campo userid.