Sdílet prostřednictvím

AuthorizationServerContract interface

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

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

Extends
ProxyResource

Vlastnosti

authorizationEndpoint

Koncový bod autorizace OAuth. Viz třída http://tools.ietf.org/html/rfc6749#section-3.2.
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.
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 odkazované entity.
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.
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.
displayName

Popisný název autorizačního serveru.
grantTypes

Forma udělení autorizace, kterou klient použije k vyžádání přístupového tokenu.
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.
useInApiDocumentation

Pokud je hodnota true, 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 false.
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

id

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{resourceType}/{název_prostředku} POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
type

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

Podrobnosti vlastnosti

authorizationEndpoint

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

authorizationEndpoint?: string

Hodnota vlastnosti

string

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

AuthorizationMethod[]

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

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 odkazované entity.

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

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

displayName

Popisný název autorizačního serveru.

displayName?: string

Hodnota vlastnosti

string

grantTypes

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

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

TokenBodyParameterContract[]

tokenEndpoint

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

tokenEndpoint?: string

Hodnota vlastnosti

string

useInApiDocumentation

Pokud je hodnota true, 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 false.

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í

id

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{resourceType}/{název_prostředku} POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

id?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.id

name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

name?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.name

type

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

type?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.type