O Auth Tokens - List

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Devolve uma lista de documentos OAuthToken.

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

Com parâmetros opcionais:

GET {endpoint}/oauth/tokens?authProviderIds={authProviderIds}&partyIds={partyIds}&isValid={isValid}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&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
api-version	query	True	string	A versão da API pedida
authProviderIds	query		string[]	Nome de AuthProvider.
isValid	query		boolean	Se o objeto de token for válido.
maxCreatedDateTime	query		string date-time	Data de criação máxima do recurso (inclusive).
maxLastModifiedDateTime	query		string date-time	Data máxima da última modificação do recurso (inclusive).
maxPageSize	query		integer int32	Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor predefinido = 50.
minCreatedDateTime	query		string date-time	Data de criação mínima do recurso (inclusive).
minLastModifiedDateTime	query		string date-time	Data mínima da última modificação do recurso (inclusive).
partyIds	query		string[]	Lista de partidos.
skipToken	query		string	Ignore o token para obter o próximo conjunto de resultados.

Cabeçalho do Pedido

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.

Respostas

Name	Tipo	Description
200 OK	OAuthTokenListResponse	Success
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

OAuthTokens_List

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "partyId": "PARTY123",
      "authProviderId": "JOHNDEERE",
      "isValid": true,
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "createdDateTime": "2021-04-22T18:49:25Z",
      "modifiedDateTime": "2021-04-22T18:49:25Z"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

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.
OAuthToken	Esquema do recurso de token OAuth.
OAuthTokenListResponse	A resposta paginada contém uma lista de objetos pedidos e uma ligação de URL para obter o próximo conjunto de resultados.

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.

OAuthToken

Esquema do recurso de token OAuth.

Name	Tipo	Default value	Description
authProviderId	string		ID do recurso do fornecedor OAuth que contém informações da aplicação.
createdDateTime	string		Data-hora em que o recurso foi criado, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
eTag	string		O valor ETag para implementar a simultaneidade otimista.
isValid	boolean	True	Um sinalizador opcional que indica se o token é válido ou expirou (Valor predefinido: verdadeiro).
modifiedDateTime	string		Data-hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
partyId	string		ID de festa para esta configuração OAuth.

OAuthTokenListResponse

A resposta paginada contém uma lista de objetos pedidos e uma ligação de URL para obter o próximo conjunto de resultados.

Name	Tipo	Description
nextLink	string	Ligação de continuação (URI absoluto) para a página seguinte dos resultados na lista.
skipToken	string	Token utilizado na obtenção da página seguinte. Se for nulo, não existem páginas adicionais.
value	OAuthToken[]	Lista de objetos pedidos.