O Auth Tokens - List

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Retorna 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 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
api-version	query	True	string	A versão da API solicitada
authProviderIds	query		string[]	Nome de AuthProvider.
isValid	query		boolean	Se o objeto de token for válido.
maxCreatedDateTime	query		string date-time	Data máxima de criação 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 padrão = 50.
minCreatedDateTime	query		string date-time	Data mínima de criação do recurso (inclusive).
minLastModifiedDateTime	query		string date-time	Data mínima da última modificação do recurso (inclusive).
partyIds	query		string[]	Lista de partes.
skipToken	query		string	Ignore o token para obter o próximo conjunto de resultados.

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ê já tentou chamadas não autenticadas antes.

Respostas

Nome	Tipo	Description
200 OK	OAuthTokenListResponse	Ê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ê já tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

OAuthTokens_List

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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

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 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 o documento de referência InnerError.
OAuthToken	Esquema do recurso de token OAuth.
OAuthTokenListResponse	A resposta paginada contém a lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.

Error

Um erro do serviço AgPlatform do Azure.

Nome	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 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 o documento de referência InnerError.
message	string	Representação legível ao olho humano do erro.
target	string	Destino do erro.

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

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

Nome	Tipo	Description
code	string	Código de erro específico do 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 o documento de referência InnerError.

OAuthToken

Esquema do recurso de token OAuth.

Nome	Tipo	Valor padrão	Description
authProviderId	string		ID do recurso do provedor OAuth que contém informações do aplicativo.
createdDateTime	string		Data e hora em que o recurso foi criado; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.
eTag	string		O valor ETag para implementar simultaneidade otimista.
isValid	boolean	True	Um sinalizador opcional que indica se o token é válido ou expirado (valor padrão: true).
modifiedDateTime	string		Data e hora em que o recurso foi modificado pela última vez; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.
partyId	string		ID da festa para esta configuração do OAuth.

OAuthTokenListResponse

A resposta paginada contém a lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.

Nome	Tipo	Description
nextLink	string	Link de continuação (URI absoluto) para a próxima página de resultados na lista.
skipToken	string	Token usado na recuperação da próxima página. Se for nulo, não haverá páginas adicionais.
value	OAuthToken[]	Lista de objetos solicitados.