Authorization Server - Create Or Update
Yeni yetkilendirme sunucusu oluşturur veya mevcut yetkilendirme sunucusunu güncelleştirir.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
authsid
|
path | True |
string |
Yetkilendirme sunucusunun tanımlayıcısı. Regex pattern: |
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Regex pattern: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
If-Match |
string |
Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
properties.authorizationEndpoint | True |
string |
OAuth yetkilendirme uç noktası. Bkz. http://tools.ietf.org/html/rfc6749#section-3.2. |
properties.clientId | True |
string |
Bu yetkilendirme sunucusuna kayıtlı istemci veya uygulama kimliği. |
properties.clientRegistrationEndpoint | True |
string |
Bu yetkilendirme sunucusu için istemci veya uygulama kaydının gerçekleştirildiği sayfaya isteğe bağlı başvuru. Başvurulmakta olan varlığın mutlak URL'sini içerir. |
properties.displayName | True |
string |
Kullanıcı dostu yetkilendirme sunucusu adı. |
properties.grantTypes | True |
İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme izni biçimi. |
|
properties.authorizationMethods |
Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır. |
||
properties.bearerTokenSendingMethods |
Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir. |
||
properties.clientAuthenticationMethod |
Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde, istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde uygulama/x-www-form-urlencoded biçiminde geçirilir. |
||
properties.clientSecret |
string |
Bu yetkilendirme sunucusuna kaydedilen istemci veya uygulama gizli dizisi. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. |
|
properties.defaultScope |
string |
Varsayılan olarak istenecek erişim belirteci kapsamı. API düzeyinde geçersiz kılınabilir. Boşlukla ayrılmış değerler içeren bir dize biçiminde sağlanmalıdır. |
|
properties.description |
string |
Yetkilendirme sunucusunun açıklaması. HTML biçimlendirme etiketleri içerebilir. |
|
properties.resourceOwnerPassword |
string |
Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi parolası. |
|
properties.resourceOwnerUsername |
string |
Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi kullanıcı adı. |
|
properties.supportState |
boolean |
Doğruysa, yetkilendirme sunucusu yetkilendirme isteğinden yanıtına durum parametresini ekler. İstemci, protokol güvenliğini artırmak için durum parametresini kullanabilir. |
|
properties.tokenBodyParameters |
Bu yetkilendirme sunucusunun belirteç uç noktası için gereken ek parametreler, ad ve değer dizesi özelliklerine sahip bir JSON nesneleri dizisi olarak temsil edilir; örneğin{"name" : "name value", "value": "a value"}. |
||
properties.tokenEndpoint |
string |
OAuth belirteci uç noktası. Başvurulmakta olan varlığa mutlak URI içerir. |
|
properties.useInApiDocumentation |
boolean |
Doğruysa, yetkilendirme sunucusu geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. |
|
properties.useInTestConsole |
boolean |
Doğruysa, yetkilendirme sunucusu geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True değeri verilir. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Yetkilendirme sunucusu zaten kayıtlı. Headers ETag: string |
|
201 Created |
Yetkilendirme sunucusu başarıyla kaydedildi. Headers ETag: string |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
ApiManagementCreateAuthorizationServer
Sample Request
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"
}
}
Sample Response
{
"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"
}
}
Tanımlar
Name | Description |
---|---|
Authorization |
Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır. |
Authorization |
Dış OAuth yetkilendirme sunucusu ayarları. |
Bearer |
Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir. |
Client |
Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde, istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde uygulama/x-www-form-urlencoded biçiminde geçirilir. |
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Grant |
İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme izni biçimi. |
Token |
OAuth belirteç isteği gövde parametresini (www-url-form-kodlanmış) alır. |
AuthorizationMethod
Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır.
Name | Tür | Description |
---|---|---|
DELETE |
string |
|
GET |
string |
|
HEAD |
string |
|
OPTIONS |
string |
|
PATCH |
string |
|
POST |
string |
|
PUT |
string |
|
TRACE |
string |
AuthorizationServerContract
Dış OAuth yetkilendirme sunucusu ayarları.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Kaynağın adı |
properties.authorizationEndpoint |
string |
OAuth yetkilendirme uç noktası. Bkz. http://tools.ietf.org/html/rfc6749#section-3.2. |
properties.authorizationMethods |
Yetkilendirme uç noktası tarafından desteklenen HTTP fiilleri. GET her zaman mevcut olmalıdır. POST isteğe bağlıdır. |
|
properties.bearerTokenSendingMethods |
Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir. |
|
properties.clientAuthenticationMethod |
Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde, istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde uygulama/x-www-form-urlencoded biçiminde geçirilir. |
|
properties.clientId |
string |
Bu yetkilendirme sunucusuna kayıtlı istemci veya uygulama kimliği. |
properties.clientRegistrationEndpoint |
string |
Bu yetkilendirme sunucusu için istemci veya uygulama kaydının gerçekleştirildiği sayfaya isteğe bağlı başvuru. Başvurulmakta olan varlığın mutlak URL'sini içerir. |
properties.clientSecret |
string |
Bu yetkilendirme sunucusuna kaydedilen istemci veya uygulama gizli dizisi. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. |
properties.defaultScope |
string |
Varsayılan olarak istenecek erişim belirteci kapsamı. API düzeyinde geçersiz kılınabilir. Boşlukla ayrılmış değerler içeren bir dize biçiminde sağlanmalıdır. |
properties.description |
string |
Yetkilendirme sunucusunun açıklaması. HTML biçimlendirme etiketleri içerebilir. |
properties.displayName |
string |
Kullanıcı dostu yetkilendirme sunucusu adı. |
properties.grantTypes |
İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme izni biçimi. |
|
properties.resourceOwnerPassword |
string |
Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi parolası. |
properties.resourceOwnerUsername |
string |
Kaynak sahibi parola verme türü bu yetkilendirme sunucusu tarafından desteklendiğinde isteğe bağlı olarak belirtilebilir. Varsayılan kaynak sahibi kullanıcı adı. |
properties.supportState |
boolean |
Doğruysa, yetkilendirme sunucusu yetkilendirme isteğinden yanıtına durum parametresini ekler. İstemci, protokol güvenliğini artırmak için durum parametresini kullanabilir. |
properties.tokenBodyParameters |
Bu yetkilendirme sunucusunun belirteç uç noktası için gereken ek parametreler, ad ve değer dizesi özelliklerine sahip bir JSON nesneleri dizisi olarak temsil edilir; örneğin{"name" : "name value", "value": "a value"}. |
|
properties.tokenEndpoint |
string |
OAuth belirteci uç noktası. Başvurulmakta olan varlığa mutlak URI içerir. |
properties.useInApiDocumentation |
boolean |
Doğruysa, yetkilendirme sunucusu geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. |
properties.useInTestConsole |
boolean |
Doğruysa, yetkilendirme sunucusu geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True değeri verilir. |
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
BearerTokenSendingMethod
Erişim belirtecinin API'ye geçirildiği mekanizmayı belirtir.
Name | Tür | Description |
---|---|---|
authorizationHeader |
string |
|
query |
string |
ClientAuthenticationMethod
Bu yetkilendirme sunucusunun belirteç uç noktası tarafından desteklenen kimlik doğrulama yöntemi. Olası değerler Temel ve/veya Gövde'dir. Gövde belirtildiğinde, istemci kimlik bilgileri ve diğer parametreler istek gövdesi içinde uygulama/x-www-form-urlencoded biçiminde geçirilir.
Name | Tür | Description |
---|---|---|
Basic |
string |
Temel İstemci Kimlik Doğrulama yöntemi. |
Body |
string |
Gövde tabanlı Kimlik Doğrulama yöntemi. |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilir gösterimi. |
GrantType
İstemcinin erişim belirtecini istemek için kullandığı yetkilendirme izni biçimi.
Name | Tür | Description |
---|---|---|
authorizationCode |
string |
Açıklandığı https://tools.ietf.org/html/rfc6749#section-4.1gibi Yetkilendirme Kodu Verme akışı. |
clientCredentials |
string |
açıklandığı gibi https://tools.ietf.org/html/rfc6749#section-4.4İstemci Kimlik Bilgileri Verme akışı. |
implicit |
string |
Açıklandığı https://tools.ietf.org/html/rfc6749#section-4.2gibi örtük Kod Verme akışı. |
resourceOwnerPassword |
string |
Kaynak Sahibi Parola Verme akışı açıklandığı https://tools.ietf.org/html/rfc6749#section-4.3gibi. |
TokenBodyParameterContract
OAuth belirteç isteği gövde parametresini (www-url-form-kodlanmış) alır.
Name | Tür | Description |
---|---|---|
name |
string |
gövde parametresi adı. |
value |
string |
gövde parametresi değeri. |