OAuth

Activity Description:

This resources is for OAuth.

Properties:

Property
Description

activityGroup

Indicates it's related to HTTP.

activityType

Specifies it's a resource.

activityName

Identifies it as OAuth-related.

clientId

Your OAuth client ID.

clientSecret

Your OAuth client secret.

tokenUri

URI to obtain OAuth tokens.

refreshToken

Refresh token to renew access tokens.

numberOfPermits

Limit on the number of permitted requests.

refreshPeriod

Period after which tokens need refreshing.

enableRateLimiting

Whether rate limiting is enabled.

Example

{
    "activityGroup": "HTTP",
    "activityType": "RESOURCE",
    "activityName": "OAuth",
    "clientId": "your_client_id_here",
    "clientSecret": "your_client_secret_here",
    "tokenUri": "https://your.oauth.provider/token",
    "refreshToken": "your_refresh_token_here",
    "numberOfPermits": 1000,
    "refreshPeriod": "1 hour",
    "enableRateLimiting": true
}

In this sample:

  • your_client_id_here and your_client_secret_here should be replaced with your actual OAuth client ID and client secret, respectively.

  • https://your.oauth.provider/token should be replaced with the URI provided by your OAuth provider for obtaining access tokens.

  • your_refresh_token_here should be replaced with your actual refresh token obtained during the OAuth authorization process.

  • 1000 is just a placeholder for the number of permits.

  • "1 hour" is an example for the refresh period.

  • true indicates that rate limiting is enabled. You can set it to false if rate limiting is not required.

Last updated