Compartir a través de

O Auth Tokens - Get O Auth Connection Link

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

Devuelve el vínculo Connection necesario en el flujo de OAuth.

POST {endpoint}/oauth/tokens/:connect?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

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.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
oAuthProviderId True

string

Identificador de OAuthProvider.
partyId True

string

Id. de la fiesta.
userRedirectLink True

string

Vínculo para redirigir al usuario, al final del flujo de oauth.
userRedirectState

string

Estado que se va a devolver al redirigir al usuario, al final del flujo de oauth.

Respuestas

Nombre Tipo Description
200 OK

string

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

Solicitud de ejemplo

POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview

{
  "partyId": "PARTY123",
  "oAuthProviderId": "JOHNDEERE",
  "userRedirectLink": "https://docs.microsoft.com",
  "userRedirectState": "code"
}

Respuesta de muestra

status code:
200 
"Connection string"

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

Obtiene los parámetros de consulta de configuración de OAuth.

Error

Error del servicio Azure AgPlatform.

Nombre Tipo Description
code

string

Conjunto de códigos de error definidos por el servidor.
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.

OAuthConnectRequest

Obtiene los parámetros de consulta de configuración de OAuth.

Nombre Tipo Description
oAuthProviderId

string

Identificador de OAuthProvider.
partyId

string

Id. de la fiesta.
userRedirectLink

string

Vínculo para redirigir al usuario, al final del flujo de oauth.
userRedirectState

string

Estado que se va a devolver al redirigir al usuario, al final del flujo de oauth.