Dela via

AuthorizationServerUpdateContractProperties interface

  • Referens
Paket:
@azure/arm-apimanagement

Kontrakt för uppdateringsinställningar för extern OAuth-auktoriseringsserver.

Extends
AuthorizationServerContractBaseProperties

Egenskaper

authorizationEndpoint

OAuth-auktoriseringsslutpunkt. Se http://tools.ietf.org/html/rfc6749#section-3.2.
clientId

Klient- eller app-ID som registrerats med den här auktoriseringsservern.
clientRegistrationEndpoint

Valfri referens till en sida där klient- eller appregistrering för den här auktoriseringsservern utförs. Innehåller absolut URL till entitet som refereras till.
clientSecret

Klient- eller apphemlighet registrerad på den här auktoriseringsservern. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
displayName

Användarvänligt auktoriseringsservernamn.
grantTypes

Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken.
useInApiDocumentation

Om det är sant används auktoriseringsservern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges.
useInTestConsole

Om det är sant kan auktoriseringsservern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges.

Ärvda egenskaper

authorizationMethods

HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid finnas. POST är valfritt.
bearerTokenSendingMethods

Anger vilken mekanism som åtkomsttoken skickas till API:et.
clientAuthenticationMethod

Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded.
defaultScope

Åtkomsttokensomfång som ska begäras som standard. Kan åsidosättas på API-nivå. Ska anges i form av en sträng som innehåller blankstegsavgränsade värden.
description

Beskrivning av auktoriseringsservern. Kan innehålla HTML-formateringstaggar.
resourceOwnerPassword

Du kan också ange när resursägarens lösenords beviljandetyp stöds av den här auktoriseringsservern. Standardlösenord för resursägare.
resourceOwnerUsername

Du kan också ange när resursägarens lösenords beviljandetyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare.
supportState

Om det är sant innehåller auktoriseringsservern tillståndsparametern från auktoriseringsbegäran till svaret. Klienten kan använda tillståndsparametern för att öka protokollsäkerheten.
tokenBodyParameters

Ytterligare parametrar som krävs av tokenslutpunkten för den här auktoriseringsservern som representeras som en matris med JSON-objekt med egenskaper för namn- och värdesträng, dvs. {"name" : "name value", "value": "a value"}.
tokenEndpoint

OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras.

Egenskapsinformation

authorizationEndpoint

OAuth-auktoriseringsslutpunkt. Se http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Egenskapsvärde

string

clientId

Klient- eller app-ID som registrerats med den här auktoriseringsservern.

clientId?: string

Egenskapsvärde

string

clientRegistrationEndpoint

Valfri referens till en sida där klient- eller appregistrering för den här auktoriseringsservern utförs. Innehåller absolut URL till entitet som refereras till.

clientRegistrationEndpoint?: string

Egenskapsvärde

string

clientSecret

Klient- eller apphemlighet registrerad på den här auktoriseringsservern. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.

clientSecret?: string

Egenskapsvärde

string

displayName

Användarvänligt auktoriseringsservernamn.

displayName?: string

Egenskapsvärde

string

grantTypes

Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken.

grantTypes?: string[]

Egenskapsvärde

string[]

useInApiDocumentation

Om det är sant används auktoriseringsservern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges.

useInApiDocumentation?: boolean

Egenskapsvärde

boolean

useInTestConsole

Om det är sant kan auktoriseringsservern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges.

useInTestConsole?: boolean

Egenskapsvärde

boolean

Information om ärvda egenskaper

authorizationMethods

HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid finnas. POST är valfritt.

authorizationMethods?: AuthorizationMethod[]

Egenskapsvärde

AuthorizationMethod[]

Ärvd frånAuthorizationServerContractBaseProperties.authorizationMethods

bearerTokenSendingMethods

Anger vilken mekanism som åtkomsttoken skickas till API:et.

bearerTokenSendingMethods?: string[]

Egenskapsvärde

string[]

Ärvd frånAuthorizationServerContractBaseProperties.bearerTokenSendingMethods

clientAuthenticationMethod

Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Egenskapsvärde

string[]

Ärvd frånAuthorizationServerContractBaseProperties.clientAuthenticationMethod

defaultScope

Åtkomsttokensomfång som ska begäras som standard. Kan åsidosättas på API-nivå. Ska anges i form av en sträng som innehåller blankstegsavgränsade värden.

defaultScope?: string

Egenskapsvärde

string

Ärvd frånAuthorizationServerContractBaseProperties.defaultScope

description

Beskrivning av auktoriseringsservern. Kan innehålla HTML-formateringstaggar.

description?: string

Egenskapsvärde

string

Ärvd frånAuthorizationServerContractBaseProperties.description

resourceOwnerPassword

Du kan också ange när resursägarens lösenords beviljandetyp stöds av den här auktoriseringsservern. Standardlösenord för resursägare.

resourceOwnerPassword?: string

Egenskapsvärde

string

Ärvd frånAuthorizationServerContractBaseProperties.resourceOwnerPassword

resourceOwnerUsername

Du kan också ange när resursägarens lösenords beviljandetyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare.

resourceOwnerUsername?: string

Egenskapsvärde

string

Ärvd frånAuthorizationServerContractBaseProperties.resourceOwnerUsername

supportState

Om det är sant innehåller auktoriseringsservern tillståndsparametern från auktoriseringsbegäran till svaret. Klienten kan använda tillståndsparametern för att öka protokollsäkerheten.

supportState?: boolean

Egenskapsvärde

boolean

Ärvd frånAuthorizationServerContractBaseProperties.supportState

tokenBodyParameters

Ytterligare parametrar som krävs av tokenslutpunkten för den här auktoriseringsservern som representeras som en matris med JSON-objekt med egenskaper för namn- och värdesträng, dvs. {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Egenskapsvärde

TokenBodyParameterContract[]

Ärvd frånAuthorizationServerContractBaseProperties.tokenBodyParameters

tokenEndpoint

OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras.

tokenEndpoint?: string

Egenskapsvärde

string

Ärvd frånAuthorizationServerContractBaseProperties.tokenEndpoint