Sdílet prostřednictvím

AuthorizationServerContractProperties interface

  • Reference
Balíček:
@azure/arm-apimanagement

Nastavení externího autorizačního serveru OAuth – vlastnosti

Extends
AuthorizationServerContractBaseProperties

Vlastnosti

authorizationEndpoint

Koncový bod autorizace OAuth. Viz třída http://tools.ietf.org/html/rfc6749#section-3.2.
clientId

ID klienta nebo aplikace zaregistrované na tomto autorizačním serveru.
clientRegistrationEndpoint

Volitelný odkaz na stránku, kde se provádí registrace klienta nebo aplikace pro tento autorizační server. Obsahuje absolutní adresu URL na entitu, na které se odkazuje.
clientSecret

Tajný klíč klienta nebo aplikace zaregistrovaný na tomto autorizačním serveru. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets.
displayName

Uživatelsky přívětivý název autorizačního serveru.
grantTypes

Forma udělení autorizace, kterou klient používá k vyžádání přístupového tokenu.
useInApiDocumentation

Pokud ano, autorizační server se použije v dokumentaci k rozhraní API na portálu pro vývojáře. Pokud není zadaná žádná hodnota, ve výchozím nastavení je nepravda.
useInTestConsole

Pokud ano, autorizační server se může použít v testovací konzole portálu pro vývojáře. Ve výchozím nastavení je true, pokud není zadaná žádná hodnota.

Zděděné vlastnosti

authorizationMethods

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

Určuje mechanismus předávání přístupového tokenu do 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. Když 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ý bude ve výchozím nastavení požadován. Lze přepsat na úrovni rozhraní API. Měl by být k dispozici 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 autorizační server podporuje typ udělení hesla vlastníka prostředku, můžete volitelně zadat. Výchozí heslo vlastníka prostředku
resourceOwnerUsername

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

Pokud ano, autorizační server zahrne do odpovědi parametr state z žádosti o autorizaci. 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 jsou reprezentované jako pole objektů JSON s vlastnostmi řetězce názvů a hodnot, tj. {"name" : "name value", "value": "a value"}.
tokenEndpoint

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

Podrobnosti vlastnosti

authorizationEndpoint

Koncový bod autorizace OAuth. Viz třída http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint: string

Hodnota vlastnosti

string

clientId

ID klienta nebo aplikace zaregistrované na tomto autorizačním serveru.

clientId: string

Hodnota vlastnosti

string

clientRegistrationEndpoint

Volitelný odkaz na stránku, kde se provádí registrace klienta nebo aplikace pro tento autorizační server. Obsahuje absolutní adresu URL na entitu, na které se odkazuje.

clientRegistrationEndpoint: string

Hodnota vlastnosti

string

clientSecret

Tajný klíč klienta nebo aplikace zaregistrovaný na tomto autorizačním serveru. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets.

clientSecret?: string

Hodnota vlastnosti

string

displayName

Uživatelsky přívětivý název autorizačního serveru.

displayName: string

Hodnota vlastnosti

string

grantTypes

Forma udělení autorizace, kterou klient používá k vyžádání přístupového tokenu.

grantTypes: string[]

Hodnota vlastnosti

string[]

useInApiDocumentation

Pokud ano, autorizační server se použije v dokumentaci k rozhraní API na portálu pro vývojáře. Pokud není zadaná žádná hodnota, ve výchozím nastavení je nepravda.

useInApiDocumentation?: boolean

Hodnota vlastnosti

boolean

useInTestConsole

Pokud ano, autorizační server se může použít v testovací konzole portálu pro vývojáře. Ve výchozím nastavení je true, pokud není zadaná žádná hodnota.

useInTestConsole?: boolean

Hodnota vlastnosti

boolean

Podrobnosti zděděných vlastností

authorizationMethods

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

authorizationMethods?: AuthorizationMethod[]

Hodnota vlastnosti

AuthorizationMethod[]

Zděděno zAuthorizationServerContractBaseProperties.authorizationMethods

bearerTokenSendingMethods

Určuje mechanismus předávání přístupového tokenu do rozhraní API.

bearerTokenSendingMethods?: string[]

Hodnota vlastnosti

string[]

Zděděno zAuthorizationServerContractBaseProperties.bearerTokenSendingMethods

clientAuthenticationMethod

Metoda ověřování podporovaná koncovým bodem tokenu tohoto autorizačního serveru. Možné hodnoty jsou Basic a/nebo Body. Když 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[]

Zděděno zAuthorizationServerContractBaseProperties.clientAuthenticationMethod

defaultScope

Obor přístupových tokenů, který bude ve výchozím nastavení požadován. Lze přepsat na úrovni rozhraní API. Měl by být k dispozici ve formě řetězce obsahujícího hodnoty oddělené mezerami.

defaultScope?: string

Hodnota vlastnosti

string

Zděděno zAuthorizationServerContractBaseProperties.defaultScope

description

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

description?: string

Hodnota vlastnosti

string

Zděděno zAuthorizationServerContractBaseProperties.description

resourceOwnerPassword

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

resourceOwnerPassword?: string

Hodnota vlastnosti

string

Zděděno zAuthorizationServerContractBaseProperties.resourceOwnerPassword

resourceOwnerUsername

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

resourceOwnerUsername?: string

Hodnota vlastnosti

string

Zděděno zAuthorizationServerContractBaseProperties.resourceOwnerUsername

supportState

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

supportState?: boolean

Hodnota vlastnosti

boolean

Zděděno zAuthorizationServerContractBaseProperties.supportState

tokenBodyParameters

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

tokenBodyParameters?: TokenBodyParameterContract[]

Hodnota vlastnosti

TokenBodyParameterContract[]

Zděděno zAuthorizationServerContractBaseProperties.tokenBodyParameters

tokenEndpoint

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

tokenEndpoint?: string

Hodnota vlastnosti

string

Zděděno zAuthorizationServerContractBaseProperties.tokenEndpoint