AuthorizationServerUpdateContractProperties interface

Pakiet:

@azure/arm-apimanagement

Kontrakt ustawień aktualizacji ustawień zewnętrznego serwera autoryzacji OAuth.

Rozszerzenie

AuthorizationServerContractBaseProperties

Właściwości

authorizationEndpoint	Punkt końcowy autoryzacji OAuth. Zobacz: .
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ść.
displayName	Przyjazna dla użytkownika nazwa serwera autoryzacji.
grantTypes	Formularz udzielenia autoryzacji, którego klient używa do żądania tokenu dostępu.
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

authorizationMethods	Czasowniki HTTP obsługiwane przez punkt końcowy autoryzacji. Polecenie GET musi być zawsze obecne. 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.
defaultScope	Zakres tokenu dostępu, który będzie domyślnie żądany. Można je przesłonić na poziomie interfejsu API. Powinien być podany w postaci ciągu zawierającego wartości rozdzielane spacjami.
description	Opis serwera autoryzacji. Może zawierać tagi formatowania HTML.
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 ciągu nazwy i wartości, tj. {"name" : "name value", "value": "a value"}.
tokenEndpoint	Punkt końcowy tokenu OAuth. Zawiera bezwzględny identyfikator URI do przywoływanej jednostki.

Szczegóły właściwości

authorizationEndpoint

Punkt końcowy autoryzacji OAuth. Zobacz: .

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

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

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

authorizationMethods

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

authorizationMethods?: AuthorizationMethod[]

Wartość właściwości

AuthorizationMethod[]

Dziedziczone zauthorizationServerContractBaseProperties.authorizationMethods

bearerTokenSendingMethods

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

bearerTokenSendingMethods?: string[]

Wartość właściwości

string[]

Dziedziczone zauthorizationServerContractBaseProperties.bearerTokenSendingMethods

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

Dziedziczone zauthorizationServerContractBaseProperties.clientAuthenticationMethod

defaultScope

Zakres tokenu dostępu, który będzie domyślnie żądany. Można je przesłonić na poziomie interfejsu API. Powinien być podany w postaci ciągu zawierającego wartości rozdzielane spacjami.

defaultScope?: string

Wartość właściwości

string

Dziedziczone zauthorizationServerContractBaseProperties.defaultScope

description

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

description?: string

Wartość właściwości

string

Dziedziczone zauthorizationServerContractBaseProperties.description

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

Dziedziczone zauthorizationServerContractBaseProperties.resourceOwnerPassword

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

Dziedziczone zauthorizationServerContractBaseProperties.resourceOwnerUsername

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

Dziedziczone zauthorizationServerContractBaseProperties.supportState

tokenBodyParameters

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

tokenBodyParameters?: TokenBodyParameterContract[]

Wartość właściwości

TokenBodyParameterContract[]

Dziedziczone zauthorizationServerContractBaseProperties.tokenBodyParameters

tokenEndpoint

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

tokenEndpoint?: string

Wartość właściwości

string

Dziedziczone zauthorizationServerContractBaseProperties.tokenEndpoint