Sign in

v7

latestSwagger 2.02026-07-13186148695.0 KB
OAuthProviders

Get a specified oauthProvider resource.

get/oauth/providers/{oauthProviderId}

Path parameters

oauthProviderIdstring required

ID of the oauthProvider resource.

Query parameters

api-versionstring required

The requested API version

Response

Success

appIdstring

OAuth App Id for given OAuth Provider.

appSecretstring

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

apiKeystring

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

isProductionAppboolean

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.

idstring

Unique OAuth provider ID.

eTagstring

The ETag value to implement optimistic concurrency.

createdDateTimestring date-time

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

modifiedDateTimestring date-time

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

namestring

Name to identify resource.

descriptionstring

Textual description of the resource.

createdBystring

Created by user/tenant id.

modifiedBystring

Modified by user/tenant id.

propertiesobject

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.

Example response

{
  "createdDateTime": "2020-12-31T11:10:21Z",
  "modifiedDateTime": "2020-12-31T11:10:21Z",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}