O Auth Providers - Create Or Update

Servizio:
Azure Data Manager for Agriculture
Versione API:
2023-11-01-preview

Crea o aggiorna una risorsa oauthProvider.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string (uri)

Nome host dello spazio dei nomi, ad esempio admaInstanceName.farmbeats.azure.net
oauthProviderId
 path True

string

ID della risorsa oauthProvider.
api-version
 query True

string

Versione dell'API richiesta

Intestazione della richiesta

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

Nome Necessario Tipo Descrizione
Authorization True

string

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Corpo della richiesta

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

Nome Tipo Descrizione
apiKey

string

minLength: 2
maxLength: 200

Chiave API OAuth per il provider specificato. Nota: attualmente applicabile al provider climate. Non verrà inviato in risposta.
appId

string

minLength: 2
maxLength: 200

ID app OAuth per il provider OAuth specificato.
appSecret

string

minLength: 2
maxLength: 200

Segreto dell'app OAuth per il provider specificato. Nota: non verrà inviato in risposta.
description

string

minLength: 0
maxLength: 500

Descrizione testuale della risorsa.
isProductionApp

boolean

Flag facoltativo per determinare se l'app è pronta per essere usata per gli scenari di produzione sul lato provider o meno. (Valore predefinito: false) Nota: attualmente applicabile per JohnDeere.
name

string

minLength: 0
maxLength: 100

Nome per identificare la risorsa.
properties

Raccolta di coppie chiave-valore che appartengono alla risorsa. Ogni coppia non deve avere una chiave maggiore di 50 caratteri e non deve avere un valore maggiore di 150 caratteri. Nota: è possibile specificare un massimo di 25 coppie di valori chiave per una risorsa e solo valori stringa, numerali e datetime (aaaa-MM-ggTHH:mm:ssZ).

Risposte

Nome Tipo Descrizione
200 OK

OAuthProvider

Successo
201 Created

OAuthProvider

Creato
Other Status Codes

ErrorResponse

Errore

Intestazioni

x-ms-error-code: string

Sicurezza

Authorization

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Tipo: apiKey
In: header

Esempio

OAuthProviders_CreateOrUpdate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}
Codice di stato:
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"
}

Definizioni

Nome Descrizione
Error

Errore del servizio Azure AgPlatform.
ErrorResponse

Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses per il documento di riferimento ErrorResponse.
InnerError

Errore interno contenente l'elenco degli errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento su InnerError.
OAuthProvider

Schema della risorsa del provider OAuth.

Error

Object

Errore del servizio Azure AgPlatform.

Nome Tipo Descrizione
code

string

minLength: 1

Set definito dal server di codici di errore.
details

Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

InnerError

Errore interno contenente l'elenco degli errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento su InnerError.
message

string

minLength: 1

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses per il documento di riferimento ErrorResponse.

Nome Tipo Descrizione
error

Error

Errore del servizio Azure AgPlatform.
traceId

string

ID traccia univoco.

InnerError

Object

Errore interno contenente l'elenco degli errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento su InnerError.

Nome Tipo Descrizione
code

string

Codice di errore specifico di quello fornito dall'errore contenitore.
innererror

InnerError

Errore interno contenente l'elenco degli errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento su InnerError.

OAuthProvider

Object

Schema della risorsa del provider OAuth.

Nome Tipo Valore predefinito Descrizione
apiKey

string

minLength: 2
maxLength: 200

Chiave API OAuth per il provider specificato. Nota: attualmente applicabile al provider climate. Non verrà inviato in risposta.
appId

string

minLength: 2
maxLength: 200

ID app OAuth per il provider OAuth specificato.
appSecret

string

minLength: 2
maxLength: 200

Segreto dell'app OAuth per il provider specificato. Nota: non verrà inviato in risposta.
createdBy

string

Creato dall'ID utente/tenant.
createdDateTime

string (date-time)

Data e ora di creazione della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.
description

string

minLength: 0
maxLength: 500

Descrizione testuale della risorsa.
eTag

string

Valore ETag per implementare la concorrenza ottimistica.
id

string

ID provider OAuth univoco.
isProductionApp

boolean

False

Flag facoltativo per determinare se l'app è pronta per essere usata per gli scenari di produzione sul lato provider o meno. (Valore predefinito: false) Nota: attualmente applicabile per JohnDeere.
modifiedBy

string

Modificato dall'ID utente/tenant.
modifiedDateTime

string (date-time)

Data e ora dell'ultima modifica della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.
name

string

minLength: 0
maxLength: 100

Nome per identificare la risorsa.
properties

Raccolta di coppie chiave-valore che appartengono alla risorsa. Ogni coppia non deve avere una chiave maggiore di 50 caratteri e non deve avere un valore maggiore di 150 caratteri. Nota: è possibile specificare un massimo di 25 coppie di valori chiave per una risorsa e solo valori stringa, numerali e datetime (aaaa-MM-ggTHH:mm:ssZ).