Udostępnij za pośrednictwem

AuthorizationServerContract interface

  • Odwołanie
Pakiet:
@azure/arm-apimanagement

Ustawienia zewnętrznego serwera autoryzacji OAuth.

Rozszerzenie
ProxyResource

Właściwości

authorizationEndpoint

Punkt końcowy autoryzacji OAuth. Zobacz: .
authorizationMethods

Czasowniki HTTP obsługiwane przez punkt końcowy autoryzacji. Funkcja GET musi być zawsze obecna. Post jest opcjonalny.
bearerTokenSendingMethods

Określa mechanizm, za pomocą którego token dostępu jest przekazywany do interfejsu API.
clientAuthenticationMethod

Metoda uwierzytelniania obsługiwana przez punkt końcowy tokenu tego serwera autoryzacji. Możliwe wartości to Podstawowa i/lub Treść. Po określeniu treści poświadczenia klienta i inne parametry są przekazywane w treści żądania w formacie application/x-www-form-urlencoded.
clientId

Identyfikator klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji.
clientRegistrationEndpoint

Opcjonalne odwołanie do strony, na której jest wykonywana rejestracja klienta lub aplikacji dla tego serwera autoryzacji. Zawiera bezwzględny adres URL do przywoływanej jednostki.
clientSecret

Klucz tajny klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji. Ta właściwość nie zostanie wypełniona operacjami "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.
defaultScope

Zakres tokenu dostępu, który będzie domyślnie żądany. Można zastąpić na poziomie interfejsu API. Należy podać w postaci ciągu zawierającego wartości rozdzielane spacjami.
description

Opis serwera autoryzacji. Może zawierać tagi formatowania HTML.
displayName

Przyjazna dla użytkownika nazwa serwera autoryzacji.
grantTypes

Formularz udzielenia autoryzacji, którego klient używa do żądania tokenu dostępu.
resourceOwnerPassword

Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślne hasło właściciela zasobu.
resourceOwnerUsername

Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślna nazwa użytkownika właściciela zasobu.
supportState

Jeśli wartość true, serwer autoryzacji będzie zawierać parametr stanu z żądania autoryzacji do odpowiedzi. Klient może użyć parametru stanu w celu podniesienia zabezpieczeń protokołu.
tokenBodyParameters

Dodatkowe parametry wymagane przez punkt końcowy tokenu tego serwera autoryzacji reprezentowane jako tablica obiektów JSON z właściwościami nazwy i ciągu wartości, tj. {"name" : "name value", "value": "a value"}.
tokenEndpoint

Punkt końcowy tokenu OAuth. Zawiera bezwzględny identyfikator URI do przywoływanej jednostki.
useInApiDocumentation

Jeśli to prawda, serwer autoryzacji będzie używany w dokumentacji interfejsu API w portalu dla deweloperów. Wartość false domyślnie, jeśli nie podano żadnej wartości.
useInTestConsole

Jeśli ma wartość true, serwer autoryzacji może być używany w konsoli testowej portalu deweloperów. Wartość true domyślnie, jeśli nie podano żadnej wartości.

Właściwości dziedziczone

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
name

Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

authorizationEndpoint

Punkt końcowy autoryzacji OAuth. Zobacz: .

authorizationEndpoint?: string

Wartość właściwości

string

authorizationMethods

Czasowniki HTTP obsługiwane przez punkt końcowy autoryzacji. Funkcja GET musi być zawsze obecna. Post jest opcjonalny.

authorizationMethods?: AuthorizationMethod[]

Wartość właściwości

AuthorizationMethod[]

bearerTokenSendingMethods

Określa mechanizm, za pomocą którego token dostępu jest przekazywany do interfejsu API.

bearerTokenSendingMethods?: string[]

Wartość właściwości

string[]

clientAuthenticationMethod

Metoda uwierzytelniania obsługiwana przez punkt końcowy tokenu tego serwera autoryzacji. Możliwe wartości to Podstawowa i/lub Treść. Po określeniu treści poświadczenia klienta i inne parametry są przekazywane w treści żądania w formacie application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Wartość właściwości

string[]

clientId

Identyfikator klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji.

clientId?: string

Wartość właściwości

string

clientRegistrationEndpoint

Opcjonalne odwołanie do strony, na której jest wykonywana rejestracja klienta lub aplikacji dla tego serwera autoryzacji. Zawiera bezwzględny adres URL do przywoływanej jednostki.

clientRegistrationEndpoint?: string

Wartość właściwości

string

clientSecret

Klucz tajny klienta lub aplikacji zarejestrowany na tym serwerze autoryzacji. Ta właściwość nie zostanie wypełniona operacjami "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.

clientSecret?: string

Wartość właściwości

string

defaultScope

Zakres tokenu dostępu, który będzie domyślnie żądany. Można zastąpić na poziomie interfejsu API. Należy podać w postaci ciągu zawierającego wartości rozdzielane spacjami.

defaultScope?: string

Wartość właściwości

string

description

Opis serwera autoryzacji. Może zawierać tagi formatowania HTML.

description?: string

Wartość właściwości

string

displayName

Przyjazna dla użytkownika nazwa serwera autoryzacji.

displayName?: string

Wartość właściwości

string

grantTypes

Formularz udzielenia autoryzacji, którego klient używa do żądania tokenu dostępu.

grantTypes?: string[]

Wartość właściwości

string[]

resourceOwnerPassword

Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślne hasło właściciela zasobu.

resourceOwnerPassword?: string

Wartość właściwości

string

resourceOwnerUsername

Opcjonalnie można określić, gdy typ udzielenia hasła właściciela zasobu jest obsługiwany przez ten serwer autoryzacji. Domyślna nazwa użytkownika właściciela zasobu.

resourceOwnerUsername?: string

Wartość właściwości

string

supportState

Jeśli wartość true, serwer autoryzacji będzie zawierać parametr stanu z żądania autoryzacji do odpowiedzi. Klient może użyć parametru stanu w celu podniesienia zabezpieczeń protokołu.

supportState?: boolean

Wartość właściwości

boolean

tokenBodyParameters

Dodatkowe parametry wymagane przez punkt końcowy tokenu tego serwera autoryzacji reprezentowane jako tablica obiektów JSON z właściwościami nazwy i ciągu wartości, tj. {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Wartość właściwości

TokenBodyParameterContract[]

tokenEndpoint

Punkt końcowy tokenu OAuth. Zawiera bezwzględny identyfikator URI do przywoływanej jednostki.

tokenEndpoint?: string

Wartość właściwości

string

useInApiDocumentation

Jeśli to prawda, serwer autoryzacji będzie używany w dokumentacji interfejsu API w portalu dla deweloperów. Wartość false domyślnie, jeśli nie podano żadnej wartości.

useInApiDocumentation?: boolean

Wartość właściwości

boolean

useInTestConsole

Jeśli ma wartość true, serwer autoryzacji może być używany w konsoli testowej portalu deweloperów. Wartość true domyślnie, jeśli nie podano żadnej wartości.

useInTestConsole?: boolean

Wartość właściwości

boolean

Szczegóły właściwości dziedziczonej

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

id?: string

Wartość właściwości

string

Dziedziczone zProxyResource.id

name

Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

name?: string

Wartość właściwości

string

Dziedziczone zProxyResource.name

type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type?: string

Wartość właściwości

string

Dziedziczone zproxyResource.type