Recupera un utente
GET /accounts/{account_id}/core/v1/users/{user_id}
Restituisce la risorsa API Utente memorizzata nel corpo della risposta JSON.
Parametri
| Nome | Tipo | In | Obbligatorio | Descrizione |
|---|---|---|---|---|
ID account |
stringa |
percorso |
Vero |
ID della risorsa account contenitore
|
ID utente |
stringa |
percorso |
Vero |
ID della raccolta utenti da elencare |
Risposta
Status: 200, Returns the stored User API resource in the JSON response body.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
Tipo di media della risorsa. I valori definiti sono:
|
versione |
stringa |
Vero |
Versione della risorsa. I valori definiti sono:
|
id |
stringa |
Vero |
Identificatore univoco globale della risorsa. I valori definiti sono:
|
stato |
stringa |
Vero |
Stringa JSON contenente un valore che indica lo stato operativo dell'utente. I valori definiti sono:
|
isEnabled |
stringa |
Vero |
Stringa JSON che indica se l'utente è autorizzato ad accedere. I valori definiti sono:
|
authID |
stringa |
Falso |
Stringa JSON contenente l'identificativo associato a un provider di identità esterno. Il contenuto di questa stringa dipende da quanto specificato authProvider. Per un utente con "authProvider" come "local", "authID" è impostato sul valore di "email". Per un utente con "authProvider" come "ldap", "authID" è impostato sul suo Distinguished Name (DN) dal LDAP server. |
authProvider |
stringa |
Falso |
Stringa JSON che indica il contesto dell'identificatore idAuth. I valori definiti sono:
|
firstName |
stringa |
Vero |
Stringa JSON contenente un nome proprio lungo specificato dall'utente. I valori definiti sono:
|
lastName |
stringa |
Vero |
Stringa JSON contenente un cognome esteso specificato dall'utente. I valori definiti sono:
|
companyName |
stringa |
Falso |
Stringa JSON contenente il nome dell'azienda associata all'utente. Se questa chiave non esiste, significa che non è stato fornito un nome di azienda. I valori definiti sono:
|
stringa |
Vero |
Stringhe JSON contenenti un indirizzo email specificato dall'utente. |
|
telefono |
stringa |
Falso |
Stringa JSON contenente il numero di telefono dell'utente. Se questa chiave non esiste, significa che non è stato fornito un numero di telefono. |
postalAddress |
Falso |
Oggetto JSON contenente una raccolta di campi che specificano un indirizzo. Se questa chiave non esiste, indica che non è stato fornito alcun indirizzo. Se questa chiave esiste, saranno presenti tutti e sei i campi contenuti. Se l'utente non ha fornito nulla, la stringa sarà vuota. |
|
sendWelcomeEmail |
stringa |
Vero |
Stringa JSON che indica se verrà inviata un'e-mail di benvenuto dopo la convalida. Se non specificato in fase di creazione, il valore verrà impostato su "true" per ACS e su "false" per Astra Control Center. I valori definiti sono:
|
enableTimestamp |
stringa |
Falso |
Stringa JSON contenente un timestamp in formato ISO-8601 che indica quando l'utente è stato abilitato per l'ultima volta. I valori definiti sono:
|
lastActTimestamp |
stringa |
Falso |
Stringa JSON contenente un timestamp in formato ISO-8601 che indica quando l'API di identità è stata invocata l'ultima volta per conto di questo utente. (Nota: questa operazione è dispendiosa in termini di risorse.) I valori definiti sono:
|
metadati |
Vero |
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
|
Risposta tipo
{
"type": "application/astra-user",
"version": "1.2",
"id": "5bad8e04-e2fd-5c43-98d7-300580993f49",
"state": "active",
"isEnabled": "true",
"authID": "HteLK3hk28sdbDLKHReB",
"authProvider": "cloud-central",
"firstName": "John",
"lastName": "Doe",
"companyName": "NetApp, Inc.",
"email": "jdoe@example.com",
"phone": "408-555-22222",
"postalAddress": {
"addressCountry": "US",
"addressLocality": "Sunnyvale",
"addressRegion": "California",
"postalCode": "94089",
"streetAddress1": "495 East Java Drive"
},
"sendWelcomeEmail": "true",
"enableTimestamp": "2020-08-05T14:24:54.128427Z",
"lastActTimestamp": "2020-08-05T14:24:54.128427Z",
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Risposta
Status: 401, Unauthorized
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Risposta
Status: 400, Bad request
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
|
invalidParams |
vettore["invalidParams"] |
Falso |
Elenco dei parametri di query non validi |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Risposta
Status: 403, Forbidden
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Errore
Status: 404, Not found
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Esempio di risposta di errore
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definizioni
Vedi definizioni
postalAddress
Oggetto JSON contenente una raccolta di campi che specificano un indirizzo. Se questa chiave non esiste, indica che non è stato fornito alcun indirizzo. Se questa chiave esiste, saranno presenti tutti e sei i campi contenuti. Se l'utente non ha fornito nulla, la stringa sarà vuota.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
addressCountry |
stringa |
Vero |
Stringa JSON contenente il nome o il codice del paese associato all'indirizzo postale, come specificato nello standard ISO 3166 Alpha-2. I valori definiti sono:
|
addressLocality |
stringa |
Vero |
Stringa JSON contenente la località (ad esempio, la città) associata all'indirizzo postale. I valori definiti sono:
|
addressRegion |
stringa |
Vero |
Stringa JSON contenente la regione (ad esempio, stato) associata all'indirizzo postale. I valori definiti sono:
|
postalCode |
stringa |
Vero |
Stringa JSON contenente il codice postale associato all'indirizzo postale. I valori definiti sono:
|
streetAddress1 |
stringa |
Vero |
Stringa JSON contenente l'indirizzo stradale associato all'indirizzo postale. I valori definiti sono:
|
streetAddress2 |
stringa |
Falso |
Stringa JSON contenente informazioni aggiuntive facoltative sull'indirizzo stradale, casella postale e così via. I valori definiti sono:
|
etichetta tipo_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
|
valore |
stringa |
Vero |
aggiornamento dei metadati di tipo Astra
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
-
Conforme allo schema dei metadati Astra. Se non specificato in fase di creazione, verrà creato un oggetto metadati senza etichette. Se non specificato in fase di aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
etichette |
vettore["etichetta tipo_astra"] |
Falso |
|
CreationTimestamp |
stringa |
Falso |
|
ModificationTimestamp |
stringa |
Falso |
|
CreatedBy |
stringa |
Falso |
|
modifiedBy |
stringa |
Falso |
invalidParams
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
Nome del parametro di query non valido |
motivo |
stringa |
Vero |
Motivo per cui il parametro di query non è valido |