Sdílet prostřednictvím


AuthorizationServerContractBaseProperties interface

Kontrakt nastavení aktualizace externího autorizačního serveru OAuth

Vlastnosti

authorizationMethods

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

bearerTokenSendingMethods

Určuje mechanismus, pomocí kterého 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 a/nebo Body. Při zadání textu se přihlašovací údaje klienta a další parametry předávají v textu požadavku ve formátu application/x-www-form-urlencoded.

defaultScope

Obor přístupového tokenu, který se bude ve výchozím nastavení požadovat. Lze přepsat na úrovni rozhraní API. Měla by být poskytována 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

Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí heslo vlastníka prostředku

resourceOwnerUsername

Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí uživatelské jméno vlastníka prostředku

supportState

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

tokenBodyParameters

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

tokenEndpoint

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

Podrobnosti vlastnosti

authorizationMethods

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

authorizationMethods?: AuthorizationMethod[]

Hodnota vlastnosti

bearerTokenSendingMethods

Určuje mechanismus, pomocí kterého 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 a/nebo Body. Při zadání textu se přihlašovací údaje klienta a další parametry předávají v textu požadavku ve formátu application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Hodnota vlastnosti

string[]

defaultScope

Obor přístupového tokenu, který se bude ve výchozím nastavení požadovat. Lze přepsat na úrovni rozhraní API. Měla by být poskytována 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

Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí heslo vlastníka prostředku

resourceOwnerPassword?: string

Hodnota vlastnosti

string

resourceOwnerUsername

Volitelně je možné zadat, pokud tento autorizační server podporuje typ udělení hesla vlastníka prostředku. Výchozí uživatelské jméno vlastníka prostředku

resourceOwnerUsername?: string

Hodnota vlastnosti

string

supportState

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

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 názvu a hodnoty, tj. {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Hodnota vlastnosti

tokenEndpoint

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

tokenEndpoint?: string

Hodnota vlastnosti

string