O Auth Providers - Create Or Update

Hizmet:

Azure Data Manager for Agriculture

API Sürümü:

2023-11-01-preview

OauthProvider kaynağı oluşturur veya güncelleştirir.

PATCH {endpoint}/oauth/providers/{oauthProviderId}?api-version=2023-11-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string uri	Ad alanının ana bilgisayar adı, örneğin admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	oauthProvider kaynağının kimliği.
api-version	query	True	string	İstenen API sürümü

İstek Başlığı

Media Types: "application/merge-patch+json"

Name	Gerekli	Tür	Description
Authorization	True	string	Lütfen yetkili API çağrıları için geçerli bir taşıyıcı belirteci sağlayın. Kimliği doğrulanmamış çağrıları daha önce denediyseniz tarayıcı önbelleğinizi temizlemeniz gerekebileceğini unutmayın.

İstek Gövdesi

Media Types: "application/merge-patch+json"

Name	Tür	Description
apiKey	string	Verilen Sağlayıcı için OAuth API anahtarı. Not: Şu anda İklim sağlayıcısı için geçerlidir. Yanıt olarak gönderilmez.
appId	string	Verilen OAuth Sağlayıcısı için OAuth Uygulama Kimliği.
appSecret	string	Verilen Sağlayıcı için OAuth Uygulama gizli dizisi. Not: Yanıt olarak gönderilmez.
description	string	Kaynağın metinsel açıklaması.
isProductionApp	boolean	Uygulamanın sağlayıcı tarafında Üretim senaryoları için kullanılmaya hazır olup olmadığını belirlemek için isteğe bağlı bir bayrak. (Varsayılan değer: false) Not: Şu anda JohnDeere için geçerlidir.
name	string	Kaynağı tanımlamak için ad.
properties		Kaynağa ait anahtar değer çiftleri koleksiyonu. Her çiftin 50 karakterden büyük bir anahtarı olmamalıdır ve 150 karakterden büyük bir değere sahip olmamalıdır. Not: Bir kaynak için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve datetime (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.

Yanıtlar

Name	Tür	Description
200 OK	OAuthProvider	Başarılı
201 Created	OAuthProvider	Oluşturulan
Other Status Codes	ErrorResponse	Hata Üst Bilgiler x-ms-error-code: string

Güvenlik

Authorization

Lütfen yetkili API çağrıları için geçerli bir taşıyıcı belirteci sağlayın. Kimliği doğrulanmamış çağrıları daha önce denediyseniz tarayıcı önbelleğinizi temizlemeniz gerekebileceğini unutmayın.

Tür: apiKey
İçinde: header

Örnekler

OAuthProviders_CreateOrUpdate

Örnek isteği

HTTP

PATCH {endpoint}/oauth/providers/JOHNDEERE?api-version=2023-11-01-preview

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  }
}

Örnek yanıt

Durum kodu:

200

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

Durum kodu:

201

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

Tanımlar

Name	Description
Error	Azure AgPlatform hizmetinden bir hata.
ErrorResponse	Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .
InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
OAuthProvider	OAuth sağlayıcısı kaynağının şeması.

Error

Azure AgPlatform hizmetinden bir hata.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesi.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.
innererror	InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
message	string	Hatanın insan tarafından okunabilir gösterimi.
target	string	Hatanın hedefi.

ErrorResponse

Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name	Tür	Description
error	Error	Azure AgPlatform hizmetinden bir hata.
traceId	string	Benzersiz izleme kimliği.

InnerError

Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Name	Tür	Description
code	string	İçeren hata tarafından sağlanandan özel hata kodu.
innererror	InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

OAuthProvider

OAuth sağlayıcısı kaynağının şeması.

Name	Tür	Default value	Description
apiKey	string		Verilen Sağlayıcı için OAuth API anahtarı. Not: Şu anda İklim sağlayıcısı için geçerlidir. Yanıt olarak gönderilmez.
appId	string		Verilen OAuth Sağlayıcısı için OAuth Uygulama Kimliği.
appSecret	string		Verilen Sağlayıcı için OAuth Uygulama gizli dizisi. Not: Yanıt olarak gönderilmez.
createdBy	string		Kullanıcı/kiracı kimliği tarafından oluşturulur.
createdDateTime	string		Kaynağın oluşturulduğu tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
description	string		Kaynağın metinsel açıklaması.
eTag	string		İyimser eşzamanlılık uygulamak için ETag değeri.
id	string		Benzersiz OAuth sağlayıcı kimliği.
isProductionApp	boolean	False	Uygulamanın sağlayıcı tarafında Üretim senaryoları için kullanılmaya hazır olup olmadığını belirlemek için isteğe bağlı bir bayrak. (Varsayılan değer: false) Not: Şu anda JohnDeere için geçerlidir.
modifiedBy	string		Kullanıcı/kiracı kimliği tarafından değiştirildi.
modifiedDateTime	string		Kaynağın en son değiştirildiği tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
name	string		Kaynağı tanımlamak için ad.
properties			Kaynağa ait anahtar değer çiftleri koleksiyonu. Her çiftin 50 karakterden büyük bir anahtarı olmamalıdır ve 150 karakterden büyük bir değere sahip olmamalıdır. Not: Bir kaynak için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve datetime (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.