User - Create Or Update

Referentie

Service:: API Management

API-versie:: 2024-05-01

Hiermee maakt of werkt u een gebruiker bij.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
userId	path	True	string minLength: 1 maxLength: 80	Gebruikers-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
notify	query		boolean	Een e-mailmelding verzenden naar de gebruiker.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

Aanvraagbody

Name	Vereist	Type	Description
properties.email	True	string minLength: 1 maxLength: 254	E-mailadres. Mag niet leeg zijn en moet uniek zijn binnen het service-exemplaar.
properties.firstName	True	string minLength: 1 maxLength: 100	Voornaam.
properties.lastName	True	string minLength: 1 maxLength: 100	Achternaam.
properties.appType		AppType	Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal.
properties.confirmation		Confirmation	Bepaalt het type bevestigingsmail dat naar de zojuist gemaakte gebruiker wordt verzonden.
properties.identities		UserIdentityContract[]	Verzameling gebruikersidentiteiten.
properties.note		string	Optionele opmerking over een gebruiker die is ingesteld door de beheerder.
properties.password		string	Gebruikerswachtwoord. Als er geen waarde wordt opgegeven, wordt er een standaardwachtwoord gegenereerd.
properties.state		UserState	Accountstatus. Hiermee geeft u op of de gebruiker actief is of niet. Geblokkeerde gebruikers kunnen zich niet aanmelden bij de ontwikkelaarsportal of eventuele API's van geabonneerde producten aanroepen. De standaardstatus is Actief.

Antwoorden

Name	Type	Description
200 OK	UserContract	De gebruiker is bijgewerkt. Kopteksten ETag: string
201 Created	UserContract	De gebruiker is gemaakt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

UserContract

De gebruiker is bijgewerkt.

Kopteksten

ETag: string

201 Created

UserContract

De gebruiker is gemaakt.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateUser

Voorbeeldaanvraag

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

Voorbeeldrespons

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

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

Definities

Name	Description
AppType	Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal.
Confirmation	Bepaalt het type bevestigingsmail dat naar de zojuist gemaakte gebruiker wordt verzonden.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GroupContractProperties	Eigenschappen van groepscontract.
GroupType	Groepstype.
UserContract	Gebruikersgegevens.
UserCreateParameters	Gebruikers maken details.
UserIdentityContract	Details van gebruikersidentiteit.
UserState	Accountstatus. Hiermee geeft u op of de gebruiker actief is of niet. Geblokkeerde gebruikers kunnen zich niet aanmelden bij de ontwikkelaarsportal of eventuele API's van geabonneerde producten aanroepen. De standaardstatus is Actief.

AppType

Inventarisatie

Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal.

Waarde	Description
developerPortal	De aanvraag voor het maken van gebruikers is verzonden door de nieuwe ontwikkelaarsportal.
portal	Aanvraag voor het maken van gebruikers is verzonden door de verouderde ontwikkelaarsportal.

Confirmation

Inventarisatie

Bepaalt het type bevestigingsmail dat naar de zojuist gemaakte gebruiker wordt verzonden.

Waarde	Description
invite	Stuur een e-mail waarin de gebruiker wordt uitgenodigd om zich aan te melden en de registratie te voltooien.
signup	Verzend een e-mailbericht naar de gebruiker om te bevestigen dat deze zich heeft geregistreerd.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GroupContractProperties

Object

Eigenschappen van groepscontract.

Name	Type	Description
builtIn	boolean	waar als de groep een van de drie systeemgroepen is (beheerders, ontwikkelaars of gasten); anders onwaar.
description	string maxLength: 1000	Groepsbeschrijving. Kan HTML-opmaaktags bevatten.
displayName	string minLength: 1 maxLength: 300	Groepsnaam.
externalId	string	Voor externe groepen bevat deze eigenschap de id van de groep van de externe id-provider, bijvoorbeeld voor Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; anders is de waarde null.
type	GroupType	Groepstype.

GroupType

Inventarisatie

Groepstype.

Waarde	Description
custom
external
system

UserContract

Object

Gebruikersgegevens.

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		De naam van de resource
properties.email	string		E-mailadres.
properties.firstName	string		Voornaam.
properties.groups	GroupContractProperties[]		Verzameling van groepsgebruikers maakt deel uit van.
properties.identities	UserIdentityContract[]		Verzameling gebruikersidentiteiten.
properties.lastName	string		Achternaam.
properties.note	string		Optionele opmerking over een gebruiker die is ingesteld door de beheerder.
properties.registrationDate	string (date-time)		Datum van gebruikersregistratie. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.state	UserState	active	Accountstatus. Hiermee geeft u op of de gebruiker actief is of niet. Geblokkeerde gebruikers kunnen zich niet aanmelden bij de ontwikkelaarsportal of eventuele API's van geabonneerde producten aanroepen. De standaardstatus is Actief.
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

UserCreateParameters

Object

Gebruikers maken details.

Name	Type	Default value	Description
properties.appType	AppType		Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal.
properties.confirmation	Confirmation		Bepaalt het type bevestigingsmail dat naar de zojuist gemaakte gebruiker wordt verzonden.
properties.email	string minLength: 1 maxLength: 254		E-mailadres. Mag niet leeg zijn en moet uniek zijn binnen het service-exemplaar.
properties.firstName	string minLength: 1 maxLength: 100		Voornaam.
properties.identities	UserIdentityContract[]		Verzameling gebruikersidentiteiten.
properties.lastName	string minLength: 1 maxLength: 100		Achternaam.
properties.note	string		Optionele opmerking over een gebruiker die is ingesteld door de beheerder.
properties.password	string		Gebruikerswachtwoord. Als er geen waarde wordt opgegeven, wordt er een standaardwachtwoord gegenereerd.
properties.state	UserState	active	Accountstatus. Hiermee geeft u op of de gebruiker actief is of niet. Geblokkeerde gebruikers kunnen zich niet aanmelden bij de ontwikkelaarsportal of eventuele API's van geabonneerde producten aanroepen. De standaardstatus is Actief.

UserIdentityContract

Object

Details van gebruikersidentiteit.

Name	Type	Description
id	string	Id-waarde binnen provider.
provider	string	Naam van id-provider.

UserState

Inventarisatie

Accountstatus. Hiermee geeft u op of de gebruiker actief is of niet. Geblokkeerde gebruikers kunnen zich niet aanmelden bij de ontwikkelaarsportal of eventuele API's van geabonneerde producten aanroepen. De standaardstatus is Actief.

Waarde	Description
active	De gebruikersstatus is actief.
blocked	Gebruiker is geblokkeerd. Geblokkeerde gebruikers kunnen zich niet verifiëren bij de ontwikkelaarsportal of API aanroepen.
deleted	Gebruikersaccount is gesloten. Alle identiteiten en gerelateerde entiteiten worden verwijderd.
pending	Gebruikersaccount is in behandeling. Vereist identiteitsbevestiging voordat deze actief kan worden gemaakt.

Delen via

User - Create Or Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementCreateUser

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AppType

Confirmation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

Aanvullende resources