AuthorizationServerUpdateContract interface

Pakket:

@azure/arm-apimanagement

Instellingen voor externe OAuth-autorisatieserver.

Uitbreiding

ProxyResource

Eigenschappen

authorizationEndpoint	OAuth-autorisatie-eindpunt. Zie http://tools.ietf.org/html/rfc6749#section-3.2.
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.
clientId	Client- of app-id geregistreerd bij deze autorisatieserver.
clientRegistrationEndpoint	Optionele verwijzing naar een pagina waar client- of app-registratie voor deze autorisatieserver wordt uitgevoerd. Bevat de absolute URL naar de entiteit waarnaar wordt verwezen.
clientSecret	Client- of app-geheim dat is geregistreerd bij deze autorisatieserver. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.
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.
displayName	Gebruiksvriendelijke autorisatieservernaam.
grantTypes	Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen.
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.
useInApiDocumentation	Indien waar, wordt de autorisatieserver gebruikt in de API-documentatie in de ontwikkelaarsportal. Standaard onwaar als er geen waarde is opgegeven.
useInTestConsole	Indien waar, kan de autorisatieserver worden gebruikt in de testconsole van de ontwikkelaarsportal. True standaard als er geen waarde wordt opgegeven.

Overgenomen eigenschappen

id	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
name	De naam van de resourceNOTITIE: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
type	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts': deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Eigenschapdetails

authorizationEndpoint

OAuth-autorisatie-eindpunt. Zie http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Waarde van eigenschap

string

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

clientId

Client- of app-id geregistreerd bij deze autorisatieserver.

clientId?: string

Waarde van eigenschap

string

clientRegistrationEndpoint

Optionele verwijzing naar een pagina waar client- of app-registratie voor deze autorisatieserver wordt uitgevoerd. Bevat de absolute URL naar de entiteit waarnaar wordt verwezen.

clientRegistrationEndpoint?: string

Waarde van eigenschap

string

clientSecret

Client- of app-geheim dat is geregistreerd bij deze autorisatieserver. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.

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

displayName

Gebruiksvriendelijke autorisatieservernaam.

displayName?: string

Waarde van eigenschap

string

grantTypes

Vorm van een autorisatietoekenning, die de client gebruikt om het toegangstoken aan te vragen.

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

useInApiDocumentation

Indien waar, wordt de autorisatieserver gebruikt in de API-documentatie in de ontwikkelaarsportal. Standaard onwaar als er geen waarde is opgegeven.

useInApiDocumentation?: boolean

Waarde van eigenschap

boolean

useInTestConsole

Indien waar, kan de autorisatieserver worden gebruikt in de testconsole van de ontwikkelaarsportal. True standaard als er geen waarde wordt opgegeven.

useInTestConsole?: boolean

Waarde van eigenschap

boolean

Details van overgenomen eigenschap

id

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

id?: string

Waarde van eigenschap

string

overgenomen vanProxyResource.id

name

De naam van de resourceNOTITIE: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

name?: string

Waarde van eigenschap

string

overgenomen vanProxyResource.name

type

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts': deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

type?: string

Waarde van eigenschap

string

overgenomen vanProxyResource.type