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