Climate FieldView Credentials

Form of a Climate FieldView Credentials resource:

{
"status": "str",
"clientId": "str",
"clientSecret": "str",
"apiKey": "str",
"accessToken": "str",
"refreshToken": "str",
"scopes": ["str"]
}

Endpoints

DescriptionEndpoints
Get the Climate Fieldview credentialsGET /users/{leafUserId}/climate-field-view-credentials
Create a Climate Fieldview credentialsPOST /users/{leafUserId}/climate-field-view-credentials
Delete Climate Fieldview credentialsDELETE /users/{leafUserId}/climate-field-view-credentials

Climate Field View Credentials Endpoints

Get the Climate Fieldview credentials

 GET /users/{leafUserId}/climate-field-view-credentials

Get a Climate FieldView credentials object by its id. If during background processing we detect that this credential is no longer valid, the value of the status will be changed.

Request examples

curl -X GET \
-H 'Authorization: Bearer YOUR_TOKEN' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/climate-field-view-credentials'

Response

{
"clientId": "str",
"clientSecret": "str",
"apiKey": "str",
"refreshToken": "str",
"status": "str",
"scopes": ["str"]
}

Create a Climate Fieldview credentials

 POST /users/{leafUserId}/climate-field-view-credentials

Create a Climate FieldView credentials for the Leaf User.

Request body

{
"clientId": "str",
"clientSecret": "str",
"apiKey": "str",
"refreshToken": "str"
}

Response

A Climate FieldView credential with status.

{
"clientKey": "str",
"clientSecret": "str",
"tokenId": "str",
"tokenSecretKey": "str",
"status": "str"
}

Request examples

curl -X POST \
-H 'Authorization: Bearer YOUR_TOKEN' \
-d '{"clientId": "str","clientSecret": "str","apiKey": "str","refreshToken": "str"}' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/climate-field-view-credentials'

Delete Climate Fieldview credentials

 DELETE /users/{leafUserId}/climate-field-view-credentials

Delete Leaf User's Climate FieldView credentials.

Request examples

curl -X DELETE \
-H 'Authorization: Bearer YOUR_TOKEN' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/climate-field-view-credentials'

Troubleshooting

With these endpoints, you can do some troubleshooting to see your credential's health.

Events

 GET /users/{leafUserId}/climate-field-view-credentials/events

Get the logs of the provider credential based on the LeafUserId sent.

Request examples

curl -X GET \
-H 'Authorization: Bearer YOUR_TOKEN' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}
/climate-field-view-credentials/events'

Response

[
{
"body": "string",
"createdDate": "yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'",
"headers": "string",
"id": "string",
"statusCode": "int"
}
]
warning

The logs are available only for 30 days and once the credential is deleted or disassociated with the Leaf User, the logs are no longer available.