User - Create Or Update

Referensi

Service:: API Management

API Version:: 2022-08-01

Membuat atau Memperbarui pengguna.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID langganan target.
userId	path	True	string	Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
notify	query		boolean	Kirim pemberitahuan Email ke Pengguna.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match		string	ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.email	True	string	Alamat Email. Tidak boleh kosong dan harus unik dalam instans layanan.
properties.firstName	True	string	Nama depan.
properties.lastName	True	string	Nama belakang.
properties.appType		AppType	Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan.
properties.confirmation		Confirmation	Menentukan jenis email konfirmasi yang akan dikirim ke pengguna yang baru dibuat.
properties.identities		UserIdentityContract[]	Kumpulan identitas pengguna.
properties.note		string	Catatan opsional tentang pengguna yang ditetapkan oleh administrator.
properties.password		string	Kata Sandi Pengguna. Jika tidak ada nilai yang disediakan, kata sandi default akan dibuat.
properties.state		UserState	Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif.

Respons

Nama	Jenis	Deskripsi
200 OK	UserContract	Pengguna berhasil diperbarui. Headers ETag: string
201 Created	UserContract	Pengguna berhasil dibuat. Headers ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Nama

Jenis

Deskripsi

200 OK

UserContract

Pengguna berhasil diperbarui.

Headers

ETag: string

201 Created

UserContract

Pengguna berhasil dibuat.

Headers

ETag: string

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementCreateUser

Sample Request

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

import com.azure.resourcemanager.apimanagement.models.Confirmation;

/** Samples for User CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateUser.json
     */
    /**
     * Sample code: ApiManagementCreateUser.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateUser(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .users()
            .define("5931a75ae4bbd512288c680b")
            .withExistingService("rg1", "apimService1")
            .withEmail("foobar@outlook.com")
            .withFirstName("foo")
            .withLastName("bar")
            .withConfirmation(Confirmation.SIGNUP)
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_user.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.user.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        user_id="5931a75ae4bbd512288c680b",
        parameters={
            "properties": {
                "confirmation": "signup",
                "email": "foobar@outlook.com",
                "firstName": "foo",
                "lastName": "bar",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateUser.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateUser.json
func ExampleUserClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewUserClient().CreateOrUpdate(ctx, "rg1", "apimService1", "5931a75ae4bbd512288c680b", armapimanagement.UserCreateParameters{
		Properties: &armapimanagement.UserCreateParameterProperties{
			Confirmation: to.Ptr(armapimanagement.ConfirmationSignup),
			Email:        to.Ptr("foobar@outlook.com"),
			FirstName:    to.Ptr("foo"),
			LastName:     to.Ptr("bar"),
		},
	}, &armapimanagement.UserClientCreateOrUpdateOptions{Notify: nil,
		IfMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.UserContract = armapimanagement.UserContract{
	// 	Name: to.Ptr("5931a75ae4bbd512288c680b"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/users"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b"),
	// 	Properties: &armapimanagement.UserContractProperties{
	// 		Identities: []*armapimanagement.UserIdentityContract{
	// 			{
	// 				ID: to.Ptr("foobar@outlook.com"),
	// 				Provider: to.Ptr("Basic"),
	// 		}},
	// 		State: to.Ptr(armapimanagement.UserStateActive),
	// 		Email: to.Ptr("foobar@outlook.com"),
	// 		FirstName: to.Ptr("foo"),
	// 		Groups: []*armapimanagement.GroupContractProperties{
	// 		},
	// 		LastName: to.Ptr("bar"),
	// 		RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-07T21:21:29.160Z"); return t}()),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or Updates a user.
 *
 * @summary Creates or Updates a user.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateUser.json
 */
async function apiManagementCreateUser() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const userId = "5931a75ae4bbd512288c680b";
  const parameters = {
    confirmation: "signup",
    email: "foobar@outlook.com",
    firstName: "foo",
    lastName: "bar",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.user.createOrUpdate(
    resourceGroupName,
    serviceName,
    userId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 201

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

Status code:: 200

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

Definisi

Nama	Deskripsi
AppType	Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan.
Confirmation	Menentukan jenis email konfirmasi yang akan dikirim ke pengguna yang baru dibuat.
ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
GroupContractProperties	Properti kontrak grup.
GroupType	Jenis grup.
UserContract	Detail pengguna.
UserCreateParameters	Detail pembuatan pengguna.
UserIdentityContract	Detail identitas pengguna.
UserState	Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif.

AppType

Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan.

Nama	Jenis	Deskripsi
developerPortal	string	Permintaan pembuatan pengguna dikirim oleh portal pengembang baru.
portal	string	Permintaan pembuatan pengguna dikirim oleh portal pengembang warisan.

Confirmation

Menentukan jenis email konfirmasi yang akan dikirim ke pengguna yang baru dibuat.

Nama	Jenis	Deskripsi
invite	string	Kirim email yang mengundang pengguna untuk mendaftar dan menyelesaikan pendaftaran.
signup	string	Kirim email ke pengguna yang mengonfirmasi bahwa mereka telah berhasil mendaftar.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

GroupContractProperties

Properti kontrak grup.

Nama	Jenis	Deskripsi
builtIn	boolean	true jika grup adalah salah satu dari tiga grup sistem (Administrator, Pengembang, atau Tamu); jika tidak salah.
description	string	Deskripsi grup. Dapat berisi tag pemformatan HTML.
displayName	string	Nama Grup.
externalId	string	Untuk grup eksternal, properti ini berisi id grup dari penyedia identitas eksternal, misalnya untuk Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; jika tidak, nilainya null.
type	GroupType	Jenis grup.

GroupType

Jenis grup.

Nama	Jenis	Deskripsi
custom	string
external	string
system	string

UserContract

Detail pengguna.

Nama	Jenis	Nilai Default	Deskripsi
id	string		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nama sumber daya.
properties.email	string		Alamat Email.
properties.firstName	string		Nama depan.
properties.groups	GroupContractProperties[]		Kumpulan pengguna grup adalah bagian dari.
properties.identities	UserIdentityContract[]		Kumpulan identitas pengguna.
properties.lastName	string		Nama belakang.
properties.note	string		Catatan opsional tentang pengguna yang ditetapkan oleh administrator.
properties.registrationDate	string		Tanggal pendaftaran pengguna. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.
properties.state	UserState	active	Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif.
type	string		Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

UserCreateParameters

Detail pembuatan pengguna.

Nama	Jenis	Nilai Default	Deskripsi
properties.appType	AppType		Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan.
properties.confirmation	Confirmation		Menentukan jenis email konfirmasi yang akan dikirim ke pengguna yang baru dibuat.
properties.email	string		Alamat Email. Tidak boleh kosong dan harus unik dalam instans layanan.
properties.firstName	string		Nama depan.
properties.identities	UserIdentityContract[]		Kumpulan identitas pengguna.
properties.lastName	string		Nama belakang.
properties.note	string		Catatan opsional tentang pengguna yang ditetapkan oleh administrator.
properties.password	string		Kata Sandi Pengguna. Jika tidak ada nilai yang disediakan, kata sandi default akan dibuat.
properties.state	UserState	active	Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif.

UserIdentityContract

Detail identitas pengguna.

Nama	Jenis	Deskripsi
id	string	Nilai pengidentifikasi dalam penyedia.
provider	string	Nama Penyedia Identitas.

UserState

Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif.

Nama	Jenis	Deskripsi
active	string	Status pengguna aktif.
blocked	string	Pengguna diblokir. Pengguna yang diblokir tidak dapat mengautentikasi di portal pengembang atau memanggil API.
deleted	string	Akun pengguna ditutup. Semua identitas dan entitas terkait dihapus.
pending	string	Akun pengguna tertunda. Memerlukan konfirmasi identitas sebelum dapat dibuat aktif.

User - Create Or Update

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

ApiManagementCreateUser

Sample Request

Sample Response

Definisi

AppType

Confirmation

ErrorFieldContract

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

Sumber Daya Tambahan: