Share via

O Auth Providers - Get

Service:
Azure Data Manager for Agriculture
API Version:
2023-11-01-preview

Get a specified oauthProvider resource.

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

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net
oauthProviderId
 path True

string

ID of the oauthProvider resource.
api-version
 query True

string

The requested API version

Request Header

Name Required Type Description
Authorization True

string

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Responses

Name Type Description
200 OK

OAuthProvider

Success
Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Security

Authorization

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Type: apiKey
In: header

Examples

OAuthProviders_Get

Sample request

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

Sample response

Status code:
200 
{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "id": "JOHNDEERE",
  "eTag": "f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-22T18:27:37Z",
  "modifiedDateTime": "2021-04-22T18:27:37Z",
  "name": "JD Integration",
  "description": "Oauth Flow",
  "properties": {
    "Party": "123"
  }
}

Definitions

Name Description
Error

An error from the Azure AgPlatform service.
ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
OAuthProvider

Schema of OAuth provider resource.

Error

Object

An error from the Azure AgPlatform service.

Name Type Description
code

string

minLength: 1

Server-defined set of error codes.
details

Error[]

Array of details about specific errors that led to this reported error.
innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
message

string

minLength: 1

Human-readable representation of the error.
target

string

Target of the error.

ErrorResponse

Object

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

Name Type Description
error

Error

An error from the Azure AgPlatform service.
traceId

string

Unique trace Id.

InnerError

Object

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Name Type Description
code

string

Specific error code than was provided by the containing error.
innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

OAuthProvider

Object

Schema of OAuth provider resource.

Name Type Default value Description
apiKey

string

minLength: 2
maxLength: 200

OAuth Api key for given Provider. Note: currently Applicable to Climate provider. Won't be sent in response.
appId

string

minLength: 2
maxLength: 200

OAuth App Id for given OAuth Provider.
appSecret

string

minLength: 2
maxLength: 200

OAuth App secret for given Provider. Note: Won't be sent in response.
createdBy

string

Created by user/tenant id.
createdDateTime

string (date-time)

Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
description

string

minLength: 0
maxLength: 500

Textual description of the resource.
eTag

string

The ETag value to implement optimistic concurrency.
id

string

Unique OAuth provider ID.
isProductionApp

boolean

False

An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false) Note: Currently applicable for JohnDeere.
modifiedBy

string

Modified by user/tenant id.
modifiedDateTime

string (date-time)

Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
name

string

minLength: 0
maxLength: 100

Name to identify resource.
properties

A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.