Compartir a través de


User - Create Or Update

Crea o actualiza un usuario.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nombre del servicio API Management.

subscriptionId
path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.

userId
path True

string

minLength: 1
maxLength: 80

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

api-version
query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

notify
query

boolean

Envíe una notificación por correo electrónico 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 necesaria al actualizar una entidad.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
properties.email True

string

minLength: 1
maxLength: 254

Dirección de correo electrónico. No debe estar vacío y debe ser único dentro de la instancia de servicio.

properties.firstName True

string

minLength: 1
maxLength: 100

Nombre.

properties.lastName True

string

minLength: 1
maxLength: 100

Apellido.

properties.appType

AppType

Determina el tipo de aplicación que envía la solicitud de creación de 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 establecido 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 productos suscritos. El estado predeterminado es Activo.

Respuestas

Nombre Tipo Description
200 OK

UserContract

El usuario se actualizó correctamente.

Encabezados

ETag: string

201 Created

UserContract

El usuario se creó correctamente.

Encabezados

ETag: string

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

ApiManagementCreateUser

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AppType

Determina el tipo de aplicación que envía la solicitud de creación de 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.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del 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 productos suscritos. El estado predeterminado es Activo.

AppType

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

Valor Description
developerPortal

El nuevo portal para desarrolladores envió una solicitud de creación de usuarios.

portal

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.

Valor Description
invite

Envíe un correo electrónico que invite al usuario a registrarse y completar el registro.

signup

Envíe un correo electrónico al usuario que confirme que se ha registrado correctamente.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Detalles del error.

message

string

Mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de 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

maxLength: 1000

Descripción del grupo. Puede contener etiquetas de formato HTML.

displayName

string

minLength: 1
maxLength: 300

Nombre del 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.

Valor Description
custom
external
system

UserContract

Detalles del usuario.

Nombre Tipo Valor predeterminado Description
id

string

Identificador de recurso completo para el 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

Apellido.

properties.note

string

Nota opcional sobre un usuario establecido por el administrador.

properties.registrationDate

string (date-time)

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 productos suscritos. El estado predeterminado es Activo.

type

string

Tipo del 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 de 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

minLength: 1
maxLength: 254

Dirección de correo electrónico. No debe estar vacío y debe ser único dentro de la instancia de servicio.

properties.firstName

string

minLength: 1
maxLength: 100

Nombre.

properties.identities

UserIdentityContract[]

Colección de identidades de usuario.

properties.lastName

string

minLength: 1
maxLength: 100

Apellido.

properties.note

string

Nota opcional sobre un usuario establecido 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 productos 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 productos suscritos. El estado predeterminado es Activo.

Valor Description
active

El estado del usuario está activo.

blocked

El usuario está bloqueado. Los usuarios bloqueados no se pueden autenticar en el portal para desarrolladores ni llamar a la API.

deleted

Se cierra la cuenta de usuario. Se quitan todas las identidades y las entidades relacionadas.

pending

La cuenta de usuario está pendiente. Requiere confirmación de identidad antes de que se pueda activar.