AuthorizationServerContractBaseProperties interface
Kontrakt ustawień aktualizacji ustawień zewnętrznego serwera autoryzacji OAuth.
Właściwości
authorization |
Czasowniki HTTP obsługiwane przez punkt końcowy autoryzacji. Funkcja GET musi być zawsze obecna. Post jest opcjonalny. |
bearer |
Określa mechanizm, za pomocą którego token dostępu jest przekazywany do interfejsu API. |
client |
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. |
default |
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. |
resource |
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. |
resource |
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. |
support |
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. |
token |
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"}. |
token |
Punkt końcowy tokenu OAuth. Zawiera bezwzględny identyfikator URI do przywoływanej jednostki. |
Szczegóły właściwości
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
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[]
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
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
tokenEndpoint
Punkt końcowy tokenu OAuth. Zawiera bezwzględny identyfikator URI do przywoływanej jednostki.
tokenEndpoint?: string
Wartość właściwości
string