O Auth Providers - Create Or Update

Servicio:

Azure Data Manager for Agriculture

Versión de la API:

2023-11-01-preview

Crea o actualiza un recurso oauthProvider.

PATCH {endpoint}/oauth/providers/{oauthProviderId}?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
oauthProviderId	path	True	string	Identificador del recurso oauthProvider.
api-version	query	True	string	La versión de API solicitada

Encabezado de la solicitud

Media Types: "application/merge-patch+json"

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

Media Types: "application/merge-patch+json"

Nombre	Tipo	Description
apiKey	string	Clave de api de OAuth para un proveedor determinado. Nota: Actualmente aplicable al proveedor climático. No se enviará en respuesta.
appId	string	Identificador de aplicación de OAuth para un proveedor de OAuth determinado.
appSecret	string	Secreto de aplicación de OAuth para un proveedor determinado. Nota: No se enviará en respuesta.
description	string	Descripción textual del recurso.
isProductionApp	boolean	Marca opcional para determinar si la aplicación está lista para usarse en escenarios de producción en el lado del proveedor o no. (Valor predeterminado: false) Nota: Actualmente aplicable a JohnDeere.
name	string	Nombre para identificar el recurso.
properties		Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores de cadena, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).

Respuestas

Nombre	Tipo	Description
200 OK	OAuthProvider	Correcto
201 Created	OAuthProvider	Creado
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

OAuthProviders_CreateOrUpdate

Solicitud de ejemplo

HTTP

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

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  }
}

Respuesta de muestra

status code:

200

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

status code:

201

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

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.
OAuthProvider	Esquema del recurso del proveedor de OAuth.

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.

OAuthProvider

Esquema del recurso del proveedor de OAuth.

Nombre	Tipo	Valor predeterminado	Description
apiKey	string		Clave de api de OAuth para un proveedor determinado. Nota: Actualmente aplicable al proveedor climático. No se enviará en respuesta.
appId	string		Identificador de aplicación de OAuth para un proveedor de OAuth determinado.
appSecret	string		Secreto de aplicación de OAuth para un proveedor determinado. Nota: No se enviará en respuesta.
createdBy	string		Creado por el identificador de usuario o inquilino.
createdDateTime	string		Fecha y hora en que se creó el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
description	string		Descripción textual del recurso.
eTag	string		Valor ETag para implementar la simultaneidad optimista.
id	string		Identificador único del proveedor de OAuth.
isProductionApp	boolean	False	Marca opcional para determinar si la aplicación está lista para usarse en escenarios de producción en el lado del proveedor o no. (Valor predeterminado: false) Nota: Actualmente aplicable a JohnDeere.
modifiedBy	string		Modificado por el identificador de usuario o inquilino.
modifiedDateTime	string		Fecha y hora en que se modificó por última vez el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
name	string		Nombre para identificar el recurso.
properties			Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores de cadena, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).