Partilhar via

O Auth Providers - Create Or Update

  • Referência
Serviço:
Azure Data Manager for Agriculture
Versão da API:
2023-11-01-preview

Cria ou atualiza um recurso oauthProvider.

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

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string

uri

O nome do anfitrião do espaço de nomes, por exemplo, admaInstanceName.farmbeats.azure.net
oauthProviderId
 path True

string

ID do recurso oauthProvider.
api-version
 query True

string

A versão da API pedida

Cabeçalho do Pedido

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

Name Necessário Tipo Description
Authorization True

string

Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Corpo do Pedido

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

Name Tipo Description
apiKey

string

Chave da API OAuth para determinado Fornecedor. Nota: atualmente aplicável ao Fornecedor de clima. Não será enviado em resposta.
appId

string

ID da Aplicação OAuth para o Fornecedor OAuth especificado.
appSecret

string

Segredo da Aplicação OAuth para um fornecedor especificado. Nota: não será enviado em resposta.
description

string

Descrição textual do recurso.
isProductionApp

boolean

Um sinalizador opcional para determinar se a Aplicação está pronta para ser utilizada para cenários de Produção no lado do fornecedor ou não. (Valor predefinido: falso) Nota: atualmente aplicável a JohnDeere.
name

string

Nome para identificar o recurso.
properties

Uma coleção de pares de valores chave que pertence ao recurso. Cada par não pode ter uma chave superior a 50 carateres e não pode ter um valor superior a 150 carateres. Nota: é possível fornecer um máximo de 25 pares de valores de chave para um recurso e apenas os valores de cadeia, numeral e datetime (yyy-MM-ddTHH:mm:ssZ).

Respostas

Name Tipo Description
200 OK

OAuthProvider

Success
201 Created

OAuthProvider

Criado
Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

OAuthProviders_CreateOrUpdate

Pedido de amostra

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

Resposta da amostra

Código de estado:
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"
}
Código de estado:
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"
}

Definições

Name Description
Error

Um erro do serviço Azure AgPlatform.
ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.
InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
OAuthProvider

Esquema do recurso do fornecedor OAuth.

Error

Um erro do serviço Azure AgPlatform.

Name Tipo Description
code

string

Conjunto definido pelo servidor de códigos de erro.
details

Error[]

Matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message

string

Representação legível por humanos do erro.
target

string

Destino do erro.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

Name Tipo Description
error

Error

Um erro do serviço Azure AgPlatform.
traceId

string

ID de rastreio exclusivo.

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Name Tipo Description
code

string

Código de erro específico do que foi fornecido pelo erro de contenção.
innererror

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

OAuthProvider

Esquema do recurso do fornecedor OAuth.

Name Tipo Default value Description
apiKey

string

Chave da API OAuth para determinado Fornecedor. Nota: atualmente aplicável ao Fornecedor de clima. Não será enviado em resposta.
appId

string

ID da Aplicação OAuth para o Fornecedor OAuth especificado.
appSecret

string

Segredo da Aplicação OAuth para um fornecedor especificado. Nota: não será enviado em resposta.
createdBy

string

Criado pelo ID de utilizador/inquilino.
createdDateTime

string

Data-hora em que o recurso foi criado, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
description

string

Descrição textual do recurso.
eTag

string

O valor ETag para implementar a simultaneidade otimista.
id

string

ID exclusivo do fornecedor OAuth.
isProductionApp

boolean

False

Um sinalizador opcional para determinar se a Aplicação está pronta para ser utilizada para cenários de Produção no lado do fornecedor ou não. (Valor predefinido: falso) Nota: atualmente aplicável a JohnDeere.
modifiedBy

string

Modificado pelo ID de utilizador/inquilino.
modifiedDateTime

string

Data-hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
name

string

Nome para identificar o recurso.
properties

Uma coleção de pares de valores chave que pertence ao recurso. Cada par não pode ter uma chave superior a 50 carateres e não pode ter um valor superior a 150 carateres. Nota: é possível fornecer um máximo de 25 pares de valores de chave para um recurso e apenas os valores de cadeia, numeral e datetime (yyy-MM-ddTHH:mm:ssZ).