AuthorizationServerUpdateContractProperties interface

OAuth 承認エンドポイント。 「http://tools.ietf.org/html/rfc6749#section-3.2」を参照してください。

authorizationEndpoint?: string

プロパティ値

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

clientId?: string

プロパティ値

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

clientRegistrationEndpoint?: string

プロパティ値

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

clientSecret?: string

プロパティ値

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

displayName?: string

プロパティ値

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

grantTypes?: string[]

プロパティ値

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

useInApiDocumentation?: boolean

プロパティ値

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

useInTestConsole?: boolean

プロパティ値

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

authorizationMethods?: AuthorizationMethod[]

プロパティ値

AuthorizationServerContractBaseProperties.authorizationMethodsから継承

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

bearerTokenSendingMethods?: string[]

プロパティ値

AuthorizationServerContractBaseProperties.bearerTokenSendingMethodsから継承されます

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

clientAuthenticationMethod?: string[]

プロパティ値

AuthorizationServerContractBaseProperties.clientAuthenticationMethodから継承されます

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

defaultScope?: string

プロパティ値

AuthorizationServerContractBaseProperties.defaultScopeから継承されます

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

description?: string

プロパティ値

AuthorizationServerContractBaseProperties.descriptionから継承

リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。 既定のリソース所有者のパスワードです。

resourceOwnerPassword?: string

プロパティ値

AuthorizationServerContractBaseProperties.resourceOwnerPasswordから継承

リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。 既定のリソース所有者のユーザー名。

resourceOwnerUsername?: string

プロパティ値

AuthorizationServerContractBaseProperties.resourceOwnerUsernameから継承されます

true の場合、承認サーバーには、承認要求から応答への状態パラメーターが含まれます。 クライアントは状態パラメーターを使用して、プロトコルのセキュリティを高めることができます。

supportState?: boolean

プロパティ値

AuthorizationServerContractBaseProperties.supportStateから継承

名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークン エンドポイントに必要な追加パラメーター (つまり、{"name" : "name value", "value": "a value"})。

tokenBodyParameters?: TokenBodyParameterContract[]

プロパティ値

AuthorizationServerContractBaseProperties.tokenBodyParametersから継承されます

OAuth トークン エンドポイント。 参照するエンティティの絶対 URI が含まれます。

tokenEndpoint?: string

プロパティ値

AuthorizationServerContractBaseProperties.tokenEndpointから継承