共用方式為


User - Get Shared Access Token

取得使用者的共用存取授權令牌。

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

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

資源群組的名稱。

serviceName
path True

string

API 管理 服務的名稱。

Regex 模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

userId
path True

string

使用者識別碼。 目前 API 管理 服務實例中必須是唯一的。

api-version
query True

string

要與用戶端要求搭配使用的 API 版本。

要求本文

名稱 必要 類型 Description
properties.expiry True

string

令牌的到期時間。 令牌到期時間上限設定為 30 天。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

properties.keyType True

KeyType

要用來為用戶產生令牌的金鑰。

回應

名稱 類型 Description
200 OK

UserTokenResult

回應本文包含用戶的授權令牌。

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 模擬您的用戶帳戶

範例

ApiManagementUserToken

範例要求

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId1718/token?api-version=2021-08-01

{
  "properties": {
    "keyType": "primary",
    "expiry": "2019-04-21T00:44:24.2845269Z"
  }
}

範例回覆

{
  "value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

定義

名稱 Description
ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

KeyType

要用來為用戶產生令牌的金鑰。

UserTokenParameters

取得使用者令牌參數。

UserTokenResult

取得使用者令牌回應詳細數據。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

人類可讀取的屬性層級錯誤表示法。

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

ErrorFieldContract[]

在驗證錯誤時,要求中傳送的無效欄位清單。

error.message

string

人類可閱讀的錯誤表示法。

KeyType

要用來為用戶產生令牌的金鑰。

名稱 類型 Description
primary

string

secondary

string

UserTokenParameters

取得使用者令牌參數。

名稱 類型 預設值 Description
properties.expiry

string

令牌的到期時間。 令牌到期時間上限設定為 30 天。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

properties.keyType

KeyType

primary

要用來為用戶產生令牌的金鑰。

UserTokenResult

取得使用者令牌回應詳細數據。

名稱 類型 Description
value

string

用戶的共用存取授權令牌。