AuthorizationServerContractBaseProperties interface

Pakket:

@azure/arm-apimanagement

Contract voor update-instellingen voor externe OAuth-autorisatieserver.

Eigenschappen

authorizationMethods	HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel.
bearerTokenSendingMethods	Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API.
clientAuthenticationMethod	Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded.
defaultScope	Toegangstokenbereik dat standaard wordt aangevraagd. Kan worden overschreven op API-niveau. Moet worden opgegeven in de vorm van een tekenreeks die door spaties gescheiden waarden bevat.
description	Beschrijving van de autorisatieserver. Kan HTML-opmaaktags bevatten.
resourceOwnerPassword	Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardwachtwoord voor resource-eigenaar.
resourceOwnerUsername	Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Gebruikersnaam van standaardresource-eigenaar.
supportState	Indien waar, bevat de autorisatieserver de statusparameter van de autorisatieaanvraag tot het antwoord. Client kan de statusparameter gebruiken om protocolbeveiliging te verhogen.
tokenBodyParameters	Aanvullende parameters die zijn vereist voor het tokeneindpunt van deze autorisatieserver die worden weergegeven als een matrix van JSON-objecten met de eigenschappen van de naam- en waardetekenreeks, bijvoorbeeld {"name" : "name value", "value": "a value"}.
tokenEndpoint	OAuth-tokeneindpunt. Bevat de absolute URI naar de entiteit waarnaar wordt verwezen.

Eigenschapdetails

authorizationMethods

HTTP-woorden die worden ondersteund door het autorisatie-eindpunt. GET moet altijd aanwezig zijn. POST is optioneel.

authorizationMethods?: AuthorizationMethod[]

Waarde van eigenschap

AuthorizationMethod[]

bearerTokenSendingMethods

Hiermee geeft u het mechanisme op waarmee het toegangstoken wordt doorgegeven aan de API.

bearerTokenSendingMethods?: string[]

Waarde van eigenschap

string[]

clientAuthenticationMethod

Verificatiemethode die wordt ondersteund door het tokeneindpunt van deze autorisatieserver. Mogelijke waarden zijn Basic en/of Hoofdtekst. Wanneer hoofdtekst is opgegeven, worden clientreferenties en andere parameters doorgegeven in de aanvraagbody in de indeling application/x-www-form-urlencoded.

clientAuthenticationMethod?: string[]

Waarde van eigenschap

string[]

defaultScope

Toegangstokenbereik dat standaard wordt aangevraagd. Kan worden overschreven op API-niveau. Moet worden opgegeven in de vorm van een tekenreeks die door spaties gescheiden waarden bevat.

defaultScope?: string

Waarde van eigenschap

string

description

Beschrijving van de autorisatieserver. Kan HTML-opmaaktags bevatten.

description?: string

Waarde van eigenschap

string

resourceOwnerPassword

Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Standaardwachtwoord voor resource-eigenaar.

resourceOwnerPassword?: string

Waarde van eigenschap

string

resourceOwnerUsername

Kan eventueel worden opgegeven wanneer het type wachtwoordtoestemming van de resource-eigenaar wordt ondersteund door deze autorisatieserver. Gebruikersnaam van standaardresource-eigenaar.

resourceOwnerUsername?: string

Waarde van eigenschap

string

supportState

Indien waar, bevat de autorisatieserver de statusparameter van de autorisatieaanvraag tot het antwoord. Client kan de statusparameter gebruiken om protocolbeveiliging te verhogen.

supportState?: boolean

Waarde van eigenschap

boolean

tokenBodyParameters

Aanvullende parameters die zijn vereist voor het tokeneindpunt van deze autorisatieserver die worden weergegeven als een matrix van JSON-objecten met de eigenschappen van de naam- en waardetekenreeks, bijvoorbeeld {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Waarde van eigenschap

TokenBodyParameterContract[]

tokenEndpoint

OAuth-tokeneindpunt. Bevat de absolute URI naar de entiteit waarnaar wordt verwezen.

tokenEndpoint?: string

Waarde van eigenschap

string