O Auth Providers - Create Or Update

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Skapar eller uppdaterar en oauthProvider-resurs.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string uri	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	ID för resursen oauthProvider.
api-version	query	True	string	Den begärda API-versionen

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Begärandetext

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

Name	Typ	Description
apiKey	string	OAuth API-nyckel för angiven provider. Obs! Gäller för närvarande för klimatleverantören. Skickas inte som svar.
appId	string	OAuth-app-ID för given OAuth-provider.
appSecret	string	OAuth-apphemlighet för angiven provider. Obs! Skickas inte som svar.
description	string	Textbeskrivning av resursen.
isProductionApp	boolean	En valfri flagga för att avgöra om appen är redo att användas för produktionsscenarier på providersidan eller inte. (Standardvärde: false) Obs! Gäller för närvarande för JohnDeere.
name	string	Namn för att identifiera resursen.
properties		En samling nyckel/värde-par som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckel/värde-par kan anges för en resurs och endast värden för sträng, siffror och datetime (åå-MM-ddTHH:mm:ssZ) stöds.

Svar

Name	Typ	Description
200 OK	OAuthProvider	Klart
201 Created	OAuthProvider	Skapad
Other Status Codes	ErrorResponse	Fel Headers x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Type: apiKey
In: header

Exempel

OAuthProviders_CreateOrUpdate

Sample Request

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

Sample Response

Status code:

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

Status code:

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

Definitioner

Name	Description
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.
InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
OAuthProvider	Schema för OAuth-providerresurs.

Error

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
message	string	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

InnerError

Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

OAuthProvider

Schema för OAuth-providerresurs.

Name	Typ	Standardvärde	Description
apiKey	string		OAuth API-nyckel för angiven provider. Obs! Gäller för närvarande för klimatleverantören. Skickas inte som svar.
appId	string		OAuth-app-ID för given OAuth-provider.
appSecret	string		OAuth-apphemlighet för angiven provider. Obs! Skickas inte som svar.
createdBy	string		Skapat av användar-/klientorganisations-ID.
createdDateTime	string		Datum-tid när resursen skapades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
description	string		Textbeskrivning av resursen.
eTag	string		ETag-värdet för att implementera optimistisk samtidighet.
id	string		Unikt OAuth-provider-ID.
isProductionApp	boolean	False	En valfri flagga för att avgöra om appen är redo att användas för produktionsscenarier på providersidan eller inte. (Standardvärde: false) Obs! Gäller för närvarande för JohnDeere.
modifiedBy	string		Ändrat av användar-/klientorganisations-ID.
modifiedDateTime	string		Datum-tid när resursen senast ändrades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
name	string		Namn för att identifiera resursen.
properties			En samling nyckel/värde-par som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckel/värde-par kan anges för en resurs och endast värden för sträng, siffror och datetime (åå-MM-ddTHH:mm:ssZ) stöds.