Authorization Server - Create Or Update

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

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

URI パラメーター

名前 / 必須 説明
authsid
path True

string

承認サーバーの識別子。

正規表現パターン: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName
path True

string

API Management サービスの名前。

正規表現パターン: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

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 またはアプリ ID。

properties.clientRegistrationEndpoint True

string

この承認サーバーに対するクライアントまたはアプリの登録が実行されるページへの参照 (オプション)。 参照するエンティティの絶対 URL が含まれます。

properties.displayName True

string

ユーザー フレンドリな承認サーバー名。

properties.grantTypes True

GrantType[]

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

properties.authorizationMethods

AuthorizationMethod[]

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

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

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

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

この承認サーバーのトークン エンドポイントによってサポートされる認証の方法。 使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターは、要求本文内で application/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 が含まれます。

properties.useInApiDocumentation

boolean

true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。 値が指定されていない場合、既定では False。

properties.useInTestConsole

boolean

true の場合、承認サーバーは開発者ポータルのテスト コンソールで使用できます。 値が指定されていない場合は、既定で True を指定します。

応答

名前 説明
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

要求のサンプル

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

{
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "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"
  }
}

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "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"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "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 を指定すると、クライアント資格情報とその他のパラメーターは、要求本文内で application/x-www-form-urlencoded 形式で渡されます。

ErrorFieldContract

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

ErrorResponse

エラー応答。

GrantType

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

TokenBodyParameterContract

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

AuthorizationMethod

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

名前 説明
DELETE

string

GET

string

HEAD

string

OPTIONS

string

PATCH

string

POST

string

PUT

string

TRACE

string

AuthorizationServerContract

外部 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 を指定すると、クライアント資格情報とその他のパラメーターは、要求本文内で application/x-www-form-urlencoded 形式で渡されます。

properties.clientId

string

この承認サーバーに登録されているクライアント ID またはアプリ ID。

properties.clientRegistrationEndpoint

string

この承認サーバーに対するクライアントまたはアプリの登録が実行されるページへの参照 (オプション)。 参照するエンティティの絶対 URL が含まれます。

properties.clientSecret

string

この承認サーバーに登録されているクライアント シークレットまたはアプリ シークレット。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。

properties.defaultScope

string

既定で要求されるアクセス トークン スコープ。 API レベルでオーバーライドできます。 スペース区切り値を含む文字列の形式で提供される必要があります。

properties.description

string

承認サーバーの説明。 HTML 書式設定タグを含めることができます。

properties.displayName

string

ユーザー フレンドリな承認サーバー名。

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

string

query

string

ClientAuthenticationMethod

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

名前 説明
Basic

string

基本的なクライアント認証方法。

Body

string

本文ベースの認証方法。

ErrorFieldContract

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

名前 説明
code

string

プロパティ レベルのエラー コード。

message

string

プロパティ レベルエラーの人間が判読できる表現。

target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。

error.message

string

人が判読できるエラーの表現。

GrantType

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

名前 説明
authorizationCode

string

の説明に従って、承認コード付与フローを実行します https://tools.ietf.org/html/rfc6749#section-4.1

clientCredentials

string

説明に従 https://tools.ietf.org/html/rfc6749#section-4.4って、クライアント資格情報付与フロー。

implicit

string

の説明に従 https://tools.ietf.org/html/rfc6749#section-4.2った暗黙的なコード付与フロー。

resourceOwnerPassword

string

説明に従 https://tools.ietf.org/html/rfc6749#section-4.3って、リソース所有者パスワード付与フロー。

TokenBodyParameterContract

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

名前 説明
name

string

body パラメーター名。

value

string

body パラメーター値。