O Auth Providers - Create Or Update

Odwołanie

Usługa:: Azure Data Manager for Agriculture

Wersja interfejsu API:: 2023-11-01-preview

Tworzy lub aktualizuje zasób oauthProvider.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Nazwa hosta przestrzeni nazw, np. admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	Identyfikator zasobu oauthProvider.
api-version	query	True	string	Żądana wersja interfejsu API

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej podjęto próbę nieuwierzytelnionego wywołania.

Treść żądania

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

Nazwa	Typ	Opis
apiKey	string	Klucz interfejsu API OAuth dla danego dostawcy. Uwaga: obecnie dotyczy dostawcy klimatu. Nie zostanie wysłana w odpowiedzi.
appId	string	Identyfikator aplikacji OAuth dla danego dostawcy OAuth.
appSecret	string	Wpis tajny aplikacji OAuth dla danego dostawcy. Uwaga: nie zostanie wysłana w odpowiedzi.
description	string	Tekstowy opis zasobu.
isProductionApp	boolean	Opcjonalna flaga określająca, czy aplikacja jest gotowa do użycia w scenariuszach produkcyjnych po stronie dostawcy, czy nie. (Wartość domyślna: false) Uwaga: obecnie dotyczy firmy JohnDeere.
name	string	Nazwa identyfikującego zasób.
properties		Kolekcja par klucz wartości, które należą do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OAuthProvider	Powodzenie
201 Created	OAuthProvider	Utworzone
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

OAuthProvider

Powodzenie

201 Created

OAuthProvider

Utworzone

Other Status Codes

ErrorResponse

Błąd

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej podjęto próbę nieuwierzytelnionego wywołania.

Typ: apiKey
W: header

Przykłady

OAuthProviders_CreateOrUpdate

Przykładowe żądanie

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"
  }
}

Przykładowa odpowiedź

Kod stanu:: 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"
}

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź o błędzie z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.
InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.
OAuthProvider	Schemat zasobu dostawcy OAuth.

Error

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string	Zestaw kodów błędów zdefiniowanych przez serwer.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź o błędzie z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

InnerError

Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.

OAuthProvider

Schemat zasobu dostawcy OAuth.

Nazwa	Typ	Domyślna wartość	Opis
apiKey	string		Klucz interfejsu API OAuth dla danego dostawcy. Uwaga: obecnie dotyczy dostawcy klimatu. Nie zostanie wysłana w odpowiedzi.
appId	string		Identyfikator aplikacji OAuth dla danego dostawcy OAuth.
appSecret	string		Wpis tajny aplikacji OAuth dla danego dostawcy. Uwaga: nie zostanie wysłana w odpowiedzi.
createdBy	string		Utworzony przez identyfikator użytkownika/dzierżawy.
createdDateTime	string		Data i godzina utworzenia zasobu, przykładowy format: rrrr-MM-ddTHH:mm:ssZ.
description	string		Tekstowy opis zasobu.
eTag	string		Wartość ETag do zaimplementowania optymistycznej współbieżności.
id	string		Unikatowy identyfikator dostawcy OAuth.
isProductionApp	boolean	False	Opcjonalna flaga określająca, czy aplikacja jest gotowa do użycia w scenariuszach produkcyjnych po stronie dostawcy, czy nie. (Wartość domyślna: false) Uwaga: obecnie dotyczy firmy JohnDeere.
modifiedBy	string		Zmodyfikowane przez identyfikator użytkownika/dzierżawy.
modifiedDateTime	string		Data i godzina ostatniej modyfikacji zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
name	string		Nazwa identyfikującego zasób.
properties			Kolekcja par klucz wartości, które należą do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).

Udostępnij za pośrednictwem

O Auth Providers - Create Or Update

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Authorization

Przykłady

OAuthProviders_CreateOrUpdate

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Error

ErrorResponse

InnerError

OAuthProvider

Dodatkowe zasoby