User - Create Or Update

Service:

API Management

API Version:

2022-08-01

Crea o actualiza un usuario

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName	path	True	string	Nombre del servicio API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Identificador de la suscripción de destino.
userId	path	True	string	Identificador del usuario. Debe ser único en la instancia de servicio API Management actual.
api-version	query	True	string	Versión de API que se usará para la operación.
notify	query		boolean	Envíe una notificación Email al usuario.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match		string	ETag de la entidad. No es necesario al crear una entidad, pero es necesario al actualizar una entidad.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.email	True	string	Dirección de correo electrónico. No debe estar vacía y debe ser única dentro de la instancia de servicio.
properties.firstName	True	string	Nombre.
properties.lastName	True	string	Apellidos.
properties.appType		AppType	Determina el tipo de aplicación que envía la solicitud de creación del usuario. El valor predeterminado es el portal heredado.
properties.confirmation		Confirmation	Determina el tipo de correo electrónico de confirmación que se enviará al usuario recién creado.
properties.identities		UserIdentityContract[]	Colección de identidades de usuario.
properties.note		string	Nota opcional sobre un usuario, establecida por el administrador.
properties.password		string	Contraseña de usuario. Si no se proporciona ningún valor, se genera una contraseña predeterminada.
properties.state		UserState	Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de los productos a los que están suscritos. El estado predeterminado es Activo.

Respuestas

Nombre	Tipo	Description
200 OK	UserContract	El usuario se actualizó correctamente. Headers ETag: string
201 Created	UserContract	El usuario se creó correctamente. Headers ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ApiManagementCreateUser

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2022-08-01

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

Java

import com.azure.resourcemanager.apimanagement.models.Confirmation;

/** Samples for User CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateUser.json
     */
    /**
     * Sample code: ApiManagementCreateUser.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateUser(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .users()
            .define("5931a75ae4bbd512288c680b")
            .withExistingService("rg1", "apimService1")
            .withEmail("foobar@outlook.com")
            .withFirstName("foo")
            .withLastName("bar")
            .withConfirmation(Confirmation.SIGNUP)
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_user.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.user.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        user_id="5931a75ae4bbd512288c680b",
        parameters={
            "properties": {
                "confirmation": "signup",
                "email": "foobar@outlook.com",
                "firstName": "foo",
                "lastName": "bar",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateUser.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateUser.json
func ExampleUserClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewUserClient().CreateOrUpdate(ctx, "rg1", "apimService1", "5931a75ae4bbd512288c680b", armapimanagement.UserCreateParameters{
		Properties: &armapimanagement.UserCreateParameterProperties{
			Confirmation: to.Ptr(armapimanagement.ConfirmationSignup),
			Email:        to.Ptr("foobar@outlook.com"),
			FirstName:    to.Ptr("foo"),
			LastName:     to.Ptr("bar"),
		},
	}, &armapimanagement.UserClientCreateOrUpdateOptions{Notify: nil,
		IfMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.UserContract = armapimanagement.UserContract{
	// 	Name: to.Ptr("5931a75ae4bbd512288c680b"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/users"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b"),
	// 	Properties: &armapimanagement.UserContractProperties{
	// 		Identities: []*armapimanagement.UserIdentityContract{
	// 			{
	// 				ID: to.Ptr("foobar@outlook.com"),
	// 				Provider: to.Ptr("Basic"),
	// 		}},
	// 		State: to.Ptr(armapimanagement.UserStateActive),
	// 		Email: to.Ptr("foobar@outlook.com"),
	// 		FirstName: to.Ptr("foo"),
	// 		Groups: []*armapimanagement.GroupContractProperties{
	// 		},
	// 		LastName: to.Ptr("bar"),
	// 		RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-07T21:21:29.160Z"); return t}()),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or Updates a user.
 *
 * @summary Creates or Updates a user.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateUser.json
 */
async function apiManagementCreateUser() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const userId = "5931a75ae4bbd512288c680b";
  const parameters = {
    confirmation: "signup",
    email: "foobar@outlook.com",
    firstName: "foo",
    lastName: "bar",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.user.createOrUpdate(
    resourceGroupName,
    serviceName,
    userId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "id": "/subscriptions/subid/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"
      }
    ]
  }
}

Status code:

200

{
  "id": "/subscriptions/subid/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"
      }
    ]
  }
}

Definiciones

Nombre	Description
AppType	Determina el tipo de aplicación que envía la solicitud de creación del usuario. El valor predeterminado es el portal heredado.
Confirmation	Determina el tipo de correo electrónico de confirmación que se enviará al usuario recién creado.
ErrorFieldContract	Contrato de campo de error.
ErrorResponse	Respuesta de error.
GroupContractProperties	Propiedades del contrato de grupo.
GroupType	Tipo de grupo.
UserContract	Detalles del usuario.
UserCreateParameters	Detalles de creación del usuario.
UserIdentityContract	Detalles de la identidad del usuario.
UserState	Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de los productos a los que están suscritos. El estado predeterminado es Activo.

AppType

Determina el tipo de aplicación que envía la solicitud de creación del usuario. El valor predeterminado es el portal heredado.

Nombre	Tipo	Description
developerPortal	string	El nuevo portal para desarrolladores envió la solicitud de creación de usuarios.
portal	string	El portal para desarrolladores heredado envió la solicitud de creación de usuarios.

Confirmation

Determina el tipo de correo electrónico de confirmación que se enviará al usuario recién creado.

Nombre	Tipo	Description
invite	string	Envíe un correo electrónico que invite al usuario a registrarse y completar el registro.
signup	string	Envíe un correo electrónico al usuario que confirme que se ha registrado correctamente.

ErrorFieldContract

Contrato de campo de error.

Nombre	Tipo	Description
code	string	Código de error de nivel de propiedad.
message	string	Representación legible del error de nivel de propiedad.
target	string	Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error.code	string	Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
error.details	ErrorFieldContract[]	La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message	string	Representación legible del error.

GroupContractProperties

Propiedades del contrato de grupo.

Nombre	Tipo	Description
builtIn	boolean	True si el grupo es uno de los tres grupos del sistema (administradores, desarrolladores o invitados); de lo contrario, false.
description	string	Descripción de grupo. Puede contener etiquetas de formato HTML.
displayName	string	Nombre de grupo.
externalId	string	En el caso de los grupos externos, esta propiedad contiene el identificador del grupo del proveedor de identidades externo, por ejemplo, para Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; de lo contrario, el valor es NULL.
type	GroupType	Tipo de grupo.

GroupType

Tipo de grupo.

Nombre	Tipo	Description
custom	string
external	string
system	string

UserContract

Detalles del usuario.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nombre del recurso.
properties.email	string		Dirección de correo electrónico.
properties.firstName	string		Nombre.
properties.groups	GroupContractProperties[]		La colección de grupos de usuarios forma parte de .
properties.identities	UserIdentityContract[]		Colección de identidades de usuario.
properties.lastName	string		Apellidos.
properties.note	string		Nota opcional sobre un usuario, establecida por el administrador.
properties.registrationDate	string		Fecha de registro de usuario. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.
properties.state	UserState	active	Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de los productos a los que están suscritos. El estado predeterminado es Activo.
type	string		Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

UserCreateParameters

Detalles de creación del usuario.

Nombre	Tipo	Valor predeterminado	Description
properties.appType	AppType		Determina el tipo de aplicación que envía la solicitud de creación del usuario. El valor predeterminado es el portal heredado.
properties.confirmation	Confirmation		Determina el tipo de correo electrónico de confirmación que se enviará al usuario recién creado.
properties.email	string		Dirección de correo electrónico. No debe estar vacía y debe ser única dentro de la instancia de servicio.
properties.firstName	string		Nombre.
properties.identities	UserIdentityContract[]		Colección de identidades de usuario.
properties.lastName	string		Apellidos.
properties.note	string		Nota opcional sobre un usuario, establecida por el administrador.
properties.password	string		Contraseña de usuario. Si no se proporciona ningún valor, se genera una contraseña predeterminada.
properties.state	UserState	active	Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de los productos a los que están suscritos. El estado predeterminado es Activo.

UserIdentityContract

Detalles de la identidad del usuario.

Nombre	Tipo	Description
id	string	Valor de identificador dentro del proveedor.
provider	string	Nombre del proveedor de identidades.

UserState

Estado de la cuenta. Especifica si el usuario está activo o no. Los usuarios bloqueados no pueden iniciar sesión en el portal para desarrolladores ni llamar a ninguna API de los productos a los que están suscritos. El estado predeterminado es Activo.

Nombre	Tipo	Description
active	string	El estado del usuario está activo.
blocked	string	El usuario está bloqueado. Los usuarios bloqueados no se pueden autenticar en el portal para desarrolladores ni en la API de llamada.
deleted	string	La cuenta de usuario está cerrada. Se quitan todas las identidades y las entidades relacionadas.
pending	string	La cuenta de usuario está pendiente. Requiere confirmación de identidad antes de que se pueda activar.