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 http://tools.ietf.org/html/rfc6749#section-3.2.
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.
clientId

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

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

Tajný kód 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é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.
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.
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.
useInApiDocumentation

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

Pokud je pravda, může být autorizační server použit v testovací konzole portálu pro vývojáře. Hodnota True ve výchozím nastavení platí, pokud není zadaná žádná hodnota.

Zděděné vlastnosti

id

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
type

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

Podrobnosti vlastnosti

authorizationEndpoint

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

authorizationEndpoint?: string

Hodnota vlastnosti

string

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

AuthorizationMethod[]

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

clientId

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

clientId?: string

Hodnota vlastnosti

string

clientRegistrationEndpoint

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

clientRegistrationEndpoint?: string

Hodnota vlastnosti

string

clientSecret

Tajný kód 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é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

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

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

TokenBodyParameterContract[]

tokenEndpoint

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

tokenEndpoint?: 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. False ve výchozím nastavení, pokud není zadaná žádná hodnota.

useInApiDocumentation?: boolean

Hodnota vlastnosti

boolean

useInTestConsole

Pokud je pravda, může být autorizační server použit v testovací konzole portálu pro vývojáře. Hodnota True ve výchozím nastavení platí, pokud není zadaná žádná hodnota.

useInTestConsole?: boolean

Hodnota vlastnosti

boolean

Podrobnosti zděděných vlastností

id

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

id?: string

Hodnota vlastnosti

string

zděděno zeProxyResource.id

name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

name?: string

Hodnota vlastnosti

string

zděděno zeProxyResource.name

type

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

type?: string

Hodnota vlastnosti

string

zděděno zeProxyResource.type