AuthorizationServerContractBaseProperties interface
外部 OAuth 承認サーバーの設定の更新コントラクト。
プロパティ
authorization |
承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。 |
bearer |
アクセス トークンを API に渡すメカニズムを指定します。 |
client |
この承認サーバーのトークン エンドポイントによってサポートされる認証の方法。 使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターは、要求本文内で application/x-www-form-urlencoded 形式で渡されます。 |
default |
既定で要求されるアクセス トークン スコープ。 API レベルでオーバーライドできます。 スペース区切り値を含む文字列の形式で提供される必要があります。 |
description | 承認サーバーの説明。 HTML 書式設定タグを含めることができます。 |
resource |
リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。 既定のリソース所有者のパスワードです。 |
resource |
リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。 既定のリソース所有者のユーザー名。 |
support |
true の場合、承認サーバーには、承認要求から応答への状態パラメーターが含まれます。 クライアントは状態パラメーターを使用して、プロトコルのセキュリティを高めることができます。 |
token |
名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークン エンドポイントに必要な追加のパラメーター 。つまり、{"name" : "name value", "value": "a value"}。 |
token |
OAuth トークン エンドポイント。 参照するエンティティの絶対 URI が含まれます。 |
プロパティの詳細
authorizationMethods
承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
authorizationMethods?: AuthorizationMethod[]
プロパティ値
bearerTokenSendingMethods
アクセス トークンを API に渡すメカニズムを指定します。
bearerTokenSendingMethods?: string[]
プロパティ値
string[]
clientAuthenticationMethod
この承認サーバーのトークン エンドポイントによってサポートされる認証の方法。 使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターは、要求本文内で application/x-www-form-urlencoded 形式で渡されます。
clientAuthenticationMethod?: string[]
プロパティ値
string[]
defaultScope
既定で要求されるアクセス トークン スコープ。 API レベルでオーバーライドできます。 スペース区切り値を含む文字列の形式で提供される必要があります。
defaultScope?: string
プロパティ値
string
description
承認サーバーの説明。 HTML 書式設定タグを含めることができます。
description?: string
プロパティ値
string
resourceOwnerPassword
リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。 既定のリソース所有者のパスワードです。
resourceOwnerPassword?: string
プロパティ値
string
resourceOwnerUsername
リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。 既定のリソース所有者のユーザー名。
resourceOwnerUsername?: string
プロパティ値
string
supportState
true の場合、承認サーバーには、承認要求から応答への状態パラメーターが含まれます。 クライアントは状態パラメーターを使用して、プロトコルのセキュリティを高めることができます。
supportState?: boolean
プロパティ値
boolean
tokenBodyParameters
名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークン エンドポイントに必要な追加のパラメーター 。つまり、{"name" : "name value", "value": "a value"}。
tokenBodyParameters?: TokenBodyParameterContract[]
プロパティ値
tokenEndpoint
OAuth トークン エンドポイント。 参照するエンティティの絶対 URI が含まれます。
tokenEndpoint?: string
プロパティ値
string