Authorization Server - Update

リファレンス

サービス:: API Management

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

識別子で指定された承認サーバーの詳細を更新します。

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

URI パラメーター

名前	/	必須	型	説明
authsid	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	承認サーバーの識別子。
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 である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match	True	string	エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。

要求本文

名前	型	説明
properties.authorizationEndpoint	string	OAuth 承認エンドポイント。 http://tools.ietf.org/html/rfc6749#section-3.2を参照してください。
properties.authorizationMethods	AuthorizationMethod[]	承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	アクセストークンを API に渡すメカニズムを指定します。
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	この承認サーバーのトークンエンドポイントでサポートされる認証方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。
properties.clientId	string	この承認サーバーに登録されているクライアントまたはアプリ ID。
properties.clientRegistrationEndpoint	string	この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。参照されるエンティティへの絶対 URL が含まれています。
properties.clientSecret	string	この承認サーバーに登録されているクライアントまたはアプリシークレット。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。
properties.defaultScope	string	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切りの値を含む文字列の形式で指定する必要があります。
properties.description	string	承認サーバーの説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string minLength: 1 maxLength: 50	ユーザーフレンドリな承認サーバー名。
properties.grantTypes	GrantType[]	クライアントがアクセストークンを要求するために使用する承認付与の形式。
properties.resourceOwnerPassword	string	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のパスワード。
properties.resourceOwnerUsername	string	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のユーザー名。
properties.supportState	boolean	true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。クライアントは、状態パラメーターを使用してプロトコルのセキュリティを高める場合があります。
properties.tokenBodyParameters	TokenBodyParameterContract[]	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。
properties.tokenEndpoint	string	OAuth トークンエンドポイント。参照されるエンティティへの絶対 URI が含まれています。
properties.useInApiDocumentation	boolean	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False。
properties.useInTestConsole	boolean	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True です。

応答

名前	型	説明
200 OK	AuthorizationServerContract	承認サーバーの設定が正常に更新されました。ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

AuthorizationServerContract

承認サーバーの設定が正常に更新されました。

ヘッダー

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	ユーザーアカウントを偽装する

例

ApiManagementUpdateAuthorizationServer

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2024-05-01


{
  "properties": {
    "clientId": "update",
    "clientSecret": "updated",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test3",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "clientAuthenticationMethod": [
      "Basic"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "updated",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

定義

名前	説明
AuthorizationMethod	承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
AuthorizationServerContract	外部 OAuth 承認サーバーの設定。
AuthorizationServerUpdateContract	外部 OAuth 承認サーバーの設定。
BearerTokenSendingMethod	アクセストークンを API に渡すメカニズムを指定します。
ClientAuthenticationMethod	この承認サーバーのトークンエンドポイントでサポートされる認証方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GrantType	クライアントがアクセストークンを要求するために使用する承認付与の形式。
TokenBodyParameterContract	OAuth 取得トークン要求本文パラメーター (www-url-form-encoded)。

AuthorizationMethod

列挙

承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。

値	説明
DELETE
GET
HEAD
OPTIONS
PATCH
POST
PUT
TRACE

AuthorizationServerContract

Object

外部 OAuth 承認サーバーの設定。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.authorizationEndpoint	string	OAuth 承認エンドポイント。 http://tools.ietf.org/html/rfc6749#section-3.2を参照してください。
properties.authorizationMethods	AuthorizationMethod[]	承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	アクセストークンを API に渡すメカニズムを指定します。
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	この承認サーバーのトークンエンドポイントでサポートされる認証方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。
properties.clientId	string	この承認サーバーに登録されているクライアントまたはアプリ ID。
properties.clientRegistrationEndpoint	string	この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。参照されるエンティティへの絶対 URL が含まれています。
properties.clientSecret	string	この承認サーバーに登録されているクライアントまたはアプリシークレット。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。
properties.defaultScope	string	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切りの値を含む文字列の形式で指定する必要があります。
properties.description	string	承認サーバーの説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string minLength: 1 maxLength: 50	ユーザーフレンドリな承認サーバー名。
properties.grantTypes	GrantType[]	クライアントがアクセストークンを要求するために使用する承認付与の形式。
properties.resourceOwnerPassword	string	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のパスワード。
properties.resourceOwnerUsername	string	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のユーザー名。
properties.supportState	boolean	true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。クライアントは、状態パラメーターを使用してプロトコルのセキュリティを高める場合があります。
properties.tokenBodyParameters	TokenBodyParameterContract[]	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。
properties.tokenEndpoint	string	OAuth トークンエンドポイント。参照されるエンティティへの絶対 URI が含まれています。
properties.useInApiDocumentation	boolean	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False。
properties.useInTestConsole	boolean	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True です。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

AuthorizationServerUpdateContract

Object

外部 OAuth 承認サーバーの設定。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.authorizationEndpoint	string	OAuth 承認エンドポイント。 http://tools.ietf.org/html/rfc6749#section-3.2を参照してください。
properties.authorizationMethods	AuthorizationMethod[]	承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	アクセストークンを API に渡すメカニズムを指定します。
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	この承認サーバーのトークンエンドポイントでサポートされる認証方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。
properties.clientId	string	この承認サーバーに登録されているクライアントまたはアプリ ID。
properties.clientRegistrationEndpoint	string	この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。参照されるエンティティへの絶対 URL が含まれています。
properties.clientSecret	string	この承認サーバーに登録されているクライアントまたはアプリシークレット。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。
properties.defaultScope	string	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切りの値を含む文字列の形式で指定する必要があります。
properties.description	string	承認サーバーの説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string minLength: 1 maxLength: 50	ユーザーフレンドリな承認サーバー名。
properties.grantTypes	GrantType[]	クライアントがアクセストークンを要求するために使用する承認付与の形式。
properties.resourceOwnerPassword	string	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のパスワード。
properties.resourceOwnerUsername	string	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のユーザー名。
properties.supportState	boolean	true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。クライアントは、状態パラメーターを使用してプロトコルのセキュリティを高める場合があります。
properties.tokenBodyParameters	TokenBodyParameterContract[]	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。
properties.tokenEndpoint	string	OAuth トークンエンドポイント。参照されるエンティティへの絶対 URI が含まれています。
properties.useInApiDocumentation	boolean	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False。
properties.useInTestConsole	boolean	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True です。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

列挙

アクセストークンを API に渡すメカニズムを指定します。

値	説明
authorizationHeader
query

ClientAuthenticationMethod

列挙

この承認サーバーのトークンエンドポイントでサポートされる認証方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。

値	説明
Basic	基本的なクライアント認証方法。
Body	本文ベースの認証方法。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

GrantType

列挙

クライアントがアクセストークンを要求するために使用する承認付与の形式。

値	説明
authorizationCode	https://tools.ietf.org/html/rfc6749#section-4.1の説明に従って、承認コード付与フローを実行します。
clientCredentials	https://tools.ietf.org/html/rfc6749#section-4.4の説明に従って、クライアント資格情報付与フローを実行します。
implicit	https://tools.ietf.org/html/rfc6749#section-4.2の説明に従った暗黙的なコード付与フロー。
resourceOwnerPassword	https://tools.ietf.org/html/rfc6749#section-4.3説明されているように、リソース所有者パスワード付与フロー。

TokenBodyParameterContract

Object

OAuth 取得トークン要求本文パラメーター (www-url-form-encoded)。

名前	型	説明
name	string	body パラメーター名。
value	string	body パラメーター値。

次の方法で共有

Authorization Server - Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementUpdateAuthorizationServer

要求のサンプル

応答のサンプル

定義

AuthorizationMethod

AuthorizationServerContract

AuthorizationServerUpdateContract

BearerTokenSendingMethod

ClientAuthenticationMethod

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GrantType

TokenBodyParameterContract

その他のリソース