Sdílet prostřednictvím


AuthorizationServerContractBaseProperties interface

Externí autorizační server OAuth – Kontrakt nastavení aktualizace

Vlastnosti

authorizationMethods

Příkazy HTTP podporované koncovým bodem autorizace Get musí být vždy k dispozici. Funkce POST je volitelná.

bearerTokenSendingMethods

Určuje mechanismus, kterým se přístupový token předává rozhraní API.

clientAuthenticationMethod

Metoda ověřování podporovaná koncovým bodem tokenu tohoto autorizačního serveru. Možné hodnoty jsou Basic nebo Body. Pokud je zadán text, přihlašovací údaje klienta a další parametry jsou předány v textu požadavku ve formátu application/x-www-form-urlencoded.

defaultScope

Obor přístupových tokenů, který se bude ve výchozím nastavení vyžadovat. Je možné přepsat na úrovni rozhraní API. Měly by být poskytovány ve formě řetězce obsahujícího hodnoty oddělené mezerami.

description

Popis autorizačního serveru Může obsahovat značky formátování HTML.

resourceOwnerPassword

Pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku, můžete ho volitelně zadat. Výchozí heslo vlastníka prostředku

resourceOwnerUsername

Pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku, můžete ho volitelně zadat. Výchozí uživatelské jméno vlastníka prostředku

supportState

Pokud je hodnota true, autorizační server zahrne parametr stavu z žádosti o autorizaci do své odpovědi. Klient může použít parametr stavu ke zvýšení zabezpečení protokolu.

tokenBodyParameters

Další parametry vyžadované koncovým bodem tokenu tohoto autorizačního serveru reprezentované jako pole objektů JSON s vlastnostmi řetězce name a value, tj. {"name" : "name value", "value": "a value"}.

tokenEndpoint

Koncový bod tokenu OAuth. Obsahuje absolutní identifikátor URI odkazované entity.

Podrobnosti vlastnosti

authorizationMethods

Příkazy HTTP podporované koncovým bodem autorizace Get musí být vždy k dispozici. Funkce POST je volitelná.

authorizationMethods?: AuthorizationMethod[]

Hodnota vlastnosti

bearerTokenSendingMethods

Určuje mechanismus, kterým se přístupový token předává rozhraní API.

bearerTokenSendingMethods?: string[]

Hodnota vlastnosti

string[]

clientAuthenticationMethod

Metoda ověřování podporovaná koncovým bodem tokenu tohoto autorizačního serveru. Možné hodnoty jsou Basic nebo Body. Pokud je zadán text, přihlašovací údaje klienta a další parametry jsou předány v textu požadavku ve formátu application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Hodnota vlastnosti

string[]

defaultScope

Obor přístupových tokenů, který se bude ve výchozím nastavení vyžadovat. Je možné přepsat na úrovni rozhraní API. Měly by být poskytovány ve formě řetězce obsahujícího hodnoty oddělené mezerami.

defaultScope?: string

Hodnota vlastnosti

string

description

Popis autorizačního serveru Může obsahovat značky formátování HTML.

description?: string

Hodnota vlastnosti

string

resourceOwnerPassword

Pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku, můžete ho volitelně zadat. Výchozí heslo vlastníka prostředku

resourceOwnerPassword?: string

Hodnota vlastnosti

string

resourceOwnerUsername

Pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku, můžete ho volitelně zadat. Výchozí uživatelské jméno vlastníka prostředku

resourceOwnerUsername?: string

Hodnota vlastnosti

string

supportState

Pokud je hodnota true, autorizační server zahrne parametr stavu z žádosti o autorizaci do své odpovědi. Klient může použít parametr stavu ke zvýšení zabezpečení protokolu.

supportState?: boolean

Hodnota vlastnosti

boolean

tokenBodyParameters

Další parametry vyžadované koncovým bodem tokenu tohoto autorizačního serveru reprezentované jako pole objektů JSON s vlastnostmi řetězce name a value, tj. {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Hodnota vlastnosti

tokenEndpoint

Koncový bod tokenu OAuth. Obsahuje absolutní identifikátor URI odkazované entity.

tokenEndpoint?: string

Hodnota vlastnosti

string