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 參數

名稱 位於 必要 類型 Description
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 管理服務的名稱。
subscriptionId
 path True

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。
userId
 path True

string

minLength: 1
maxLength: 80

用戶標識碼。 目前 API 管理服務實例中必須是唯一的。
api-version
 query True

string

minLength: 1

要用於這項作業的 API 版本。
notify
 query

boolean

傳送電子郵件通知給使用者。

要求標頭

名稱 必要 類型 Description
If-Match

string

實體的 ETag。 建立實體時不需要，但在更新實體時則為必要專案。

要求本文

名稱 必要 類型 Description
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[]

使用者身分識別的集合。
properties.note

string

系統管理員所設定使用者的相關選擇性注意事項。
properties.password

string

用戶密碼。 如果未提供任何值，則會產生默認密碼。
properties.state

UserState

帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站，或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。

回應

名稱 類型 Description
200 OK

UserContract

使用者已成功更新。

標題

ETag: string
201 Created

UserContract

已成功建立使用者。

標題

ETag: string
Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

ApiManagementCreateUser

範例要求

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

定義

名稱 Description
AppType

決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。
Confirmation

決定將傳送給新建立使用者的確認電子郵件類型。
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應
GroupContractProperties

群組合約屬性。
GroupType

群組類型。
UserContract

使用者詳細數據。
UserCreateParameters

使用者建立詳細數據。
UserIdentityContract

使用者身分識別詳細數據。
UserState

帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站，或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。

AppType

列舉型別

決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。

值 Description
portal

使用者建立要求是由舊版開發人員入口網站傳送。
developerPortal

新的開發人員入口網站已傳送使用者建立要求。

Confirmation

列舉型別

決定將傳送給新建立使用者的確認電子郵件類型。

值 Description
signup

傳送電子郵件給確認他們已成功註冊的使用者。
invite

傳送邀請用戶註冊並完成註冊的電子郵件。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細數據。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

Object

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

GroupContractProperties

Object

群組合約屬性。

名稱 類型 Description
builtIn

boolean

如果群組是三個系統群組之一，則為 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>;否則此值為 null。
type

GroupType

群組類型。

GroupType

列舉型別

群組類型。

值 Description
custom
system
external

UserContract

Object

使用者詳細數據。

名稱 類型 預設值 Description
id

string

資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

資源的名稱
properties.email

string

電子郵件位址。
properties.firstName

string

名字。
properties.groups

GroupContractProperties[]

用戶所屬群組的集合。
properties.identities

UserIdentityContract[]

使用者身分識別的集合。
properties.lastName

string

姓。
properties.note

string

系統管理員所設定使用者的相關選擇性注意事項。
properties.registrationDate

string (date-time)

用戶註冊的日期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
properties.state

UserState

active

帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站，或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。
type

string

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

UserCreateParameters

Object

使用者建立詳細數據。

名稱 類型 預設值 Description
properties.appType

AppType

決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。
properties.confirmation

Confirmation

決定將傳送給新建立使用者的確認電子郵件類型。
properties.email

string

minLength: 1
maxLength: 254

電子郵件位址。 不能是空的，而且在服務實例內必須是唯一的。
properties.firstName

string

minLength: 1
maxLength: 100

名字。
properties.identities

UserIdentityContract[]

使用者身分識別的集合。
properties.lastName

string

minLength: 1
maxLength: 100

姓。
properties.note

string

系統管理員所設定使用者的相關選擇性注意事項。
properties.password

string

用戶密碼。 如果未提供任何值，則會產生默認密碼。
properties.state

UserState

active

帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站，或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。

UserIdentityContract

Object

使用者身分識別詳細數據。

名稱 類型 Description
id

string

提供者內的標識碼值。
provider

string

識別提供者名稱。

UserState

列舉型別

帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站，或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。

值 Description
active

用戶狀態為作用中。
blocked

使用者遭到封鎖。 封鎖的使用者無法在開發人員入口網站或呼叫 API 進行驗證。
pending

用戶帳戶擱置中。 必須先確認身分識別，才能啟用身分識別。
deleted

用戶帳戶已關閉。 會移除所有身分識別和相關實體。