Skip to content

Commit 7d0dbd5

Browse files
change description of oauth refresh cred (#508) (#510)
Co-authored-by: Sainish Momin <130490494+sainishm2@users.noreply.github.com>
1 parent 6cbbf02 commit 7d0dbd5

201 files changed

Lines changed: 263 additions & 226 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

openapi-sdk.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8112,10 +8112,10 @@ components:
81128112
description: 'The token provided when you got the expired access token.'
81138113
type: string
81148114
client_id:
8115-
description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
8115+
description: 'The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.'
81168116
type: string
81178117
client_secret:
8118-
description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
8118+
description: 'The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.'
81198119
type: string
81208120
type: object
81218121
ReportCreateRequest:

openapi.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8112,10 +8112,10 @@ components:
81128112
description: 'The token provided when you got the expired access token.'
81138113
type: string
81148114
client_id:
8115-
description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
8115+
description: 'The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.'
81168116
type: string
81178117
client_secret:
8118-
description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
8118+
description: 'The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.'
81198119
type: string
81208120
type: object
81218121
ReportCreateRequest:

sdks/dotnet/docs/OAuthTokenRefreshRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | **ClientId** | **string** | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | [optional] **ClientSecret** | **string** | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | [optional]
7+
**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | **ClientId** | **string** | The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | [optional] **ClientSecret** | **string** | The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ protected OAuthTokenRefreshRequest() { }
4343
/// </summary>
4444
/// <param name="grantType">When refreshing an existing token use &#x60;refresh_token&#x60;. (required) (default to &quot;refresh_token&quot;).</param>
4545
/// <param name="refreshToken">The token provided when you got the expired access token. (required).</param>
46-
/// <param name="clientId">The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if disabled..</param>
47-
/// <param name="clientSecret">The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if disabled..</param>
46+
/// <param name="clientId">The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings..</param>
47+
/// <param name="clientSecret">The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings..</param>
4848
public OAuthTokenRefreshRequest(string grantType = @"refresh_token", string refreshToken = default(string), string clientId = default(string), string clientSecret = default(string))
4949
{
5050

@@ -95,16 +95,16 @@ public static OAuthTokenRefreshRequest Init(string jsonData)
9595
public string RefreshToken { get; set; }
9696

9797
/// <summary>
98-
/// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if disabled.
98+
/// The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.
9999
/// </summary>
100-
/// <value>The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if disabled.</value>
100+
/// <value>The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.</value>
101101
[DataMember(Name = "client_id", EmitDefaultValue = true)]
102102
public string ClientId { get; set; }
103103

104104
/// <summary>
105-
/// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if disabled.
105+
/// The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.
106106
/// </summary>
107-
/// <value>The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if disabled.</value>
107+
/// <value>The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.</value>
108108
[DataMember(Name = "client_secret", EmitDefaultValue = true)]
109109
public string ClientSecret { get; set; }
110110

sdks/java-v1/docs/OAuthTokenRefreshRequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
|------------ | ------------- | ------------- | -------------|
1111
| `grantType`<sup>*_required_</sup> | ```String``` | When refreshing an existing token use `refresh_token`. | |
1212
| `refreshToken`<sup>*_required_</sup> | ```String``` | The token provided when you got the expired access token. | |
13-
| `clientId` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
14-
| `clientSecret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
13+
| `clientId` | ```String``` | The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | |
14+
| `clientSecret` | ```String``` | The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | |
1515

1616

1717

sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,8 @@ public OAuthTokenRefreshRequest clientId(@javax.annotation.Nullable String clien
117117
}
118118

119119
/**
120-
* The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the
121-
* \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if
122-
* disabled.
120+
* The client ID for your API app. Required for new API apps. To enhance security, we recommend
121+
* making it required for existing apps in your app settings.
123122
*
124123
* @return clientId
125124
*/
@@ -141,9 +140,8 @@ public OAuthTokenRefreshRequest clientSecret(@javax.annotation.Nullable String c
141140
}
142141

143142
/**
144-
* The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if
145-
* the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional
146-
* if disabled.
143+
* The client secret for your API app. Required for new API apps. To enhance security, we
144+
* recommend making it required for existing apps in your app settings.
147145
*
148146
* @return clientSecret
149147
*/

sdks/java-v2/docs/OAuthTokenRefreshRequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
|------------ | ------------- | ------------- | -------------|
1111
| `grantType`<sup>*_required_</sup> | ```String``` | When refreshing an existing token use `refresh_token`. | |
1212
| `refreshToken`<sup>*_required_</sup> | ```String``` | The token provided when you got the expired access token. | |
13-
| `clientId` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
14-
| `clientSecret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
13+
| `clientId` | ```String``` | The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | |
14+
| `clientSecret` | ```String``` | The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | |
1515

1616

1717

sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ public OAuthTokenRefreshRequest clientId(@jakarta.annotation.Nullable String cli
131131
}
132132

133133
/**
134-
* The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if disabled.
134+
* The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.
135135
* @return clientId
136136
*/
137137
@jakarta.annotation.Nullable
@@ -156,7 +156,7 @@ public OAuthTokenRefreshRequest clientSecret(@jakarta.annotation.Nullable String
156156
}
157157

158158
/**
159-
* The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \&quot;Client Credentials Required\&quot; setting is enabled for token refresh; optional if disabled.
159+
* The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.
160160
* @return clientSecret
161161
*/
162162
@jakarta.annotation.Nullable

sdks/node/docs/model/OAuthTokenRefreshRequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
| `grantType`<sup>*_required_</sup> | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] |
1010
| `refreshToken`<sup>*_required_</sup> | ```string``` | The token provided when you got the expired access token. | |
11-
| `clientId` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
12-
| `clientSecret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
11+
| `clientId` | ```string``` | The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | |
12+
| `clientSecret` | ```string``` | The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | |
1313

1414
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

sdks/node/model/oAuthTokenRefreshRequest.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ export class OAuthTokenRefreshRequest {
3434
*/
3535
"refreshToken": string;
3636
/**
37-
* The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.
37+
* The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.
3838
*/
3939
"clientId"?: string;
4040
/**
41-
* The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.
41+
* The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.
4242
*/
4343
"clientSecret"?: string;
4444

0 commit comments

Comments
 (0)