User - Create Or Update

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

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

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

省略可能なパラメーターを含む:

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

URI パラメーター

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

要求ヘッダー

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

要求本文

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

応答

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

名前

型

説明

200 OK

UserContract

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

ヘッダー

ETag: string

201 Created

UserContract

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

ヘッダー

ETag: string

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementCreateUser

要求のサンプル

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

応答のサンプル

状態コード:: 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"
      }
    ]
  }
}

状態コード:: 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"
      }
    ]
  }
}

定義

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

AppType

列挙

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

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

Confirmation

列挙

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

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

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

GroupContractProperties

Object

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

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

GroupType

列挙

グループの種類。

値	説明
custom
external
system

UserContract

Object

ユーザーの詳細。

名前	型	規定値	説明
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 (date-time)		ユーザー登録の日付。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.state	UserState	active	アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。既定の状態はアクティブです。
type	string		リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

UserCreateParameters

Object

ユーザー作成の詳細。

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

UserIdentityContract

Object

ユーザー ID の詳細。

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

UserState

列挙

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

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

次の方法で共有

User - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementCreateUser

要求のサンプル

応答のサンプル

定義

AppType

Confirmation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

その他のリソース