O Auth Providers - Get

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Obtenha um recurso oauthProvider especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	ID do recurso oauthProvider.
api-version	query	True	string	A versão da API solicitada

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você tentou chamadas não autenticadas antes.

Respostas

Nome	Tipo	Description
200 OK	OAuthProvider	Êxito
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 de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

OAuthProviders_Get

Solicitação de exemplo

HTTP

GET {endpoint}/oauth/providers/JOHNDEERE?api-version=2023-11-01-preview

Resposta de exemplo

Código de status:

200

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "id": "JOHNDEERE",
  "eTag": "f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-22T18:27:37Z",
  "modifiedDateTime": "2021-04-22T18:27:37Z",
  "name": "JD Integration",
  "description": "Oauth Flow",
  "properties": {
    "Party": "123"
  }
}

Definições

Nome	Description
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
OAuthProvider	Esquema do recurso do provedor OAuth.

Error

Objeto

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string minLength: 1	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
message	string minLength: 1	Representação legível por humanos do erro.
target	string	Destino do erro.

ErrorResponse

Objeto

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

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

Objeto

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

Nome	Tipo	Description
code	string	Código de erro específico que foi fornecido pelo erro que contém.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

OAuthProvider

Objeto

Esquema do recurso do provedor OAuth.

Nome	Tipo	Valor padrão	Description
apiKey	string minLength: 2 maxLength: 200		Chave de API OAuth para determinado Provedor. Observação: atualmente aplicável ao provedor climate. Não será enviado em resposta.
appId	string minLength: 2 maxLength: 200		ID do aplicativo OAuth para determinado provedor OAuth.
appSecret	string minLength: 2 maxLength: 200		Segredo do aplicativo OAuth para determinado provedor. Observação: não será enviado em resposta.
createdBy	string		Criado por ID de usuário/locatário.
createdDateTime	string (date-time)		Data/hora em que o recurso foi criado, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500		Descrição textual do recurso.
eTag	string		O valor ETag para implementar a simultaneidade otimista.
id	string		ID exclusiva do provedor OAuth.
isProductionApp	boolean	False	Um sinalizador opcional para determinar se o aplicativo está pronto para ser usado para cenários de produção no lado do provedor ou não. (Valor padrão: false) Observação: atualmente aplicável a JohnDeere.
modifiedBy	string		Modificado pela ID do usuário/locatário.
modifiedDateTime	string (date-time)		Data/hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100		Nome para identificar o recurso.
properties			Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.