Authorization Server - Create Or Update

サービス:

API Management

API バージョン:

2021-08-01

新しい承認サーバーを作成するか、既存の承認サーバーを更新します。

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

URI パラメーター

名前	/	必須	型	説明
authsid	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	承認サーバーの識別子。
resourceGroupName	path	True	string	リソース グループの名前。
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	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント要求で使用する API のバージョン。

要求ヘッダー

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

要求本文

名前	必須	型	説明
properties.authorizationEndpoint	True	string	OAuth 承認エンドポイント。 http://tools.ietf.org/html/rfc6749#section-3.2を参照してください。
properties.clientId	True	string	この承認サーバーに登録されているクライアントまたはアプリ ID。
properties.clientRegistrationEndpoint	True	string	この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。 参照されるエンティティへの絶対 URL が含まれています。
properties.displayName	True	string minLength: 1 maxLength: 50	ユーザー フレンドリな承認サーバー名。
properties.grantTypes	True	GrantType[]	クライアントがアクセス トークンを要求するために使用する承認付与の形式。
properties.authorizationMethods		AuthorizationMethod[]	承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
properties.bearerTokenSendingMethods		BearerTokenSendingMethod[]	アクセス トークンを API に渡すメカニズムを指定します。
properties.clientAuthenticationMethod		ClientAuthenticationMethod[]	この承認サーバーのトークン エンドポイントでサポートされる認証方法。 使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。
properties.clientSecret		string	この承認サーバーに登録されているクライアントまたはアプリ シークレット。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。
properties.defaultScope		string	既定で要求されるアクセス トークン スコープ。 API レベルでオーバーライドできます。 スペース区切りの値を含む文字列の形式で指定する必要があります。
properties.description		string	承認サーバーの説明。 HTML 書式設定タグを含めることができます。
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 が含まれています。

応答

名前	型	説明
200 OK	AuthorizationServerContract	承認サーバーは既に登録されています。 ヘッダー ETag: string
201 Created	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	ユーザー アカウントを偽装する

例

ApiManagementCreateAuthorizationServer

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2021-08-01

{
  "properties": {
    "displayName": "test2",
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "clientSecret": "2",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.AuthorizationMethod;
import com.azure.resourcemanager.apimanagement.models.BearerTokenSendingMethod;
import com.azure.resourcemanager.apimanagement.models.GrantType;
import java.util.Arrays;

/** Samples for AuthorizationServer CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateAuthorizationServer.json
     */
    /**
     * Sample code: ApiManagementCreateAuthorizationServer.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateAuthorizationServer(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .authorizationServers()
            .define("newauthServer")
            .withExistingService("rg1", "apimService1")
            .withDisplayName("test2")
            .withClientRegistrationEndpoint("https://www.contoso.com/apps")
            .withAuthorizationEndpoint("https://www.contoso.com/oauth2/auth")
            .withGrantTypes(Arrays.asList(GrantType.AUTHORIZATION_CODE, GrantType.IMPLICIT))
            .withClientId("1")
            .withClientSecret("2")
            .withDescription("test server")
            .withAuthorizationMethods(Arrays.asList(AuthorizationMethod.GET))
            .withTokenEndpoint("https://www.contoso.com/oauth2/token")
            .withSupportState(true)
            .withDefaultScope("read write")
            .withBearerTokenSendingMethods(Arrays.asList(BearerTokenSendingMethod.AUTHORIZATION_HEADER))
            .withResourceOwnerUsername("un")
            .withResourceOwnerPassword("pwd")
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_authorization_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.authorization_server.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        authsid="newauthServer",
        parameters={
            "properties": {
                "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
                "authorizationMethods": ["GET"],
                "bearerTokenSendingMethods": ["authorizationHeader"],
                "clientId": "1",
                "clientRegistrationEndpoint": "https://www.contoso.com/apps",
                "clientSecret": "2",
                "defaultScope": "read write",
                "description": "test server",
                "displayName": "test2",
                "grantTypes": ["authorizationCode", "implicit"],
                "resourceOwnerPassword": "pwd",
                "resourceOwnerUsername": "un",
                "supportState": True,
                "tokenEndpoint": "https://www.contoso.com/oauth2/token",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateAuthorizationServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateAuthorizationServer.json
func ExampleAuthorizationServerClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationServerClient().CreateOrUpdate(ctx, "rg1", "apimService1", "newauthServer", armapimanagement.AuthorizationServerContract{
		Properties: &armapimanagement.AuthorizationServerContractProperties{
			Description: to.Ptr("test server"),
			AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
				to.Ptr(armapimanagement.AuthorizationMethodGET)},
			BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
				to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
			DefaultScope:               to.Ptr("read write"),
			ResourceOwnerPassword:      to.Ptr("pwd"),
			ResourceOwnerUsername:      to.Ptr("un"),
			SupportState:               to.Ptr(true),
			TokenEndpoint:              to.Ptr("https://www.contoso.com/oauth2/token"),
			AuthorizationEndpoint:      to.Ptr("https://www.contoso.com/oauth2/auth"),
			ClientID:                   to.Ptr("1"),
			ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
			ClientSecret:               to.Ptr("2"),
			DisplayName:                to.Ptr("test2"),
			GrantTypes: []*armapimanagement.GrantType{
				to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
				to.Ptr(armapimanagement.GrantTypeImplicit)},
		},
	}, &armapimanagement.AuthorizationServerClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationServerContract = armapimanagement.AuthorizationServerContract{
	// 	Name: to.Ptr("newauthServer"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/authorizationServers"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer"),
	// 	Properties: &armapimanagement.AuthorizationServerContractProperties{
	// 		Description: to.Ptr("test server"),
	// 		AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
	// 			to.Ptr(armapimanagement.AuthorizationMethodGET)},
	// 			BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
	// 				to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
	// 				DefaultScope: to.Ptr("read write"),
	// 				ResourceOwnerPassword: to.Ptr("pwd"),
	// 				ResourceOwnerUsername: to.Ptr("un"),
	// 				SupportState: to.Ptr(true),
	// 				TokenEndpoint: to.Ptr("https://www.contoso.com/oauth2/token"),
	// 				AuthorizationEndpoint: to.Ptr("https://www.contoso.com/oauth2/auth"),
	// 				ClientID: to.Ptr("1"),
	// 				ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
	// 				DisplayName: to.Ptr("test2"),
	// 				GrantTypes: []*armapimanagement.GrantType{
	// 					to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
	// 					to.Ptr(armapimanagement.GrantTypeImplicit)},
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates new authorization server or updates an existing authorization server.
 *
 * @summary Creates new authorization server or updates an existing authorization server.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateAuthorizationServer.json
 */
async function apiManagementCreateAuthorizationServer() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const authsid = "newauthServer";
  const parameters = {
    description: "test server",
    authorizationEndpoint: "https://www.contoso.com/oauth2/auth",
    authorizationMethods: ["GET"],
    bearerTokenSendingMethods: ["authorizationHeader"],
    clientId: "1",
    clientRegistrationEndpoint: "https://www.contoso.com/apps",
    clientSecret: "2",
    defaultScope: "read write",
    displayName: "test2",
    grantTypes: ["authorizationCode", "implicit"],
    resourceOwnerPassword: "pwd",
    resourceOwnerUsername: "un",
    supportState: true,
    tokenEndpoint: "https://www.contoso.com/oauth2/token",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.authorizationServer.createOrUpdate(
    resourceGroupName,
    serviceName,
    authsid,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateAuthorizationServer.json
// this example is just showing the usage of "AuthorizationServer_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementAuthorizationServerResource
ApiManagementAuthorizationServerCollection collection = apiManagementService.GetApiManagementAuthorizationServers();

// invoke the operation
string authsid = "newauthServer";
ApiManagementAuthorizationServerData data = new ApiManagementAuthorizationServerData()
{
    Description = "test server",
    AuthorizationMethods =
    {
    AuthorizationMethod.Get
    },
    TokenEndpoint = "https://www.contoso.com/oauth2/token",
    DoesSupportState = true,
    DefaultScope = "read write",
    BearerTokenSendingMethods =
    {
    BearerTokenSendingMethod.AuthorizationHeader
    },
    ResourceOwnerUsername = "un",
    ResourceOwnerPassword = "pwd",
    DisplayName = "test2",
    ClientRegistrationEndpoint = "https://www.contoso.com/apps",
    AuthorizationEndpoint = "https://www.contoso.com/oauth2/auth",
    GrantTypes =
    {
    GrantType.AuthorizationCode,GrantType.Implicit
    },
    ClientId = "1",
    ClientSecret = "2",
};
ArmOperation<ApiManagementAuthorizationServerResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, authsid, data);
ApiManagementAuthorizationServerResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementAuthorizationServerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

状態コード:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

定義

名前	説明
AuthorizationMethod	承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
AuthorizationServerContract	外部 OAuth 承認サーバーの設定。
BearerTokenSendingMethod	アクセス トークンを API に渡すメカニズムを指定します。
ClientAuthenticationMethod	この承認サーバーのトークン エンドポイントでサポートされる認証方法。 使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。
ErrorFieldContract	エラー フィールド コントラクト。
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 が含まれています。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

列挙

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

値	説明
authorizationHeader
query

ClientAuthenticationMethod

列挙

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

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

ErrorFieldContract

Object

エラー フィールド コントラクト。

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

Object

エラー応答。

名前	型	説明
error.code	string	サービス定義エラー コード。 このコードは、応答で指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	エラーの人間が判読できる表現。

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 パラメーター値。