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=2022-08-01
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 |
---|---|---|---|---|
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
service
|
path | True |
string |
Nombre del servicio API Management. Patrón de Regex: |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
user
|
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 |
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 |
Determina el tipo de correo electrónico de confirmación que se enviará al usuario recién creado. |
||
properties.identities |
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 |
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 |
El usuario se actualizó correctamente. Encabezados ETag: string |
|
201 Created |
El usuario se creó correctamente. Encabezados ETag: string |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de 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 | suplantación de su cuenta de usuario |
Ejemplos
ApiManagementCreateUser
Solicitud de ejemplo
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"
}
}
Respuesta de muestra
{
"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"
}
]
}
}
{
"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 |
---|---|
App |
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. |
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
Group |
Propiedades del contrato de grupo. |
Group |
Tipo de grupo. |
User |
Detalles del usuario. |
User |
Detalles de creación del usuario. |
User |
Detalles de la identidad del usuario. |
User |
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 |
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 |
type |
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 |
La colección de grupos de usuarios forma parte de . |
||
properties.identities |
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: |
|
properties.state | 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 |
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 |
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 |
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 | 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. |