Utente
INFO
Tieni presente che gli esempi seguenti sono stati forniti con i permessi admin e ticket.agent.
Io - Utente corrente
Permesso richiesto: qualsiasi
Richiesta GET inviata: /api/v1/users/me
Details
json
// HTTP-Code 200 OK
{
"id": 3,
"organization_id": 2,
"login": "lauren@fastlane.inc",
"firstname": "Lauren",
"lastname": "Brooks",
"email": "lauren@fastlane.inc",
"image": "7a6a0d1d94ad2037153cf3a6c1b49a53",
"image_source": null,
"web": "",
"phone": "",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": null,
"vip": false,
"verified": false,
"active": true,
"note": "",
"last_login": "2021-11-03T12:26:53.410Z",
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {
"notification_config": {
"matrix": {
"create": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"update": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"reminder_reached": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"subscribed": false,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"escalation": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"subscribed": false,
"no": false
},
"channel": {
"email": true,
"online": true
}
}
}
},
"locale": "en-us",
"intro": true
},
"updated_by_id": 3,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:15.975Z",
"updated_at": "2021-11-03T12:26:55.642Z",
"role_ids": [
1,
2
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {
"1": [
"full"
],
"2": [
"full"
],
"3": [
"full"
]
}
}Elenca
Permesso richiesto: ticket.agent o admin.user
Richiesta GET inviata: /api/v1/users
Details
json
// HTTP-Code 200 OK
[
{
"id": 1,
"organization_id": null,
"login": "-",
"firstname": "-",
"lastname": "",
"email": "",
"image": null,
"image_source": null,
"web": "",
"phone": "",
"fax": "",
"mobile": "",
"department": "",
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "",
"vip": false,
"verified": false,
"active": false,
"note": "",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:51:12.786Z",
"updated_at": "2021-11-03T11:51:12.786Z",
"role_ids": [],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {}
},
{
"id": 2,
"organization_id": 1,
"login": "nicole.braun@zammad.org",
"firstname": "Nicole",
"lastname": "Braun",
"email": "nicole.braun@zammad.org",
"image": null,
"image_source": null,
"web": "",
"phone": "",
"fax": "",
"mobile": "",
"department": "",
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "",
"vip": false,
"verified": false,
"active": true,
"note": "",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {
"tickets_closed": 0,
"tickets_open": 1
},
"updated_by_id": 2,
"created_by_id": 1,
"created_at": "2021-11-03T11:51:13.703Z",
"updated_at": "2021-11-03T12:01:05.411Z",
"role_ids": [
3
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {}
},
{
"id": 3,
"organization_id": 2,
"login": "lauren@fastlane.inc",
"firstname": "Lauren",
"lastname": "Brooks",
"email": "lauren@fastlane.inc",
"image": "7a6a0d1d94ad2037153cf3a6c1b49a53",
"image_source": null,
"web": "",
"phone": "",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": null,
"vip": false,
"verified": false,
"active": true,
"note": "",
"last_login": "2021-11-03T12:26:53.410Z",
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {
"notification_config": {
"matrix": {
"create": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"update": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"reminder_reached": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"subscribed": false,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"escalation": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"subscribed": false,
"no": false
},
"channel": {
"email": true,
"online": true
}
}
}
},
"locale": "en-us",
"intro": true
},
"updated_by_id": 3,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:15.975Z",
"updated_at": "2021-11-03T12:26:55.642Z",
"role_ids": [
1,
2
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {
"1": [
"full"
],
"2": [
"full"
],
"3": [
"full"
]
}
},
{
"id": 4,
"organization_id": 2,
"login": "ethan@fastlane.inc",
"firstname": "Ethan",
"lastname": "Kwan",
"email": "ethan@fastlane.inc",
"image": "95afc1244af5cb8b77edcd7224c5d5f8",
"image_source": null,
"web": "",
"phone": "",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": null,
"vip": false,
"verified": false,
"active": true,
"note": "",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {
"notification_config": {
"matrix": {
"create": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"update": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"reminder_reached": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"subscribed": false,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"escalation": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"subscribed": false,
"no": false
},
"channel": {
"email": true,
"online": true
}
}
}
},
"locale": "en-us"
},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:16.160Z",
"updated_at": "2021-11-03T11:57:16.214Z",
"role_ids": [
1,
2
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {
"1": [
"full"
],
"2": [
"full"
],
"3": [
"full"
]
}
},
{
"id": 5,
"organization_id": 2,
"login": "emily@fastlane.inc",
"firstname": "Emily",
"lastname": "Wilson",
"email": "emily@fastlane.inc",
"image": "b64fef91c29105b4a08a2a69be08eda3",
"image_source": null,
"web": "",
"phone": "",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": null,
"vip": false,
"verified": false,
"active": true,
"note": "",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {
"notification_config": {
"matrix": {
"create": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"update": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"reminder_reached": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"subscribed": false,
"no": false
},
"channel": {
"email": true,
"online": true
}
},
"escalation": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"subscribed": false,
"no": false
},
"channel": {
"email": true,
"online": true
}
}
}
},
"locale": "en-us"
},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:16.349Z",
"updated_at": "2021-11-03T11:57:16.409Z",
"role_ids": [
2
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {
"1": [
"full"
],
"2": [
"full"
],
"3": [
"full"
]
}
},
{
"id": 6,
"organization_id": 3,
"login": "anna@example.com",
"firstname": "Anna",
"lastname": "Lopez",
"email": "anna@example.com",
"image": "4b1cb1fae2e608ffa72099774e1f57ad",
"image_source": null,
"web": "",
"phone": "415-123-5858",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "Golden Gate Bridge\nSan Francisco, CA 94129",
"vip": false,
"verified": false,
"active": true,
"note": "likes espresso romano - recommended espresso con panna",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:16.526Z",
"updated_at": "2021-11-03T11:57:16.611Z",
"role_ids": [
3
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {}
},
{
"id": 7,
"organization_id": 3,
"login": "samuel@example.com",
"firstname": "Samuel",
"lastname": "Lee",
"email": "samuel@example.com",
"image": "5911d228f3588c36a72d80eb0c1e4d08",
"image_source": null,
"web": "",
"phone": "855-666-7777",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "5201 Blue Lagoon Drive\n8th Floor & 9th Floor\nMiami, FL 33126",
"vip": false,
"verified": false,
"active": true,
"note": "likes americano, did order two units",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:16.748Z",
"updated_at": "2021-11-03T11:57:16.861Z",
"role_ids": [
3
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {}
},
{
"id": 8,
"organization_id": 3,
"login": "emily@example.com",
"firstname": "Emily",
"lastname": "Adams",
"email": "emily@example.com",
"image": "99ba64a89f7783c099c304c9b00ff9e8",
"image_source": null,
"web": "",
"phone": "0061 2 1234 7777",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "Bennelong Point\nSydney NSW 2000",
"vip": false,
"verified": false,
"active": true,
"note": "Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo.",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:17.000Z",
"updated_at": "2021-11-03T11:57:17.060Z",
"role_ids": [
3
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {}
},
{
"id": 9,
"organization_id": 4,
"login": "ryan@example.com",
"firstname": "Ryan",
"lastname": "Parker",
"email": "ryan@example.com",
"image": "0e405c60b5deb780feb7ebebd37ff5e0",
"image_source": null,
"web": "",
"phone": "0049 30 1234 5678",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "Brandenburger Tor 7\n10117 Berlin",
"vip": false,
"verified": false,
"active": true,
"note": "no latte but macchiato",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:17.190Z",
"updated_at": "2021-11-03T11:57:17.250Z",
"role_ids": [
3
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {}
},
{
"id": 10,
"organization_id": null,
"login": "david@example.com",
"firstname": "David",
"lastname": "Bell",
"email": "david@example.com",
"image": "d829d234f377f231534802df6d5500a7",
"image_source": null,
"web": "",
"phone": "0033 892 12 34 56",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "Eiffel Tower\n5 Avenue Anatole France\n75007 Paris",
"vip": false,
"verified": false,
"active": true,
"note": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magnam aliquam quaerat voluptatem.",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:17.495Z",
"updated_at": "2021-11-03T11:57:17.561Z",
"role_ids": [
3
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {}
},
{
"id": 11,
"organization_id": null,
"login": "olivia@example.com",
"firstname": "Olivia",
"lastname": "Ross",
"email": "olivia@example.com",
"image": "b6f7a2d56544bb471eb3a3c238c7d964",
"image_source": null,
"web": "",
"phone": "0044 20 1234 5678",
"fax": "",
"mobile": "",
"department": null,
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "Westminster\nLondon SW1A 0AA",
"vip": false,
"verified": false,
"active": true,
"note": "",
"last_login": null,
"source": null,
"login_failed": 0,
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {},
"updated_by_id": 1,
"created_by_id": 1,
"created_at": "2021-11-03T11:57:17.741Z",
"updated_at": "2021-11-03T11:57:17.794Z",
"role_ids": [
3
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [],
"group_ids": {}
}
]Mostra
Permesso richiesto: ticket.agent o admin.user oticket.customer (condiviso o
INFO
Tecnicamente, qualsiasi elenco restituirà solo le informazioni proprie dell'utente.
Richiesta GET inviata: /api/v1/users/{id}
Details
json
{
"active": true,
"login_failed": 0,
"verified": false,
"source": null,
"login": "lauren@fastlane.inc",
"last_login": "2021-09-23T13:17:24.817Z",
"id": 3,
"updated_by_id": 1,
"organization_id": 2,
"firstname": "Lauren",
"lastname": "Brooks",
"email": "lauren@fastlane.inc",
"image": "7a6a0d1d94ad2037153cf3a6c1b49a53",
"image_source": null,
"web": "",
"phone": "",
"fax": "",
"mobile": "",
"department": "",
"street": "",
"zip": "",
"city": "",
"country": "",
"address": "",
"vip": false,
"note": "",
"out_of_office": false,
"out_of_office_start_at": null,
"out_of_office_end_at": null,
"out_of_office_replacement_id": null,
"preferences": {
"notification_config": {
"matrix": {
"create": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": true
},
"channel": {
"email": true,
"online": true
}
},
"update": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": true,
"subscribed": true,
"no": true
},
"channel": {
"email": true,
"online": true
}
},
"reminder_reached": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"no": true
},
"channel": {
"email": true,
"online": true
}
},
"escalation": {
"criteria": {
"owned_by_me": true,
"owned_by_nobody": false,
"no": true
},
"channel": {
"email": true,
"online": true
}
}
},
"group_ids": [
"2",
"1",
"3"
]
},
"locale": "de-de",
"intro": true,
"notification_sound": {
"file": "Xylo.mp3",
"enabled": true
},
"cti": true,
"tickets_closed": 0,
"tickets_open": 1
},
"created_by_id": 1,
"created_at": "2021-07-26T14:44:41.066Z",
"updated_at": "2021-09-23T13:17:24.825Z",
"role_ids": [
1,
2
],
"organization_ids": [],
"authorization_ids": [],
"karma_user_ids": [
1
],
"group_ids": {
"1": [
"full"
],
"2": [
"full"
],
"3": [
"full"
]
},
"roles": [
"Admin",
"Agent"
],
"organizations": [],
"authorizations": [],
"organization": "Fastlane Inc.",
"groups": {
"Sales": [
"full"
],
"Support": [
"full"
],
"IT Internal": [
"full"
]
},
"created_by": "-",
"updated_by": "-"
}Crea
Permesso richiesto: admin.user o ticket.agent
Richiesta POST inviata: /api/v1/users
TIP
Questo dipende dai permessi
Gli agenti non possono impostare password utente, ruoli o permessi di gruppo.
TIP
Non sei sicuro di quali attributi puoi usare o impostare? Esegui una query GET su qualsiasi utente esistente adatto.
Details
json
{
"firstname": "Jane",
"lastname": "Doe",
"email": "jdoe@example.com",
"login": "jdoe",
"organization": "Sample Corp.",
"roles": [
"Agent",
"Customer"
]
}Aggiornamento
Permesso richiesto: admin.user o ticket.agent
Richiesta PUT inviata: /api/v1/users/{id}
TIP
Questo dipende dai permessi
Gli agenti non possono impostare password utente, ruoli o permessi di gruppo.
Details
json
{
"phone": "+49 30 55 57 160 00",
"department": "Sales",
"address": "Marienstr. 18\n10117 Berlin"
}Elimina
DANGER
Questa è una rimozione permanente
Tieni presente che rimuovere utenti non può essere annullato. Zammad.
Tecnicamente, puoi eliminare utenti tramite /api/v1/users/{id}. Tuttavia, raccomandiamo vivamente.
Tramite endpoint privacy dati
Permesso richiesto: admin.data_privacy
Richiesta POST inviata: /api/v1/data_privacy_task
Details
json
{
"deletable_type": "User",
"deletable_id": 19
}Tramite endpoint utente non consigliato
Permesso richiesto: admin.user
Richiesta DELETE inviata: /api/v1/users/{id}
Details
json
// HTTP-Code 200 OK
{}