OAuth 2.0 ile REST API'lerine erişimi yetkilendirme

Azure DevOps Services

Erişim için web uygulaması kullanıcı REST API kimlik doğrulaması yapın, böylece uygulamanız kullanıcı adı ve parola istemeye devam etmez. Azure DevOps Services bir kullanıcı için uygulama yetkilendirmek ve bir erişim belirteci oluşturmak için OAuth 2.0 protokolünü kullanır. Rest API'lerini uygulamanıza çağırarak bu belirteci kullanın.

Bu kullanıcı Azure DevOps Services API'lerini çağırarak kullanıcının erişim belirteci kullanın. Erişim belirteçleri sona erer, bu nedenle süresi dolduğunda erişim belirteci yenileyin.

Genel akışA bir C# örneği için bkz. vsts-auth-samples.

Uygulama kaydetme

Uygulama https://app.vsaex.visualstudio.com/app/register kaydetmeye gidin.

Uygulamanıza gereken kapsamları seçin ve ardından, uygulamanıza yetki verdiğinizde aynı kapsamları kullanın. Önizleme API'lerini kullanarak uygulama kaydettiyebilirsiniz, çünkü artık kullanılan kapsamlar kullanım dışıdır.

Kullanıcı Azure DevOps Services onay sayfasını kullanıcınıza sunarsa, şirket adınız, uygulama adınız ve açıklamalarınızı kullanır. Ayrıca, şirket web sitenizin, uygulama web sitenizin URL'lerini ve hizmet koşulları ile gizlilik bildirimini kullanır.

Bu Azure DevOps Services bir kullanıcının yetkilendirmesini sorduğunda ve kullanıcı bunu onaylarsa, kullanıcının tarayıcısı yetkilendirme koduyla yetkilendirme geri çağırma URL'nize yeniden yönlendirildi. Geri çağırma URL'si, kodu uygulamaya geri aktaran güvenli bir bağlantı (https) olmalıdır. Uygulamanıza kaydedilen URL ile tam olarak eşleşmesi gerekir. Görüntülenmezse, kullanıcıdan uygulamanıza yetkilendirme izni verilmesini isteyen bir sayfa yerine 400 hata sayfası görüntülenir.

Uygulama ayarları sayfası, uygulama kaydınızı tamamlar.

Yetkilendirme URL'sini arayın ve bir kullanıcının uygulamanıza kuruluşuna erişmesi için yetkilendirmesini istediğiniz uygulama kimliği ve yetkili kapsamları girin. Erişim belirteci URL'sini çağırarak bir erişim belirteci almak Azure DevOps Services REST API.

Kaydolan her uygulamanın ayarları profilinizden https://app.vssps.visualstudio.com/profile/view edinebilirsiniz.

Uygulamanıza yetki verme

Kullanıcınız henüz uygulamanıza kuruluşuna erişmek için yetkilendirilmediyse yetkilendirme URL'sini arayın.

https://app.vssps.visualstudio.com/oauth2/authorize
        ?client_id={app ID}
        &response_type={Assertion}
        &state={state}
        &scope={scope}
        &redirect_uri={callback URL}

Azure DevOps Services kullanıcıdan uygulamanıza yetki vermelerini isterse. Kimlik doğrulamasını halleder ve ardından kullanıcı yetkilendirmeyi onaylıyorsa sizi bir yetkilendirme koduyla geri arar.

Sitenize, kullanıcı yetkilendirme uç noktasına bir bağlantı veya Azure DevOps Services ekleyin:

https://app.vssps.visualstudio.com/oauth2/authorize
        ?client_id=88e2dd5f-4e34-45c6-a75d-524eb2a0399e
        &response_type=Assertion
        &state=User1
        &scope=vso.work%20vso.code_write
        &redirect_uri=https://fabrikam.azurewebsites.net/myapp/oauth-callback

Azure DevOps Services kullanıcıdan uygulamanıza yetki vermelerini isterse.

Kullanıcının kabul etmiş olduğu varsay Azure DevOps Services, kullanıcının tarayıcısını kısa süreli yetkilendirme kodu ve yetkilendirme URL'sinde sağlanan durum değeri de dahil olmak üzere geri çağırma URL'nize yeniden yönlendirer:

https://fabrikam.azurewebsites.net/myapp/oauth-callback
        ?code={authorization code}
        &state=User1

Kullanıcı için erişim ve yenileme belirteci alın

Şimdi yetkilendirme kodunu kullanarak kullanıcıya bir erişim belirteci (ve yenileme belirteci) talep edersiniz. Hizmetinizin hizmetten hizmete HTTP isteği Azure DevOps Services.

URL - uygulamayı yetkilendirme

POST https://app.vssps.visualstudio.com/oauth2/token

HTTP isteği üst bilgileri - uygulamayı yetkilendirme

Content-Type: application/x-www-form-urlencoded
Content-Length: 1322

HTTP istek gövdesi - uygulamayı yetkilendirme

client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&client_assertion={0}&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&assertion={1}&redirect_uri={2}

Önceki örnek istek gövdesinin yer tutucu değerlerini değiştirin:

• {0}: Uygulama kaydediken alınan URL kodlanmış istemci gizli adı
• {1}: Sorgu parametresi aracılığıyla geri arama URL'nize sağlanan URL code ile kodlanmış "kod"
• {2}: uygulamaya kayıtlı geri çağırma URL'si

İstek gövdeyi oluşturmak için C# örneği - uygulamayı yetkilendirme

public string GenerateRequestPostData(string appSecret, string authCode, string callbackUrl)
{
   return String.Format("client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&client_assertion={0}&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&assertion={1}&redirect_uri={2}",
               HttpUtility.UrlEncode(appSecret),
               HttpUtility.UrlEncode(authCode),
               callbackUrl
        );
}

Yanıt - uygulamayı yetkilendirme

{
    "access_token": { access token for the user },
    "token_type": { type of token },
    "expires_in": { time in seconds that the token remains valid },
    "refresh_token": { refresh token to use to acquire a new access token }
}

Erişim belirteci kullanma

Erişim belirteci kullanmak için, HTTP isteğinizin Yetkilendirme üst bilgisinde bunu taşıyıcı belirteç olarak dahil edin:

Authorization: Bearer {access_token}

Örneğin, bir projenin son derlemelerini almak için HTTP isteği:

GET https://dev.azure.com/myaccount/myproject/_apis/build-release/builds?api-version=3.0
Authorization: Bearer {access_token}

Süresi dolan erişim belirteci yenileme

Bir kullanıcının erişim belirtecin süresi dolsa, yeni bir erişim belirteci almak için yetkilendirme akışında edinmiş olduğu yenileme belirteci kullanabilirsiniz. Erişim ve yenileme belirteci için yetkilendirme kodunu değiştirme işleminin ilk işlemidir.

URL - belirteci yenileme

POST https://app.vssps.visualstudio.com/oauth2/token

HTTP isteği üst bilgileri - yenileme belirteci

Content-Type: application/x-www-form-urlencoded
Content-Length: 1654

HTTP istek gövdesi - yenileme belirteci

client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&client_assertion={0}&grant_type=refresh_token&assertion={1}&redirect_uri={2}

Önceki örnek istek gövdesinin yer tutucu değerlerini değiştirin:

• {0}: Uygulama kaydediken alınan URL kodlanmış istemci gizli adı
• {1}: Kullanıcı için URL ile kodlanmış yenileme belirteci
• {2}: uygulamaya kayıtlı geri çağırma URL'si

Yanıt - belirteci yenileme

{
    "access_token": { access token for this user },
    "token_type": { type of token },
    "expires_in": { time in seconds that the token remains valid },
    "refresh_token": { new refresh token to use when the token has timed out }
}

Kapsamlar

Uygulamanıza hangi izinlerin gerekli olduğunu belirtmek için Azure DevOps Services ve kapsamları kullanın. Kullanıcılarınız, uygulamanıza kuruluşlarına erişim yetkisi verdiğinizde, bu kapsamlar için uygulamayı yetkilendirler. Yetkilendirme isteği, kayıtlı kapsamların aynısını geçer.

Daha fazla bilgi için bkz. İş öğesi izleme/ekler oluşturma.

Örnekler

C# OAuth api'leri örneğimizde OAuth'Azure DevOps Services REST API'lerini çağıran bir C# GitHub bulabilirsiniz.

Sık sorulan sorular (SSS)

S: OAuth'ı cep telefonu uygulamam ile kullanabilir miyim?

C: Hayır. Azure DevOps Services web sunucusu akışını desteklediği için uygulama gizli sini güvenli bir şekilde depolayamayasınız, bu nedenle OAuth uygulamanın hiçbir yolu yoktur.

S: Kodumda hangi hataları veya özel koşulları işlemem gerekiyor?

A: Aşağıdaki koşulları işleyeli olduğundan emin olun:

• Kullanıcınız uygulama erişiminizi geri alıyorsa hiçbir yetkilendirme kodu döndürülz. Yetkilendirme kodunu, reddetme denetimi olmadan kullanmayın.
• Kullanıcı uygulamanızın yetkilendirmesini iptal eder, erişim belirteci artık geçerli değildir. Uygulamanız veriye erişmek için belirteci kullandığında bir 401 hatası döndürür. Yetkilendirmeyi yeniden isteyin.

S: Web uygulamamda yerel olarak hata ayıklamak istiyorum. Uygulamamı kaydettiğimde geri çağırma URL 'SI için localhost kullanabilir miyim?

C: Evet. Azure DevOps Services artık geri arama URL 'niz için localhost 'a izin veriyor. https://localhostUygulamanızı kaydettiğinizde geri arama URL 'nizin başlangıcı olarak kullandığınızdan emin olun.

S: bir erişim belirteci almaya çalıştığımda bir HTTP 400 hatası alıyorum. Ne yanlış olabilir?

Y: istek üst bilgisinde içerik türünü application/x-www-form-urlencoded olarak ayarlayıp ayarlayamamasını kontrol edin.

S: OAuth ile SOAP uç noktaları ve REST API 'Leri kullanabilir miyim?

C: Hayır. OAuth yalnızca bu noktada REST API 'Lerinde desteklenir.

s: iş öğelerimin Azure DevOps REST apı 'lerini kullanarak nasıl ek ayrıntısı alabilirim?

A: Ilk olarak iş öğeleri ile iş öğesi ayrıntılarını alın -iş öğesi al REST API:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}

Eklerin ayrıntılarını almak için şu parametreyi URL 'ye eklemeniz gerekir:

$expand=all

Sonuçlarla ilişkiler özelliğini elde edersiniz. Ekler URL 'sini bulabilir ve URL içinde KIMLIĞI bulabilirsiniz. Örnek:

$url = https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/434?$expand=all&api-version=5.0

$workItem = Invoke-RestMethod -Uri $url -Method Get -ContentType application/json

$split = ($workitem.relations.url).Split('/')

$attachmentId = $split[$split.count - 1]

# Result: 1244nhsfs-ff3f-25gg-j64t-fahs23vfs

İlgili makaleler:

• Doğru kimlik doğrulama yöntemini seçme
• Azure DevOps için varsayılan izinler ve erişim