User - Create Or Update

Service:: API Management

Version d'API:: 2024-05-01

Crée ou met à jour un utilisateur.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
userId	path	True	string minLength: 1 maxLength: 80	Identificateur de l’utilisateur. Doit être unique dans l’instance actuelle du service Gestion des API.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
notify	query		boolean	Envoyez une notification par e-mail à l’utilisateur.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match		string	ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.email	True	string minLength: 1 maxLength: 254	Adresse courriel. Ne doit pas être vide et doit être unique dans l’instance de service.
properties.firstName	True	string minLength: 1 maxLength: 100	Prénom.
properties.lastName	True	string minLength: 1 maxLength: 100	Nom.
properties.appType		AppType	Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité.
properties.confirmation		Confirmation	Détermine le type de courrier électronique de confirmation qui sera envoyé à l’utilisateur nouvellement créé.
properties.identities		UserIdentityContract[]	Collection d’identités utilisateur.
properties.note		string	Remarque facultative sur un utilisateur défini par l’administrateur.
properties.password		string	Mot de passe de l’utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré.
properties.state		UserState	État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif.

Réponses

Nom	Type	Description
200 OK	UserContract	L’utilisateur a été correctement mis à jour. En-têtes ETag: string
201 Created	UserContract	L’utilisateur a été créé avec succès. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

UserContract

L’utilisateur a été correctement mis à jour.

En-têtes

ETag: string

201 Created

UserContract

L’utilisateur a été créé avec succès.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementCreateUser

Exemple de requête

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"
  }
}

Exemple de réponse

Code d’état:: 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"
      }
    ]
  }
}

Code d’état:: 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"
      }
    ]
  }
}

Définitions

Nom	Description
AppType	Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité.
Confirmation	Détermine le type de courrier électronique de confirmation qui sera envoyé à l’utilisateur nouvellement créé.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GroupContractProperties	Propriétés du contrat de groupe.
GroupType	Type de groupe.
UserContract	Détails de l’utilisateur.
UserCreateParameters	L’utilisateur crée des détails.
UserIdentityContract	Détails de l’identité de l’utilisateur.
UserState	État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif.

AppType

Énumération

Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité.

Valeur	Description
portal	La demande de création d’utilisateur a été envoyée par le portail des développeurs hérité.
developerPortal	La demande de création d’utilisateur a été envoyée par le nouveau portail des développeurs.

Confirmation

Énumération

Détermine le type de courrier électronique de confirmation qui sera envoyé à l’utilisateur nouvellement créé.

Valeur	Description
signup	Envoyez un e-mail à l’utilisateur confirmant qu’il a réussi à s’inscrire.
invite	Envoyez un e-mail invitant l’utilisateur à s’inscrire et à terminer l’inscription.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GroupContractProperties

Object

Propriétés du contrat de groupe.

Nom	Type	Description
builtIn	boolean	true si le groupe est l’un des trois groupes système (administrateurs, développeurs ou invités) ; sinon false.
description	string maxLength: 1000	Description du groupe. Peut contenir des balises de mise en forme HTML.
displayName	string minLength: 1 maxLength: 300	Nom du groupe.
externalId	string	Pour les groupes externes, cette propriété contient l’ID du groupe à partir du fournisseur d’identité externe, par exemple pour Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; sinon, la valeur est Null.
type	GroupType	Type de groupe.

GroupType

Énumération

Type de groupe.

Valeur	Description
custom
system
external

UserContract

Object

Détails de l’utilisateur.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nom de la ressource
properties.email	string		Adresse courriel.
properties.firstName	string		Prénom.
properties.groups	GroupContractProperties[]		La collection d’utilisateurs de groupes fait partie intégrante.
properties.identities	UserIdentityContract[]		Collection d’identités utilisateur.
properties.lastName	string		Nom.
properties.note	string		Remarque facultative sur un utilisateur défini par l’administrateur.
properties.registrationDate	string (date-time)		Date de l’inscription de l’utilisateur. La date est conforme au format suivant : `yyyy-MM-ddTHH:mm:ssZ` comme spécifié par la norme ISO 8601.
properties.state	UserState	active	État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

UserCreateParameters

Object

L’utilisateur crée des détails.

Nom	Type	Valeur par défaut	Description
properties.appType	AppType		Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité.
properties.confirmation	Confirmation		Détermine le type de courrier électronique de confirmation qui sera envoyé à l’utilisateur nouvellement créé.
properties.email	string minLength: 1 maxLength: 254		Adresse courriel. Ne doit pas être vide et doit être unique dans l’instance de service.
properties.firstName	string minLength: 1 maxLength: 100		Prénom.
properties.identities	UserIdentityContract[]		Collection d’identités utilisateur.
properties.lastName	string minLength: 1 maxLength: 100		Nom.
properties.note	string		Remarque facultative sur un utilisateur défini par l’administrateur.
properties.password	string		Mot de passe de l’utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré.
properties.state	UserState	active	État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif.

UserIdentityContract

Object

Détails de l’identité de l’utilisateur.

Nom	Type	Description
id	string	Valeur d’identificateur au sein du fournisseur.
provider	string	Nom du fournisseur d’identité.

UserState

Énumération

État du compte. Spécifie si l’utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ou appeler des API de produits abonnés. L’état par défaut est Actif.

Valeur	Description
active	L’état utilisateur est actif.
blocked	L’utilisateur est bloqué. Les utilisateurs bloqués ne peuvent pas s’authentifier sur le portail des développeurs ou appeler l’API.
pending	Le compte d’utilisateur est en attente. Nécessite la confirmation de l’identité avant de pouvoir être rendue active.
deleted	Le compte d’utilisateur est fermé. Toutes les identités et entités associées sont supprimées.

Partager via

User - Create Or Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ApiManagementCreateUser

Exemple de requête

Exemple de réponse

Définitions

AppType

Confirmation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState