User - Update

Werkt de details bij van de gebruiker die is opgegeven door de id.

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

URI-parameters

Name In Required Type Description
resourceGroupName
path True
  • string

De naam van de resourcegroep.

serviceName
path True
  • string

De naam van de API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Abonnementsreferenties die uw Microsoft Azure identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.

userId
path True
  • string

Gebruikers-id. Moet uniek zijn in het huidige API Management service-exemplaar.

api-version
query True
  • string

Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name Required Type Description
If-Match True
  • string

ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitstoestand van het header-antwoord van de GET-aanvraag, of moet * zijn voor onvoorwaardelijke updates.

Aanvraagbody

Name Type Description
properties.email
  • string

E-mailadres. Mag niet leeg zijn en moet uniek zijn binnen het service-exemplaar.

properties.firstName
  • string

Voornaam.

properties.identities

Verzameling van gebruikersidentiteiten.

properties.lastName
  • string

Achternaam.

properties.note
  • string

Optionele opmerking over een gebruiker die is ingesteld door de beheerder.

properties.password
  • string

Gebruikerswachtwoord.

properties.state

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

Antwoorden

Name Type Description
200 OK

De gebruiker is bijgewerkt.

Headers

  • ETag: string
Other Status Codes

Foutbericht waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateUser

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b?api-version=2020-12-01
If-Match: *
{
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2017-06-02T17:58:50.357Z",
    "identities": [
      {
        "provider": "Microsoft",
        "id": "*************"
      }
    ]
  }
}

Definities

ErrorFieldContract

Foutveldcontract.

ErrorResponse

Foutreactie.

GroupContractProperties

Eigenschappen van groepscontract.

GroupType

Groepstype.

UserContract

Gebruikersdetails.

UserIdentityContract

Details van de gebruikersidentiteit.

UserState

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

UserUpdateParameters

Parameters voor gebruikersupdates.

ErrorFieldContract

Foutveldcontract.

Name Type Description
code
  • string

Foutcode op eigenschapsniveau.

message
  • string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target
  • string

Eigenschapsnaam.

ErrorResponse

Foutreactie.

Name Type Description
error.code
  • string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

De lijst met ongeldige velden die in de aanvraag worden verzenden, in het geval van een validatiefout.

error.message
  • string

Door mensen leesbare weergave van de fout.

GroupContractProperties

Eigenschappen van groepscontract.

Name Type Description
builtIn
  • boolean

true als de groep een van de drie systeemgroepen is (beheerders, ontwikkelaars of gasten); anders false.

description
  • string

Groepsbeschrijving. Kan HTML-opmaaktags bevatten.

displayName
  • string

Groepsnaam.

externalId
  • string

Voor externe groepen bevat deze eigenschap de id van de groep van de externe id-provider, bijvoorbeeld voor Azure Active Directory; anders is de waarde aad://<tenant>.onmicrosoft.com/groups/<group object id> null.

type

Groepstype.

GroupType

Groepstype.

Name Type Description
custom
  • string
external
  • string
system
  • string

UserContract

Gebruikersdetails.

Name Type Description
id
  • string

Resource-id.

name
  • string

Resourcenaam.

properties.email
  • string

E-mailadres.

properties.firstName
  • string

Voornaam.

properties.groups

Het verzamelen van groepen waar de gebruiker deel van uitmaakt.

properties.identities

Verzameling van gebruikersidentiteiten.

properties.lastName
  • string

Achternaam.

properties.note
  • string

Optionele opmerking over een gebruiker die is ingesteld door de beheerder.

properties.registrationDate
  • string

Datum van gebruikersregistratie. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.

properties.state

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

type
  • string

Resourcetype voor API Management resource.

UserIdentityContract

Details van de gebruikersidentiteit.

Name Type Description
id
  • string

Id-waarde binnen provider.

provider
  • string

Naam van id-provider.

UserState

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

Name Type Description
active
  • string

De gebruikerstoestand is actief.

blocked
  • string

De gebruiker is geblokkeerd. Geblokkeerde gebruikers kunnen zich niet verifiëren in de ontwikkelaarsportal of api aanroepen.

deleted
  • string

Het gebruikersaccount is gesloten. Alle identiteiten en gerelateerde entiteiten worden verwijderd.

pending
  • string

Gebruikersaccount is in behandeling. Vereist een identiteitsbevestiging voordat deze actief kan worden gemaakt.

UserUpdateParameters

Parameters voor gebruikersupdates.

Name Type Description
properties.email
  • string

E-mailadres. Mag niet leeg zijn en moet uniek zijn binnen het service-exemplaar.

properties.firstName
  • string

Voornaam.

properties.identities

Verzameling van gebruikersidentiteiten.

properties.lastName
  • string

Achternaam.

properties.note
  • string

Optionele opmerking over een gebruiker die is ingesteld door de beheerder.

properties.password
  • string

Gebruikerswachtwoord.

properties.state

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