AuthorizationServerContract interface

Csomag:

@azure/arm-apimanagement

Külső OAuth engedélyezési kiszolgáló beállításai.

Extends

ProxyResource

Tulajdonságok

authorizationEndpoint	OAuth engedélyezési végpont. Lásd: http://tools.ietf.org/html/rfc6749#section-3.2.
authorizationMethods	Az engedélyezési végpont által támogatott HTTP-parancsok. A GET-nek mindig jelen kell lennie. A POST nem kötelező.
bearerTokenSendingMethods	Meghatározza azt a mechanizmust, amellyel a hozzáférési jogkivonatot a rendszer átadja az API-nak.
clientAuthenticationMethod	Az engedélyezési kiszolgáló jogkivonatvégpontja által támogatott hitelesítési módszer. A lehetséges értékek alapszintűek és/vagy törzsek. A törzs megadásakor az ügyfél hitelesítő adatai és egyéb paraméterei az alkalmazás/x-www-form-urlencoded formátumban a kérelem törzsén belül lesznek átadva.
clientId	Az engedélyezési kiszolgálón regisztrált ügyfél- vagy alkalmazásazonosító.
clientRegistrationEndpoint	Nem kötelező hivatkozás arra a lapra, amelyen az engedélyezési kiszolgáló ügyfél- vagy alkalmazásregisztrációja történik. A hivatkozott entitás abszolút URL-címét tartalmazza.
clientSecret	Ezzel az engedélyezési kiszolgálóval regisztrált ügyfél- vagy alkalmazáskulcs. Ez a tulajdonság nem lesz kitöltve a GET műveletekben! Az érték lekéréséhez használja a "/listSecrets" POST kérést.
defaultScope	Alapértelmezés szerint kérendő hozzáférési jogkivonat-hatókör. Az API szintjén felül lehet bírálni. Szóközzel tagolt értékeket tartalmazó sztring formájában kell megadni.
description	Az engedélyezési kiszolgáló leírása. HTML-formázási címkéket tartalmazhat.
displayName	Felhasználóbarát engedélyezési kiszolgáló neve.
grantTypes	Engedélyezési engedély formája, amelyet az ügyfél a hozzáférési jogkivonat lekérésére használ.
resourceOwnerPassword	Opcionálisan megadható, ha az erőforrás-tulajdonosi jelszó megadásának típusát ez az engedélyezési kiszolgáló támogatja. Alapértelmezett erőforrás-tulajdonosi jelszó.
resourceOwnerUsername	Opcionálisan megadható, ha az erőforrás-tulajdonosi jelszó megadásának típusát ez az engedélyezési kiszolgáló támogatja. Alapértelmezett erőforrás-tulajdonosi felhasználónév.
supportState	Ha igaz, az engedélyezési kiszolgáló az engedélyezési kérelemtől a válaszig tartalmazni fogja az állapotparamétert. Az ügyfél az állapotparamétert használhatja a protokollbiztonság növeléséhez.
tokenBodyParameters	Az engedélyezési kiszolgáló jogkivonatvégpontja által megkövetelt további paraméterek név- és értéksztring-tulajdonságokkal rendelkező JSON-objektumok tömbjeként jelenik meg, például {"name" : "name value", "value": "a value"}.
tokenEndpoint	OAuth-jogkivonat végpontja. Abszolút URI-t tartalmaz a hivatkozott entitáshoz.
useInApiDocumentation	Ha igaz, az engedélyezési kiszolgálót a fejlesztői portál API-dokumentációjában fogja használni. Alapértelmezés szerint hamis, ha nincs megadva érték.
useInTestConsole	Ha igaz, az engedélyezési kiszolgáló használható a fejlesztői portál tesztkonzolján. Alapértelmezés szerint igaz, ha nincs megadva érték.

Örökölt tulajdonságok

id	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.
name	Az erőforrás neve MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.
type	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

Tulajdonság adatai

authorizationEndpoint

OAuth engedélyezési végpont. Lásd: http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Tulajdonság értéke

string

authorizationMethods

Az engedélyezési végpont által támogatott HTTP-parancsok. A GET-nek mindig jelen kell lennie. A POST nem kötelező.

authorizationMethods?: AuthorizationMethod[]

Tulajdonság értéke

AuthorizationMethod[]

bearerTokenSendingMethods

Meghatározza azt a mechanizmust, amellyel a hozzáférési jogkivonatot a rendszer átadja az API-nak.

bearerTokenSendingMethods?: string[]

Tulajdonság értéke

string[]

clientAuthenticationMethod

Az engedélyezési kiszolgáló jogkivonatvégpontja által támogatott hitelesítési módszer. A lehetséges értékek alapszintűek és/vagy törzsek. A törzs megadásakor az ügyfél hitelesítő adatai és egyéb paraméterei az alkalmazás/x-www-form-urlencoded formátumban a kérelem törzsén belül lesznek átadva.

clientAuthenticationMethod?: string[]

Tulajdonság értéke

string[]

clientId

Az engedélyezési kiszolgálón regisztrált ügyfél- vagy alkalmazásazonosító.

clientId?: string

Tulajdonság értéke

string

clientRegistrationEndpoint

Nem kötelező hivatkozás arra a lapra, amelyen az engedélyezési kiszolgáló ügyfél- vagy alkalmazásregisztrációja történik. A hivatkozott entitás abszolút URL-címét tartalmazza.

clientRegistrationEndpoint?: string

Tulajdonság értéke

string

clientSecret

Ezzel az engedélyezési kiszolgálóval regisztrált ügyfél- vagy alkalmazáskulcs. Ez a tulajdonság nem lesz kitöltve a GET műveletekben! Az érték lekéréséhez használja a "/listSecrets" POST kérést.

clientSecret?: string

Tulajdonság értéke

string

defaultScope

Alapértelmezés szerint kérendő hozzáférési jogkivonat-hatókör. Az API szintjén felül lehet bírálni. Szóközzel tagolt értékeket tartalmazó sztring formájában kell megadni.

defaultScope?: string

Tulajdonság értéke

string

description

Az engedélyezési kiszolgáló leírása. HTML-formázási címkéket tartalmazhat.

description?: string

Tulajdonság értéke

string

displayName

Felhasználóbarát engedélyezési kiszolgáló neve.

displayName?: string

Tulajdonság értéke

string

grantTypes

Engedélyezési engedély formája, amelyet az ügyfél a hozzáférési jogkivonat lekérésére használ.

grantTypes?: string[]

Tulajdonság értéke

string[]

resourceOwnerPassword

Opcionálisan megadható, ha az erőforrás-tulajdonosi jelszó megadásának típusát ez az engedélyezési kiszolgáló támogatja. Alapértelmezett erőforrás-tulajdonosi jelszó.

resourceOwnerPassword?: string

Tulajdonság értéke

string

resourceOwnerUsername

Opcionálisan megadható, ha az erőforrás-tulajdonosi jelszó megadásának típusát ez az engedélyezési kiszolgáló támogatja. Alapértelmezett erőforrás-tulajdonosi felhasználónév.

resourceOwnerUsername?: string

Tulajdonság értéke

string

supportState

Ha igaz, az engedélyezési kiszolgáló az engedélyezési kérelemtől a válaszig tartalmazni fogja az állapotparamétert. Az ügyfél az állapotparamétert használhatja a protokollbiztonság növeléséhez.

supportState?: boolean

Tulajdonság értéke

boolean

tokenBodyParameters

Az engedélyezési kiszolgáló jogkivonatvégpontja által megkövetelt további paraméterek név- és értéksztring-tulajdonságokkal rendelkező JSON-objektumok tömbjeként jelenik meg, például {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Tulajdonság értéke

TokenBodyParameterContract[]

tokenEndpoint

OAuth-jogkivonat végpontja. Abszolút URI-t tartalmaz a hivatkozott entitáshoz.

tokenEndpoint?: string

Tulajdonság értéke

string

useInApiDocumentation

Ha igaz, az engedélyezési kiszolgálót a fejlesztői portál API-dokumentációjában fogja használni. Alapértelmezés szerint hamis, ha nincs megadva érték.

useInApiDocumentation?: boolean

Tulajdonság értéke

boolean

useInTestConsole

Ha igaz, az engedélyezési kiszolgáló használható a fejlesztői portál tesztkonzolján. Alapértelmezés szerint igaz, ha nincs megadva érték.

useInTestConsole?: boolean

Tulajdonság értéke

boolean

Örökölt tulajdonság részletei

id

Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

id?: string

Tulajdonság értéke

string

örököltProxyResource.id

name

Az erőforrás neve MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

name?: string

Tulajdonság értéke

string

örököltProxyResource.name

type

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

type?: string

Tulajdonság értéke

string

örököltProxyResource.type