Dela via


Authorization Server - Create Or Update

Skapar en ny auktoriseringsserver eller uppdaterar en befintlig auktoriseringsserver.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2022-08-01

URI-parametrar

Name I Obligatorisk Typ Description
authsid
path True

string

Identifierare för auktoriseringsservern.

Reguljärt uttrycksmönster: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på API Management-tjänsten.

Reguljärt uttrycksmönster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet.

Begärandetext

Name Obligatorisk Typ Description
properties.authorizationEndpoint True

string

OAuth-auktoriseringsslutpunkt. Se http://tools.ietf.org/html/rfc6749#section-3.2.

properties.clientId True

string

Klient- eller app-ID som registrerats med den här auktoriseringsservern.

properties.clientRegistrationEndpoint True

string

Valfri referens till en sida där klient- eller appregistrering för den här auktoriseringsservern utförs. Innehåller absolut URL till entitet som refereras till.

properties.displayName True

string

Användarvänligt auktoriseringsservernamn.

properties.grantTypes True

GrantType[]

Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken.

properties.authorizationMethods

AuthorizationMethod[]

HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid finnas. POST är valfritt.

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

Anger vilken mekanism som åtkomsttoken skickas till API:et.

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded.

properties.clientSecret

string

Klient- eller apphemlighet registrerad på den här auktoriseringsservern. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.

properties.defaultScope

string

Åtkomsttokensomfång som ska begäras som standard. Kan åsidosättas på API-nivå. Ska anges i form av en sträng som innehåller blankstegsavgränsade värden.

properties.description

string

Beskrivning av auktoriseringsservern. Kan innehålla HTML-formateringstaggar.

properties.resourceOwnerPassword

string

Du kan också ange när resursägarens lösenords beviljandetyp stöds av den här auktoriseringsservern. Standardlösenord för resursägare.

properties.resourceOwnerUsername

string

Du kan också ange när resursägarens lösenords beviljandetyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare.

properties.supportState

boolean

Om det är sant innehåller auktoriseringsservern tillståndsparametern från auktoriseringsbegäran till svaret. Klienten kan använda tillståndsparametern för att öka protokollsäkerheten.

properties.tokenBodyParameters

TokenBodyParameterContract[]

Ytterligare parametrar som krävs av tokenslutpunkten för den här auktoriseringsservern som representeras som en matris med JSON-objekt med egenskaper för namn- och värdesträng, dvs. {"name" : "name value", "value": "a value"}.

properties.tokenEndpoint

string

OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras.

properties.useInApiDocumentation

boolean

Om det är sant används auktoriseringsservern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges.

properties.useInTestConsole

boolean

Om det är sant kan auktoriseringsservern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges.

Svar

Name Typ Description
200 OK

AuthorizationServerContract

Auktoriseringsservern är redan registrerad.

Sidhuvuden

ETag: string

201 Created

AuthorizationServerContract

Auktoriseringsservern har registrerats.

Sidhuvuden

ETag: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementCreateAuthorizationServer

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2022-08-01

{
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "clientSecret": "2",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Exempelsvar

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Definitioner

Name Description
AuthorizationMethod

HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid finnas. POST är valfritt.

AuthorizationServerContract

Inställningar för extern OAuth-auktoriseringsserver.

BearerTokenSendingMethod

Anger vilken mekanism som åtkomsttoken skickas till API:et.

ClientAuthenticationMethod

Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded.

ErrorFieldContract

Fel Fältkontrakt.

ErrorResponse

Felsvar.

GrantType

Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken.

TokenBodyParameterContract

OAuth hämtar brödtextparametern för tokenbegäran (www-url-form-encoded).

AuthorizationMethod

HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid finnas. POST är valfritt.

Name Typ Description
DELETE

string

GET

string

HEAD

string

OPTIONS

string

PATCH

string

POST

string

PUT

string

TRACE

string

AuthorizationServerContract

Inställningar för extern OAuth-auktoriseringsserver.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.authorizationEndpoint

string

OAuth-auktoriseringsslutpunkt. Se http://tools.ietf.org/html/rfc6749#section-3.2.

properties.authorizationMethods

AuthorizationMethod[]

HTTP-verb som stöds av auktoriseringsslutpunkten. GET måste alltid finnas. POST är valfritt.

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

Anger vilken mekanism som åtkomsttoken skickas till API:et.

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded.

properties.clientId

string

Klient- eller app-ID som registrerats med den här auktoriseringsservern.

properties.clientRegistrationEndpoint

string

Valfri referens till en sida där klient- eller appregistrering för den här auktoriseringsservern utförs. Innehåller absolut URL till entitet som refereras till.

properties.clientSecret

string

Klient- eller apphemlighet registrerad på den här auktoriseringsservern. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.

properties.defaultScope

string

Åtkomsttokensomfång som ska begäras som standard. Kan åsidosättas på API-nivå. Ska anges i form av en sträng som innehåller blankstegsavgränsade värden.

properties.description

string

Beskrivning av auktoriseringsservern. Kan innehålla HTML-formateringstaggar.

properties.displayName

string

Användarvänligt auktoriseringsservernamn.

properties.grantTypes

GrantType[]

Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken.

properties.resourceOwnerPassword

string

Du kan också ange när resursägarens lösenords beviljandetyp stöds av den här auktoriseringsservern. Standardlösenord för resursägare.

properties.resourceOwnerUsername

string

Du kan också ange när resursägarens lösenords beviljandetyp stöds av den här auktoriseringsservern. Standardanvändaranvändarnamn för resursägare.

properties.supportState

boolean

Om det är sant innehåller auktoriseringsservern tillståndsparametern från auktoriseringsbegäran till svaret. Klienten kan använda tillståndsparametern för att öka protokollsäkerheten.

properties.tokenBodyParameters

TokenBodyParameterContract[]

Ytterligare parametrar som krävs av tokenslutpunkten för den här auktoriseringsservern som representeras som en matris med JSON-objekt med egenskaper för namn- och värdesträng, dvs. {"name" : "name value", "value": "a value"}.

properties.tokenEndpoint

string

OAuth-tokenslutpunkt. Innehåller absolut URI till entitet som refereras.

properties.useInApiDocumentation

boolean

Om det är sant används auktoriseringsservern i API-dokumentationen i utvecklarportalen. Falskt som standard om inget värde anges.

properties.useInTestConsole

boolean

Om det är sant kan auktoriseringsservern användas i testkonsolen för utvecklarportalen. Sant som standard om inget värde anges.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

Anger vilken mekanism som åtkomsttoken skickas till API:et.

Name Typ Description
authorizationHeader

string

query

string

ClientAuthenticationMethod

Autentiseringsmetod som stöds av tokenslutpunkten för den här auktoriseringsservern. Möjliga värden är Grundläggande och/eller Brödtext. När brödtext anges skickas klientautentiseringsuppgifter och andra parametrar i begärandetexten i formatet application/x-www-form-urlencoded.

Name Typ Description
Basic

string

Grundläggande klientautentiseringsmetod.

Body

string

Body based Authentication-metod.

ErrorFieldContract

Fel Fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.

message

string

Mänsklig läsbar representation av fel på egenskapsnivå.

target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.

error.message

string

Mänsklig läsbar representation av felet.

GrantType

Form av ett auktoriseringsbidrag som klienten använder för att begära åtkomsttoken.

Name Typ Description
authorizationCode

string

Auktoriseringskod Bevilja flöde enligt beskrivningen https://tools.ietf.org/html/rfc6749#section-4.1.

clientCredentials

string

Bevilja flöde för klientautentiseringsuppgifter enligt beskrivningen https://tools.ietf.org/html/rfc6749#section-4.4.

implicit

string

Implicit kod bevilja flöde enligt beskrivningen https://tools.ietf.org/html/rfc6749#section-4.2.

resourceOwnerPassword

string

Resursägarens lösenordsbidragsflöde enligt beskrivningen https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

OAuth hämtar brödtextparametern för tokenbegäran (www-url-form-encoded).

Name Typ Description
name

string

brödtextparameternamn.

value

string

brödtextparametervärde.