User - Create Or Update

リファレンス

Service:: API Management

API Version:: 2022-08-01

ユーザーを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
serviceName	path	True	string	API Management サービスの名前。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
userId	path	True	string	ユーザー識別子。現在のAPI Management サービスインスタンスで一意である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。
notify	query		boolean	ユーザーにEmail通知を送信します。

要求ヘッダー

名前	必須	型	説明
If-Match		string	エンティティの ETag。エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。

要求本文

名前	必須	型	説明
properties.email	True	string	電子メールアドレス。空にしないでください。値は、サービスインスタンス内で一意である必要があります。
properties.firstName	True	string	名。
properties.lastName	True	string	姓。
properties.appType		AppType	ユーザー作成要求を送信するアプリケーションの種類を決定します。既定値はレガシポータルです。
properties.confirmation		Confirmation	新しく作成されたユーザーに送信される確認電子メールの種類を決定します。
properties.identities		UserIdentityContract[]	ユーザー ID のコレクション。
properties.note		string	管理者によって設定されたユーザーに関するオプションのメモ。
properties.password		string	ユーザーパスワード。値が指定されていない場合は、既定のパスワードが生成されます。
properties.state		UserState	アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされているユーザーは、開発者ポータルにサインインしたり、サブスクライブしている製品の API を呼び出したりできません。既定の状態は [アクティブ] です。

応答

名前	型	説明
200 OK	UserContract	ユーザーが正常に更新されました。 Headers ETag: string
201 Created	UserContract	ユーザーは正常に作成されました。 Headers ETag: string
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

UserContract

ユーザーが正常に更新されました。

Headers

ETag: string

201 Created

UserContract

ユーザーは正常に作成されました。

Headers

ETag: string

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

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

定義

名前	説明
AppType	ユーザー作成要求を送信するアプリケーションの種類を決定します。既定値はレガシポータルです。
Confirmation	新しく作成されたユーザーに送信される確認電子メールの種類を決定します。
ErrorFieldContract	エラーフィールドコントラクト。
ErrorResponse	エラー応答。
GroupContractProperties	グループコントラクトのプロパティ。
GroupType	[グループの種類]。
UserContract	ユーザーの詳細。
UserCreateParameters	ユーザー作成の詳細。
UserIdentityContract	ユーザー ID の詳細。
UserState	アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされているユーザーは、開発者ポータルにサインインしたり、サブスクライブしている製品の API を呼び出したりできません。既定の状態は [アクティブ] です。

AppType

ユーザー作成要求を送信するアプリケーションの種類を決定します。既定値はレガシポータルです。

名前	型	説明
developerPortal	string	ユーザー作成要求が新しい開発者ポータルによって送信されました。
portal	string	ユーザー作成要求は、レガシ開発者ポータルから送信されました。

Confirmation

新しく作成されたユーザーに送信される確認電子メールの種類を決定します。

名前	型	説明
invite	string	サインアップして登録を完了するようにユーザーを招待する電子メールを送信します。
signup	string	ユーザーが正常にサインアップしたことを確認する電子メールをユーザーに送信します。

ErrorFieldContract

エラーフィールドコントラクト。

名前	型	説明
code	string	プロパティレベルのエラーコード。
message	string	プロパティレベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラーコード。このコードは、応答に指定された HTTP エラーコードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

GroupContractProperties

グループコントラクトのプロパティ。

名前	型	説明
builtIn	boolean	グループが 3 つのシステムグループ (管理者、開発者、またはゲスト) のいずれかである場合は true。それ以外の場合は false。
description	string	グループの説明。 HTML 書式設定タグを含めることができます。
displayName	string	[グループ名]:
externalId	string	外部グループの場合、このプロパティには外部 ID プロバイダーのグループの ID (Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`の場合など) が含まれます。それ以外の場合、値は null です。
type	GroupType	[グループの種類]。

GroupType

[グループの種類]。

名前	型	説明
custom	string
external	string
system	string

UserContract

ユーザーの詳細。

名前	型	既定値	説明
id	string		リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		リソースの名前
properties.email	string		電子メールアドレス。
properties.firstName	string		名。
properties.groups	GroupContractProperties[]		ユーザーが参加しているグループのコレクション。
properties.identities	UserIdentityContract[]		ユーザー ID のコレクション。
properties.lastName	string		姓。
properties.note	string		管理者によって設定されたユーザーに関するオプションのメモ。
properties.registrationDate	string		ユーザー登録の日付。日付は、ISO 8601 標準で指定されている形式 `yyyy-MM-ddTHH:mm:ssZ` に準拠しています。
properties.state	UserState	active	アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされているユーザーは、開発者ポータルにサインインしたり、サブスクライブしている製品の API を呼び出したりできません。既定の状態は [アクティブ] です。
type	string		リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

UserCreateParameters

ユーザー作成の詳細。

名前	型	既定値	説明
properties.appType	AppType		ユーザー作成要求を送信するアプリケーションの種類を決定します。既定値はレガシポータルです。
properties.confirmation	Confirmation		新しく作成されたユーザーに送信される確認電子メールの種類を決定します。
properties.email	string		電子メールアドレス。空にしないでください。値は、サービスインスタンス内で一意である必要があります。
properties.firstName	string		名。
properties.identities	UserIdentityContract[]		ユーザー ID のコレクション。
properties.lastName	string		姓。
properties.note	string		管理者によって設定されたユーザーに関するオプションのメモ。
properties.password	string		ユーザーパスワード。値が指定されていない場合は、既定のパスワードが生成されます。
properties.state	UserState	active	アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされているユーザーは、開発者ポータルにサインインしたり、サブスクライブしている製品の API を呼び出したりできません。既定の状態は [アクティブ] です。

UserIdentityContract

ユーザー ID の詳細。

名前	型	説明
id	string	プロバイダー内の識別子の値。
provider	string	ID プロバイダー名。

UserState

アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされているユーザーは、開発者ポータルにサインインしたり、サブスクライブしている製品の API を呼び出したりできません。既定の状態は [アクティブ] です。

名前	型	説明
active	string	ユーザーの状態がアクティブです。
blocked	string	ユーザーがブロックされています。ブロックされたユーザーは、開発者ポータルで認証したり、API を呼び出したりすることはできません。
deleted	string	ユーザーアカウントが閉じられました。すべての ID と関連エンティティが削除されます。
pending	string	ユーザーアカウントが保留中です。アクティブにする前に ID の確認が必要です。

Share via

User - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

Scopes

例

ApiManagementCreateUser

Sample Request

Sample Response

定義

AppType

Confirmation

ErrorFieldContract

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

その他のリソース