O Auth Providers - Create Or Update

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Hiermee wordt een oauthProvider-resource gemaakt of bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string uri	De hostnaam van de naamruimte, bijvoorbeeld admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	Id van oauthProvider-resource.
api-version	query	True	string	De aangevraagde API-versie

Aanvraagkoptekst

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

Name	Vereist	Type	Description
Authorization	True	string	Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Aanvraagbody

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

Name	Type	Description
apiKey	string	OAuth API-sleutel voor de opgegeven provider. Opmerking: momenteel van toepassing op klimaatprovider. Wordt niet als antwoord verzonden.
appId	string	OAuth-app-id voor de opgegeven OAuth-provider.
appSecret	string	OAuth-app-geheim voor de opgegeven provider. Opmerking: wordt niet als antwoord verzonden.
description	string	Tekstuele beschrijving van de resource.
isProductionApp	boolean	Een optionele vlag om te bepalen of de app gereed is om te worden gebruikt voor productiescenario's aan de kant van de provider of niet. (Standaardwaarde: false) Opmerking: Momenteel van toepassing op JohnDeere.
name	string	Naam om resource te identificeren.
properties		Een verzameling sleutelwaardeparen die deel uitmaakt van de resource. Elk paar mag geen sleutel hebben die groter is dan 50 tekens en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen tekenreeks-, numerieke en datum/tijd-waarden (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.

Antwoorden

Name	Type	Description
200 OK	OAuthProvider	Geslaagd
201 Created	OAuthProvider	Gemaakt
Other Status Codes	ErrorResponse	Fout Headers x-ms-error-code: string

Beveiliging

Authorization

Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
Error	Een fout van de Azure AgPlatform-service.
ErrorResponse	Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.
InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
OAuthProvider	Schema van OAuth-providerresource.

Error

Een fout van de Azure AgPlatform-service.

Name	Type	Description
code	string	Door de server gedefinieerde set foutcodes.
details	Error[]	Matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
message	string	Door mensen leesbare weergave van de fout.
target	string	Doel van de fout.

ErrorResponse

Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.

Name	Type	Description
error	Error	Een fout van de Azure AgPlatform-service.
traceId	string	Unieke tracerings-id.

InnerError

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

Name	Type	Description
code	string	Specifieke foutcode dan is opgegeven door de betreffende fout.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

OAuthProvider

Schema van OAuth-providerresource.

Name	Type	Standaardwaarde	Description
apiKey	string		OAuth API-sleutel voor de opgegeven provider. Opmerking: momenteel van toepassing op klimaatprovider. Wordt niet als antwoord verzonden.
appId	string		OAuth-app-id voor de opgegeven OAuth-provider.
appSecret	string		OAuth-app-geheim voor de opgegeven provider. Opmerking: wordt niet als antwoord verzonden.
createdBy	string		Gemaakt door gebruikers-/tenant-id.
createdDateTime	string		Datum-tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
description	string		Tekstuele beschrijving van de resource.
eTag	string		De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.
id	string		Unieke OAuth-provider-id.
isProductionApp	boolean	False	Een optionele vlag om te bepalen of de app gereed is om te worden gebruikt voor productiescenario's aan de kant van de provider of niet. (Standaardwaarde: false) Opmerking: Momenteel van toepassing op JohnDeere.
modifiedBy	string		Gewijzigd door gebruiker/tenant-id.
modifiedDateTime	string		Datum/tijd waarop de resource voor het laatst is gewijzigd, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
name	string		Naam om resource te identificeren.
properties			Een verzameling sleutelwaardeparen die deel uitmaakt van de resource. Elk paar mag geen sleutel hebben die groter is dan 50 tekens en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen tekenreeks-, numerieke en datum/tijd-waarden (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.