User - Create Or Update

Riferimento

Servizio:: API Management

Versione API:: 2024-05-01

Crea o aggiorna un utente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2024-05-01

Con parametri facoltativi:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?notify={notify}&api-version=2024-05-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
userId	path	True	string minLength: 1 maxLength: 80	Identificatore utente. Deve essere univoco nell'istanza corrente del servizio Gestione API.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
notify	query		boolean	Inviare una notifica tramite posta elettronica all'utente.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.email	True	string minLength: 1 maxLength: 254	Indirizzo email. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.
properties.firstName	True	string minLength: 1 maxLength: 100	Nome di battesimo.
properties.lastName	True	string minLength: 1 maxLength: 100	Cognome.
properties.appType		AppType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.
properties.confirmation		Confirmation	Determina il tipo di messaggio di posta elettronica di conferma che verrà inviato all'utente appena creato.
properties.identities		UserIdentityContract[]	Raccolta di identità utente.
properties.note		string	Nota facoltativa su un utente impostato dall'amministratore.
properties.password		string	Password utente. Se non viene specificato alcun valore, viene generata una password predefinita.
properties.state		UserState	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono accedere al portale per sviluppatori o chiamare le API dei prodotti sottoscritti. Lo stato predefinito è Attivo.

Risposte

Nome	Tipo	Descrizione
200 OK	UserContract	L'utente è stato aggiornato correttamente. Intestazioni ETag: string
201 Created	UserContract	L'utente è stato creato correttamente. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

UserContract

L'utente è stato aggiornato correttamente.

Intestazioni

ETag: string

201 Created

UserContract

L'utente è stato creato correttamente.

Intestazioni

ETag: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateUser

Esempio di richiesta

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2024-05-01

{
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "confirmation": "signup"
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512288c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2018-01-07T21:21:29.16Z",
    "groups": [],
    "identities": [
      {
        "provider": "Basic",
        "id": "foobar@outlook.com"
      }
    ]
  }
}

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512288c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2018-01-07T21:21:29.16Z",
    "groups": [],
    "identities": [
      {
        "provider": "Basic",
        "id": "foobar@outlook.com"
      }
    ]
  }
}

Definizioni

Nome	Descrizione
AppType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.
Confirmation	Determina il tipo di messaggio di posta elettronica di conferma che verrà inviato all'utente appena creato.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
GroupContractProperties	Proprietà del contratto di gruppo.
GroupType	Tipo di gruppo.
UserContract	Dettagli utente.
UserCreateParameters	Dettagli di creazione utente.
UserIdentityContract	Dettagli identità utente.
UserState	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono accedere al portale per sviluppatori o chiamare le API dei prodotti sottoscritti. Lo stato predefinito è Attivo.

AppType

Enumerazione

Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.

Valore	Descrizione
developerPortal	La richiesta di creazione dell'utente è stata inviata dal nuovo portale per sviluppatori.
portal	La richiesta di creazione dell'utente è stata inviata dal portale per sviluppatori legacy.

Confirmation

Enumerazione

Determina il tipo di messaggio di posta elettronica di conferma che verrà inviato all'utente appena creato.

Valore	Descrizione
invite	Inviare un messaggio di posta elettronica che invita l'utente a iscriversi e completare la registrazione.
signup	Inviare un messaggio di posta elettronica all'utente che conferma di aver eseguito l'iscrizione.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

GroupContractProperties

Object

Proprietà del contratto di gruppo.

Nome	Tipo	Descrizione
builtIn	boolean	true se il gruppo è uno dei tre gruppi di sistema (Amministratori, Sviluppatori o Guest); in caso contrario false.
description	string maxLength: 1000	Descrizione gruppo. Può contenere tag di formattazione HTML.
displayName	string minLength: 1 maxLength: 300	Nome gruppo.
externalId	string	Per i gruppi esterni, questa proprietà contiene l'ID del gruppo dal provider di identità esterno, ad esempio per Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; in caso contrario, il valore è Null.
type	GroupType	Tipo di gruppo.

GroupType

Enumerazione

Tipo di gruppo.

Valore	Descrizione
custom
external
system

UserContract

Object

Dettagli utente.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nome della risorsa
properties.email	string		Indirizzo email.
properties.firstName	string		Nome di battesimo.
properties.groups	GroupContractProperties[]		La raccolta di utenti di gruppi fa parte di .
properties.identities	UserIdentityContract[]		Raccolta di identità utente.
properties.lastName	string		Cognome.
properties.note	string		Nota facoltativa su un utente impostato dall'amministratore.
properties.registrationDate	string (date-time)		Data di registrazione dell'utente. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
properties.state	UserState	active	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono accedere al portale per sviluppatori o chiamare le API dei prodotti sottoscritti. Lo stato predefinito è Attivo.
type	string		Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

UserCreateParameters

Object

Dettagli di creazione utente.

Nome	Tipo	Valore predefinito	Descrizione
properties.appType	AppType		Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.
properties.confirmation	Confirmation		Determina il tipo di messaggio di posta elettronica di conferma che verrà inviato all'utente appena creato.
properties.email	string minLength: 1 maxLength: 254		Indirizzo email. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.
properties.firstName	string minLength: 1 maxLength: 100		Nome di battesimo.
properties.identities	UserIdentityContract[]		Raccolta di identità utente.
properties.lastName	string minLength: 1 maxLength: 100		Cognome.
properties.note	string		Nota facoltativa su un utente impostato dall'amministratore.
properties.password	string		Password utente. Se non viene specificato alcun valore, viene generata una password predefinita.
properties.state	UserState	active	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono accedere al portale per sviluppatori o chiamare le API dei prodotti sottoscritti. Lo stato predefinito è Attivo.

UserIdentityContract

Object

Dettagli identità utente.

Nome	Tipo	Descrizione
id	string	Valore dell'identificatore all'interno del provider.
provider	string	Nome del provider di identità.

UserState

Enumerazione

Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono accedere al portale per sviluppatori o chiamare le API dei prodotti sottoscritti. Lo stato predefinito è Attivo.

Valore	Descrizione
active	Lo stato utente è attivo.
blocked	L'utente è bloccato. Gli utenti bloccati non possono eseguire l'autenticazione nel portale per sviluppatori o chiamare l'API.
deleted	L'account utente è chiuso. Tutte le identità e le entità correlate vengono rimosse.
pending	L'account utente è in sospeso. Richiede la conferma dell'identità prima che possa essere attivata.

Condividi tramite

User - Create Or Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementCreateUser

Esempio di richiesta

Risposta di esempio

Definizioni

AppType

Confirmation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

Risorse aggiuntive