Dela via

AuthorizationServerContract interface

  • Referens
Paket:
@azure/arm-apimanagement

Inställningar för extern OAuth-auktoriseringsserver.

Extends
ProxyResource

Egenskaper

authorizationEndpoint

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

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

Anger den mekanism med vilken å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.
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 vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet.
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.
displayName

Användarvänligt namn på auktoriseringsservern.
grantTypes

Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken.
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 höja 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 till.
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

id

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
name

Namnet på resursen Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
type

Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" OBS! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

Egenskapsinformation

authorizationEndpoint

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

authorizationEndpoint?: string

Egenskapsvärde

string

authorizationMethods

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

authorizationMethods?: AuthorizationMethod[]

Egenskapsvärde

AuthorizationMethod[]

bearerTokenSendingMethods

Anger den mekanism med vilken åtkomsttoken skickas till API:et.

bearerTokenSendingMethods?: string[]

Egenskapsvärde

string[]

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[]

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 vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet.

clientSecret?: string

Egenskapsvärde

string

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

description

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

description?: string

Egenskapsvärde

string

displayName

Användarvänligt namn på auktoriseringsservern.

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[]

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

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

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 höja protokollsäkerheten.

supportState?: boolean

Egenskapsvärde

boolean

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[]

tokenEndpoint

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

tokenEndpoint?: 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

id

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

id?: string

Egenskapsvärde

string

Ärvd frånProxyResource.id

name

Namnet på resursen Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

name?: string

Egenskapsvärde

string

Ärvd frånProxyResource.name

type

Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" OBS! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

type?: string

Egenskapsvärde

string

Ärvd frånProxyResource.type