User - Create Or Update
Vytvoří nebo Aktualizace uživatele.
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
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
service
|
path | True |
string |
Název služby API Management. Vzor regulárního výrazu: |
subscription
|
path | True |
string |
ID cílového předplatného. |
user
|
path | True |
string |
Identifikátor uživatele. Musí být jedinečný v aktuální instanci služby API Management. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
notify
|
query |
boolean |
Pošlete uživateli oznámení o Email. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
If-Match |
string |
Značka ETag entity. Nevyžaduje se při vytváření entity, ale vyžaduje se při aktualizaci entity. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
properties.email | True |
string |
E-mailovou adresu Nesmí být prázdné a musí být jedinečné v rámci instance služby. |
properties.firstName | True |
string |
Jméno. |
properties.lastName | True |
string |
Příjmení. |
properties.appType |
Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu. |
||
properties.confirmation |
Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli. |
||
properties.identities |
Kolekce identit uživatelů. |
||
properties.note |
string |
Volitelná poznámka o uživateli nastaveném správcem |
|
properties.password |
string |
Uživatelské heslo. Pokud není zadaná žádná hodnota, vygeneruje se výchozí heslo. |
|
properties.state |
Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Uživatel byl úspěšně aktualizován. Hlavičky ETag: string |
|
201 Created |
Uživatel byl úspěšně vytvořen. Hlavičky ETag: string |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
ApiManagementCreateUser
Ukázkový požadavek
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"
}
}
Ukázková odpověď
{
"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"
}
]
}
}
Definice
Name | Description |
---|---|
App |
Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu. |
Confirmation |
Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli. |
Error |
Chyba Kontrakt pole. |
Error |
Odpověď na chybu. |
Group |
Vlastnosti smlouvy skupiny. |
Group |
Typ skupiny. |
User |
Podrobnosti o uživateli. |
User |
Podrobnosti o vytvoření uživatele |
User |
Podrobnosti o identitě uživatele |
User |
Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní. |
AppType
Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu.
Name | Typ | Description |
---|---|---|
developerPortal |
string |
Žádost o vytvoření uživatele byla odeslána novým portálem pro vývojáře. |
portal |
string |
Starší verze portálu pro vývojáře odeslala žádost o vytvoření uživatele. |
Confirmation
Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli.
Name | Typ | Description |
---|---|---|
invite |
string |
Pošlete uživateli e-mail s pozvánkou k registraci a dokončení registrace. |
signup |
string |
Odešlete uživateli e-mail s potvrzením, že se úspěšně zaregistroval. |
ErrorFieldContract
Chyba Kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Čitelné znázornění chyby na úrovni vlastností. |
target |
string |
Název vlastnosti. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error.code |
string |
Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi. |
error.details |
Seznam neplatných polí se odešle v žádosti v případě chyby ověření. |
|
error.message |
string |
Znázornění chyby čitelné pro člověka |
GroupContractProperties
Vlastnosti smlouvy skupiny.
Name | Typ | Description |
---|---|---|
builtIn |
boolean |
true, pokud je skupina jednou ze tří systémových skupin (Správci, Vývojáři nebo Hosté); jinak false. |
description |
string |
Popis skupiny. Může obsahovat značky formátování HTML. |
displayName |
string |
Název skupiny. |
externalId |
string |
U externích skupin obsahuje tato vlastnost ID skupiny od externího zprostředkovatele identity, například pro Azure Active Directory |
type |
Typ skupiny. |
GroupType
Typ skupiny.
Name | Typ | Description |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |
UserContract
Podrobnosti o uživateli.
Name | Typ | Default value | Description |
---|---|---|---|
id |
string |
Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
name |
string |
Název prostředku |
|
properties.email |
string |
E-mailovou adresu |
|
properties.firstName |
string |
Jméno. |
|
properties.groups |
Součástí je kolekce skupin, do které uživatel patří. |
||
properties.identities |
Kolekce identit uživatelů. |
||
properties.lastName |
string |
Příjmení. |
|
properties.note |
string |
Volitelná poznámka o uživateli nastaveném správcem |
|
properties.registrationDate |
string |
Datum registrace uživatele. Datum odpovídá následujícímu formátu: |
|
properties.state | active |
Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní. |
|
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
UserCreateParameters
Podrobnosti o vytvoření uživatele
Name | Typ | Default value | Description |
---|---|---|---|
properties.appType |
Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu. |
||
properties.confirmation |
Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli. |
||
properties.email |
string |
E-mailovou adresu Nesmí být prázdné a musí být jedinečné v rámci instance služby. |
|
properties.firstName |
string |
Jméno. |
|
properties.identities |
Kolekce identit uživatelů. |
||
properties.lastName |
string |
Příjmení. |
|
properties.note |
string |
Volitelná poznámka o uživateli nastaveném správcem |
|
properties.password |
string |
Uživatelské heslo. Pokud není zadaná žádná hodnota, vygeneruje se výchozí heslo. |
|
properties.state | active |
Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní. |
UserIdentityContract
Podrobnosti o identitě uživatele
Name | Typ | Description |
---|---|---|
id |
string |
Hodnota identifikátoru v rámci zprostředkovatele. |
provider |
string |
Název zprostředkovatele identity. |
UserState
Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní.
Name | Typ | Description |
---|---|---|
active |
string |
Stav uživatele je aktivní. |
blocked |
string |
Uživatel je zablokovaný. Blokovaní uživatelé se nemůžou ověřit na portálu pro vývojáře nebo volat rozhraní API. |
deleted |
string |
Uživatelský účet je uzavřen. Odeberou se všechny identity a související entity. |
pending |
string |
Uživatelský účet čeká na vyřízení. Před aktivací vyžaduje potvrzení identity. |