User - Get Shared Access Token
ユーザーの共有アクセス承認トークンを取得します。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token?api-version=2022-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 Regex pattern: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
user
|
path | True |
string |
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.expiry | True |
string |
トークンの有効期限。 最大トークンの有効期限は 30 日に設定されます。 日付は、ISO 8601 標準で指定されている形式 |
properties.keyType | True |
ユーザーのトークンの生成に使用するキー。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
応答本文には、ユーザーの承認トークンが含まれています。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
ApiManagementUserToken
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId1718/token?api-version=2022-08-01
{
"properties": {
"keyType": "primary",
"expiry": "2019-04-21T00:44:24.2845269Z"
}
}
Sample Response
{
"value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
定義
名前 | 説明 |
---|---|
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
Key |
ユーザーのトークンの生成に使用するキー。 |
User |
ユーザー トークン パラメーターを取得します。 |
User |
ユーザー トークン応答の詳細を取得します。 |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
KeyType
ユーザーのトークンの生成に使用するキー。
名前 | 型 | 説明 |
---|---|---|
primary |
string |
|
secondary |
string |
UserTokenParameters
ユーザー トークン パラメーターを取得します。
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
properties.expiry |
string |
トークンの有効期限。 最大トークンの有効期限は 30 日に設定されます。 日付は、ISO 8601 標準で指定されている形式 |
|
properties.keyType | primary |
ユーザーのトークンの生成に使用するキー。 |
UserTokenResult
ユーザー トークン応答の詳細を取得します。
名前 | 型 | 説明 |
---|---|---|
value |
string |
ユーザーの Shared Access Authorization トークン。 |