YetkilendirmeEklentisi

API anahtarlarını veya OAuth2'i kullanarak kimlik doğrulaması ve yetkilendirme benzetimi sağlar.

Eklenti örneği tanımı

{
  "name": "AuthPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "auth"
}

Yapılandırma örneği: API anahtarı

{
  "auth": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/authplugin.schema.json",
    "type": "apiKey",
    "apiKey": {
      "parameters": [
        {
          "in": "header",
          "name": "x-api-key"
        },
        {
          "in": "query",
          "name": "code"
        }
      ],
      "allowedKeys": [
        "1234"
      ]
    }
  }
}

Yapılandırma örneği: OAuth2

{
  "auth": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/authplugin.schema.json",
    "type": "oauth2",
    "oauth2": {
      "metadataUrl": "https://login.microsoftonline.com/organizations/v2.0/.well-known/openid-configuration",
      "allowedApplications": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedAudiences": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedPrincipals": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedTenants":[
        "00000000-0000-0000-0000-000000000000"
      ],
      "issuer": "https://login.microsoftonline.com/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0/v2.0",
      "scopes": [
        "Posts.Read"
      ],
      "validateLifetime": true,
      "validateSigningKey": true
    }
  }
}

Yapılandırma özellikleri

Özellik	Açıklama	Gerekli
type	Geliştirme Proxy'sinin kullanması gereken kimlik doğrulaması ve yetkilendirme türü. İzin verilen değerler: apiKey, oauth2	Evet
apiKey	API anahtarı kimlik doğrulaması ve yetkilendirme yapılandırması.	Evet, ne zaman typeapiKey
oauth2	OAuth2 kimlik doğrulaması ve yetkilendirme yapılandırması.	Evet, ne zaman typeoauth2

API anahtarı yapılandırma özellikleri

Özellik	Açıklama	Gerekli
allowedKeys	İzin verilen API anahtarlarının listesi.	Evet
parameters	API anahtarını içeren parametrelerin listesi.	Evet

Parametre yapılandırma özellikleri

Özellik	Açıklama	Gerekli
in	Burada parametresinin bulunması beklenir. İzin verilen değerler: header, query, cookie	Evet
name	Parametrenin adı.	Evet

OAuth2 yapılandırma özellikleri

Özellik	Açıklama	Gerekli
metadataUrl	OpenID Connect meta veri belgesinin URL'si.	Evet
allowedApplications	İzin verilen uygulama kimliklerinin listesi. Belirtecin verildiği uygulamayı (appid veya azp talebi) doğrulamamak için boş bırakın.	Hayır
allowedAudiences	İzin verilen hedef kitlelerin listesi. Belirtecin verildiği hedef kitleyi (aud talep) doğrulamamak için boş bırakın.	Hayır
allowedPrincipals	İzin verilen sorumluların listesi. Belirtecin verildiği sorumluyu (oid talep) doğrulamamak için boş bırakın.	Hayır
allowedTenants	İzin verilen kiracıların listesi. Belirtecin verildiği kiracıyı (tid talep) doğrulamamak için boş bırakın.	Hayır
issuer	İzin verilen belirteç veren. Belirteç vereni doğrulamamak için boş bırakın.	Hayır
roles	İzin verilen rollerin listesi. Belirteç üzerindeki rolleri (roles talebi) doğrulamamak için boş bırakın.	Hayır
scopes	İzin verilen kapsamların listesi. Belirteçte kapsamları (scp talep) doğrulamamak için boş bırakın.	Hayır
validateLifetime	false Belirteç ömrünü doğrulamayı devre dışı bırakmak için olarak ayarlayın. Varsayılan true.	Hayır
validateSigningKey	false Belirteç imzasını doğrulamayı devre dışı bırakmak için olarak ayarlayın. Temerrüt true	Hayır

Komut satırı seçenekleri

Hiçbiri