REST Resource: customers.v2.Users

Risorsa: User

Rappresentazione SCIM di un utente.

Rappresentazione JSON 
{
  "schemas": [
    string
  ],
  "emails": [
    {
      object (Email)
    }
  ],
  "addresses": [
    {
      object (Address)
    }
  ],
  "phoneNumbers": [
    {
      object (Phone)
    }
  ],
  "groups": [
    {
      object (GroupReference)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "userName": string,
  "name": {
    object (Name)
  },
  "displayName": string,
  "active": boolean,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    object (EnterpriseUserExtension)
  }
}
Campi
schemas[]

string

Obbligatorio. Un elenco di URI che indicano gli spazi dei nomi degli schemi SCIM che definiscono gli attributi presenti nella struttura JSON corrente. Deve contenere solo i valori definiti come schema e schemaExtensions per User ResourceType.
emails[]

object (Email)

Facoltativo. L'elenco degli indirizzi email dell'utente. La dimensione massima consentita dei dati è 10 kB. L'email corrispondente a userName verrà aggiunta automaticamente a questo elenco con l'attributo secondario primary impostato su true. Questa voce email principale è di sola lettura e non può essere modificata tramite questo attributo.
addresses[]

object (Address)

Facoltativo. L'elenco degli indirizzi fisici dell'utente. La dimensione massima consentita dei dati è 10 kB.
phoneNumbers[]

object (Phone)

Facoltativo. Un elenco dei numeri di telefono dell'utente. La dimensione massima consentita dei dati è 1 KB.
groups[]

object (GroupReference)

Solo output. L'elenco dei gruppi di cui l'utente è membro diretto, troncato a un massimo di 1000 gruppi.

Questo attributo non viene restituito per impostazione predefinita e deve essere richiesto utilizzando il parametro di query attributes. La lettura di questo attributo richiede l'inserimento nella lista consentita dei clienti. Contatta l'assistenza per spiegare il tuo caso d'uso e richiedere l'accesso.
id

string

Identificatore. L'ID univoco dell'utente. Le caratteristiche dell'attributo sono caseExact come true, una modificabilità di readOnly e una caratteristica returned di always.
externalId

string

Facoltativo. Un identificatore definito dal client per l'utente SCIM. Questo campo è sensibile alle maiuscole e modificabile. Il client è responsabile di garantire l'unicità, in quanto il server non la impone.
meta

object (Meta)

Solo output. Un attributo complesso contenente i metadati della risorsa. Tutti gli attributi secondari meta vengono assegnati dal fornitore di servizi (hanno un mutability di readOnly) e tutti questi attributi secondari hanno una caratteristica returned di default. Questo attributo viene ignorato quando viene fornito dai client.
userName

string

Obbligatorio. L'indirizzo email principale dell'utente. Utilizzato come identificatore univoco dell'utente.
name

object (Name)

Obbligatorio. Il nome dell'utente.
displayName

string

Facoltativo. Il nome visualizzato dell'utente. Limite: 256 caratteri.
active

boolean

Facoltativo. Lo stato dell'account utente (false indica che l'account è sospeso). Valore predefinito: true.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object (EnterpriseUserExtension)

Facoltativo. Attributi di estensione utente SCIM Enterprise.

Nome

Rappresentazione SCIM del nome di un utente.

Rappresentazione JSON 
{
  "familyName": string,
  "givenName": string
}
Campi
familyName

string

Obbligatorio. Il cognome dell'utente.
givenName

string

Obbligatorio. Il nome dell'utente.

Email

Rappresentazione SCIM dell'email di un utente.

Rappresentazione JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Campi
value

string

Obbligatorio. L'indirizzo email dell'utente.
type

string

Il tipo di account email. I valori validi sono home, work e other.
primary

boolean

Solo output. Indica se si tratta dell'email principale dell'utente. Questo valore è impostato su true solo per l'email corrispondente a userName.

Indirizzo

Rappresentazione SCIM dell'indirizzo di un utente.

Rappresentazione JSON 
{
  "formatted": string,
  "streetAddress": string,
  "locality": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "type": string,
  "primary": boolean
}
Campi
formatted

string

Indirizzo completo, formattato per la visualizzazione.
streetAddress

string

L'indirizzo stradale.
locality

string

La città o la località.
region

string

La regione o lo stato.
postalCode

string

Il codice postale o il CAP.
country

string

Il paese.
type

string

Il tipo di indirizzo. I valori validi sono home, work e other.
primary

boolean

Indica se si tratta dell'indirizzo principale dell'utente.

Telefono

Rappresentazione SCIM del numero di telefono di un utente.

Rappresentazione JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Campi
value

string

Obbligatorio. Il numero di telefono.
type

string

Il tipo di numero di telefono. I valori validi sono home, work, mobile, fax, pager e other.
primary

boolean

Indica se questo è il numero di telefono principale dell'utente.

EnterpriseUserExtension

Definisce gli attributi per l'estensione utente aziendale SCIM. L'URN dello schema per questa estensione è: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User. Per saperne di più, consulta la sezione 4.3 dell'RFC 7643.

Rappresentazione JSON 
{
  "employeeNumber": string,
  "costCenter": string,
  "organization": string,
  "department": string
}
Campi
employeeNumber

string

Facoltativo. Identificatore, in genere assegnato dall'organizzazione, utilizzato per identificare l'utente all'interno dell'organizzazione.
costCenter

string

Facoltativo. Identificatore del centro di costo a cui vengono attribuiti i costi dell'utente.
organization

string

Facoltativo. Il nome di un'organizzazione a cui appartiene un utente.
department

string

Facoltativo. Il nome di un reparto a cui appartiene l'utente in formato testo.

GroupReference

Rappresentazione SCIM dell'appartenenza di un utente a un gruppo.

Rappresentazione JSON 
{
  "value": string,
  "$ref": string,
  "type": string
}
Campi
value

string

Solo output. Il id della risorsa SCIM che rappresenta il gruppo.
$ref

string

Solo output. L'URI della risorsa SCIM che rappresenta il gruppo.
type

string

Solo output. Il tipo di iscrizione al gruppo. I valori validi sono direct e indirect.

Metodi

create

 Crea un utente.

delete

 Elimina un utente.

get

 Recupera un utente.

list

 Recupera un elenco di utenti.

patch

 Aggiorna un utente utilizzando la semantica delle patch SCIM.