User - Create Or Update

Referens

Tjänst:: API Management

API-version:: 2024-05-01

Skapar eller uppdaterar en användare.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
userId	path	True	string minLength: 1 maxLength: 80	Användaridentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
notify	query		boolean	Skicka ett e-postmeddelande till användaren.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match		string	ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.email	True	string minLength: 1 maxLength: 254	E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen.
properties.firstName	True	string minLength: 1 maxLength: 100	Förnamn.
properties.lastName	True	string minLength: 1 maxLength: 100	Efternamn.
properties.appType		AppType	Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen.
properties.confirmation		Confirmation	Avgör vilken typ av e-postbekräftelse som ska skickas till den nyskapade användaren.
properties.identities		UserIdentityContract[]	Samling med användaridentiteter.
properties.note		string	Valfritt meddelande om en användare som angetts av administratören.
properties.password		string	Användarlösenord. Om inget värde anges genereras ett standardlösenord.
properties.state		UserState	Kontotillstånd. Anger om användaren är aktiv eller inte. Blockerade användare kan inte logga in på utvecklarportalen eller anropa API:er för prenumerationsprodukter. Standardtillståndet är Aktivt.

Svar

Name	Typ	Description
200 OK	UserContract	Användaren har uppdaterats. Sidhuvuden ETag: string
201 Created	UserContract	Användaren har skapats. Sidhuvuden ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

UserContract

Användaren har uppdaterats.

Sidhuvuden

ETag: string

201 Created

UserContract

Användaren har skapats.

Sidhuvuden

ETag: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementCreateUser

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
      }
    ]
  }
}

Statuskod:: 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"
      }
    ]
  }
}

Definitioner

Name	Description
AppType	Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen.
Confirmation	Avgör vilken typ av e-postbekräftelse som ska skickas till den nyskapade användaren.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GroupContractProperties	Egenskaper för gruppkontrakt.
GroupType	Grupptyp.
UserContract	Användarinformation.
UserCreateParameters	Användarskapa information.
UserIdentityContract	Information om användaridentitet.
UserState	Kontotillstånd. Anger om användaren är aktiv eller inte. Blockerade användare kan inte logga in på utvecklarportalen eller anropa API:er för prenumerationsprodukter. Standardtillståndet är Aktivt.

AppType

Uppräkning

Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen.

Värde	Description
developerPortal	Begäran om användarskapning skickades av den nya utvecklarportalen.
portal	Begäran om användarskapning skickades av den äldre utvecklarportalen.

Confirmation

Uppräkning

Avgör vilken typ av e-postbekräftelse som ska skickas till den nyskapade användaren.

Värde	Description
invite	Skicka ett e-postmeddelande där användaren uppmanas att registrera sig och slutföra registreringen.
signup	Skicka ett e-postmeddelande till användaren som bekräftar att de har registrerat sig.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

GroupContractProperties

Objekt

Egenskaper för gruppkontrakt.

Name	Typ	Description
builtIn	boolean	sant om gruppen är en av de tre systemgrupperna (administratörer, utvecklare eller gäster); annars falskt.
description	string maxLength: 1000	Gruppbeskrivning. Kan innehålla HTML-formateringstaggar.
displayName	string minLength: 1 maxLength: 300	Gruppnamn.
externalId	string	För externa grupper innehåller den här egenskapen id:t för gruppen från den externa identitetsprovidern, t.ex. för Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; annars är värdet null.
type	GroupType	Grupptyp.

GroupType

Uppräkning

Grupptyp.

Värde	Description
custom
external
system

UserContract

Objekt

Användarinformation.

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Namnet på resursen
properties.email	string		E-postadress.
properties.firstName	string		Förnamn.
properties.groups	GroupContractProperties[]		Samling med grupper som användaren är en del av.
properties.identities	UserIdentityContract[]		Samling med användaridentiteter.
properties.lastName	string		Efternamn.
properties.note	string		Valfritt meddelande om en användare som angetts av administratören.
properties.registrationDate	string (date-time)		Datum för användarregistrering. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.state	UserState	active	Kontotillstånd. Anger om användaren är aktiv eller inte. Blockerade användare kan inte logga in på utvecklarportalen eller anropa API:er för prenumerationsprodukter. Standardtillståndet är Aktivt.
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

UserCreateParameters

Objekt

Användarskapa information.

Name	Typ	Standardvärde	Description
properties.appType	AppType		Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen.
properties.confirmation	Confirmation		Avgör vilken typ av e-postbekräftelse som ska skickas till den nyskapade användaren.
properties.email	string minLength: 1 maxLength: 254		E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen.
properties.firstName	string minLength: 1 maxLength: 100		Förnamn.
properties.identities	UserIdentityContract[]		Samling med användaridentiteter.
properties.lastName	string minLength: 1 maxLength: 100		Efternamn.
properties.note	string		Valfritt meddelande om en användare som angetts av administratören.
properties.password	string		Användarlösenord. Om inget värde anges genereras ett standardlösenord.
properties.state	UserState	active	Kontotillstånd. Anger om användaren är aktiv eller inte. Blockerade användare kan inte logga in på utvecklarportalen eller anropa API:er för prenumerationsprodukter. Standardtillståndet är Aktivt.

UserIdentityContract

Objekt

Information om användaridentitet.

Name	Typ	Description
id	string	Identifierarvärde inom providern.
provider	string	Identitetsproviderns namn.

UserState

Uppräkning

Kontotillstånd. Anger om användaren är aktiv eller inte. Blockerade användare kan inte logga in på utvecklarportalen eller anropa API:er för prenumerationsprodukter. Standardtillståndet är Aktivt.

Värde	Description
active	Användartillståndet är aktivt.
blocked	Användaren är blockerad. Blockerade användare kan inte autentisera på utvecklarportalen eller anropa API.
deleted	Användarkontot är stängt. Alla identiteter och relaterade entiteter tas bort.
pending	Användarkontot väntar. Kräver identitetsbekräftelse innan den kan aktiveras.

Dela via

User - Create Or Update

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementCreateUser

Exempelbegäran

Exempelsvar

Definitioner

AppType

Confirmation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

Ytterligare resurser