Compartir a través de

O Auth Tokens - List

  • Referencia
Servicio:
Azure Data Manager for Agriculture
Versión de la API:
2023-11-01-preview

Devuelve una lista de documentos de OAuthToken.

GET {endpoint}/oauth/tokens?api-version=2023-11-01-preview
Con parámetros opcionales: 
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 identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

uri

Nombre de host del espacio de nombres, por ejemplo, admaInstanceName.farmbeats.azure.net
api-version
 query True

string

La versión de API solicitada
authProviderIds
 query

string[]

Nombre de AuthProvider.
isValid
 query

boolean

Si el objeto de token es válido.
maxCreatedDateTime
 query

string

date-time

Fecha máxima de creación del recurso (ambos incluidos).
maxLastModifiedDateTime
 query

string

date-time

Fecha máxima de última modificación del recurso (inclusive).
maxPageSize
 query

integer

int32

Número máximo de elementos necesarios (ambos incluidos). Mínimo = 10, Máximo = 1000, Valor predeterminado = 50.
minCreatedDateTime
 query

string

date-time

Fecha mínima de creación del recurso (ambos incluidos).
minLastModifiedDateTime
 query

string

date-time

Fecha mínima de última modificación del recurso (ambos incluidos).
partyIds
 query

string[]

Lista de partes.
skipToken
 query

string

Omita el token para obtener el siguiente conjunto de resultados.

Encabezado de la solicitud

Nombre Requerido Tipo Description
Authorization True

string

Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Respuestas

Nombre Tipo Description
200 OK

OAuthTokenListResponse

Correcto
Other Status Codes

ErrorResponse

Error

Encabezados

x-ms-error-code: string

Seguridad

Authorization

Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Tipo: apiKey
En: header

Ejemplos

OAuthTokens_List

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
}

Definiciones

Nombre Description
Error

Error del servicio Azure AgPlatform.
ErrorResponse

Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses el documento de referencia ErrorResponse.
InnerError

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.
OAuthToken

Esquema del recurso de token de OAuth.
OAuthTokenListResponse

La respuesta paginada contiene una lista de objetos solicitados y un vínculo url para obtener el siguiente conjunto de resultados.

Error

Error del servicio Azure AgPlatform.

Nombre Tipo Description
code

string

Conjunto definido por el servidor de códigos de error.
details

Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror

InnerError

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.
message

string

Representación legible del error.
target

string

Destino del error.

ErrorResponse

Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses el documento de referencia ErrorResponse.

Nombre Tipo Description
error

Error

Error del servicio Azure AgPlatform.
traceId

string

Identificador de seguimiento único.

InnerError

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.

Nombre Tipo Description
code

string

Código de error específico del proporcionado por el error contenedor.
innererror

InnerError

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia innerError.

OAuthToken

Esquema del recurso de token de OAuth.

Nombre Tipo Valor predeterminado Description
authProviderId

string

Identificador del recurso del proveedor de OAuth que contiene información de la aplicación.
createdDateTime

string

Fecha y hora en que se creó el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
eTag

string

Valor ETag para implementar la simultaneidad optimista.
isValid

boolean

True

Marca opcional que indica si el token es válido o ha expirado (valor predeterminado: true).
modifiedDateTime

string

Fecha y hora en que se modificó por última vez el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
partyId

string

Id. de entidad para esta configuración de OAuth.

OAuthTokenListResponse

La respuesta paginada contiene una lista de objetos solicitados y un vínculo url para obtener el siguiente conjunto de resultados.

Nombre Tipo Description
nextLink

string

Vínculo de continuación (URI absoluto) a la página siguiente de resultados de la lista.
skipToken

string

Token usado para recuperar la página siguiente. Si es null, no hay páginas adicionales.
value

OAuthToken[]

Lista de objetos solicitados.