Skip to content

Commit 1e93ed5

Browse files
fern-api[bot]fern-api[bot]
authored
feat: Refresh Token Metadata API and Organization Discovery Domain by Name (#1283)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
1 parent 4b5cd27 commit 1e93ed5

10 files changed

Lines changed: 648 additions & 2 deletions

File tree

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "auth0",
3-
"version": "5.2.0",
3+
"version": "5.3.0",
44
"private": false,
55
"repository": {
66
"type": "git",

‎reference.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6818,6 +6818,77 @@ await client.refreshTokens.delete("id");
68186818
</dl>
68196819
</details>
68206820

6821+
<details><summary><code>client.refreshTokens.<a href="/src/management/api/resources/refreshTokens/client/Client.ts">update</a>(id, { ...params }) -> Management.UpdateRefreshTokenResponseContent</code></summary>
6822+
<dl>
6823+
<dd>
6824+
6825+
#### 📝 Description
6826+
6827+
<dl>
6828+
<dd>
6829+
6830+
<dl>
6831+
<dd>
6832+
6833+
Update a refresh token by its ID.
6834+
6835+
</dd>
6836+
</dl>
6837+
</dd>
6838+
</dl>
6839+
6840+
#### 🔌 Usage
6841+
6842+
<dl>
6843+
<dd>
6844+
6845+
<dl>
6846+
<dd>
6847+
6848+
```typescript
6849+
await client.refreshTokens.update("id");
6850+
```
6851+
6852+
</dd>
6853+
</dl>
6854+
</dd>
6855+
</dl>
6856+
6857+
#### ⚙️ Parameters
6858+
6859+
<dl>
6860+
<dd>
6861+
6862+
<dl>
6863+
<dd>
6864+
6865+
**id:** `string` — ID of the refresh token to update.
6866+
6867+
</dd>
6868+
</dl>
6869+
6870+
<dl>
6871+
<dd>
6872+
6873+
**request:** `Management.UpdateRefreshTokenRequestContent`
6874+
6875+
</dd>
6876+
</dl>
6877+
6878+
<dl>
6879+
<dd>
6880+
6881+
**requestOptions:** `RefreshTokensClient.RequestOptions`
6882+
6883+
</dd>
6884+
</dl>
6885+
</dd>
6886+
</dl>
6887+
6888+
</dd>
6889+
</dl>
6890+
</details>
6891+
68216892
## ResourceServers
68226893

68236894
<details><summary><code>client.resourceServers.<a href="/src/management/api/resources/resourceServers/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.ResourceServer, Management.ListResourceServerOffsetPaginatedResponseContent></code></summary>
@@ -20416,6 +20487,77 @@ await client.organizations.discoveryDomains.create("id", {
2041620487
</dl>
2041720488
</details>
2041820489

20490+
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">getByName</a>(id, discovery_domain) -> Management.GetOrganizationDiscoveryDomainByNameResponseContent</code></summary>
20491+
<dl>
20492+
<dd>
20493+
20494+
#### 📝 Description
20495+
20496+
<dl>
20497+
<dd>
20498+
20499+
<dl>
20500+
<dd>
20501+
20502+
Retrieve details about a single organization discovery domain specified by domain name.
20503+
20504+
</dd>
20505+
</dl>
20506+
</dd>
20507+
</dl>
20508+
20509+
#### 🔌 Usage
20510+
20511+
<dl>
20512+
<dd>
20513+
20514+
<dl>
20515+
<dd>
20516+
20517+
```typescript
20518+
await client.organizations.discoveryDomains.getByName("id", "discovery_domain");
20519+
```
20520+
20521+
</dd>
20522+
</dl>
20523+
</dd>
20524+
</dl>
20525+
20526+
#### ⚙️ Parameters
20527+
20528+
<dl>
20529+
<dd>
20530+
20531+
<dl>
20532+
<dd>
20533+
20534+
**id:** `string` — ID of the organization.
20535+
20536+
</dd>
20537+
</dl>
20538+
20539+
<dl>
20540+
<dd>
20541+
20542+
**discovery_domain:** `string` — Domain name of the discovery domain.
20543+
20544+
</dd>
20545+
</dl>
20546+
20547+
<dl>
20548+
<dd>
20549+
20550+
**requestOptions:** `DiscoveryDomainsClient.RequestOptions`
20551+
20552+
</dd>
20553+
</dl>
20554+
</dd>
20555+
</dl>
20556+
20557+
</dd>
20558+
</dl>
20559+
</details>
20560+
2041920561
<details><summary><code>client.organizations.discoveryDomains.<a href="/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts">get</a>(id, discovery_domain_id) -> Management.GetOrganizationDiscoveryDomainResponseContent</code></summary>
2042020562
<dl>
2042120563
<dd>

‎src/management/api/requests/requests.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1148,6 +1148,14 @@ export interface UpdateSettingsRequestContent {
11481148
webauthn_platform_first_factor?: boolean | null;
11491149
}
11501150

1151+
/**
1152+
* @example
1153+
* {}
1154+
*/
1155+
export interface UpdateRefreshTokenRequestContent {
1156+
refresh_token_metadata?: (Management.RefreshTokenMetadata | undefined) | null;
1157+
}
1158+
11511159
/**
11521160
* @example
11531161
* {
@@ -3228,6 +3236,8 @@ export interface CreateSelfServiceProfileSsoTicketRequestContent {
32283236
ttl_sec?: number;
32293237
domain_aliases_config?: Management.SelfServiceProfileSsoTicketDomainAliasesConfig;
32303238
provisioning_config?: Management.SelfServiceProfileSsoTicketProvisioningConfig;
3239+
/** Indicates whether a verified domain should be used for organization discovery during authentication. */
3240+
use_for_organization_discovery?: boolean;
32313241
}
32323242

32333243
/**

‎src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,94 @@ export class DiscoveryDomainsClient {
236236
);
237237
}
238238

239+
/**
240+
* Retrieve details about a single organization discovery domain specified by domain name.
241+
*
242+
*
243+
* @param {string} id - ID of the organization.
244+
* @param {string} discovery_domain - Domain name of the discovery domain.
245+
* @param {DiscoveryDomainsClient.RequestOptions} requestOptions - Request-specific configuration.
246+
*
247+
* @throws {@link Management.BadRequestError}
248+
* @throws {@link Management.UnauthorizedError}
249+
* @throws {@link Management.ForbiddenError}
250+
* @throws {@link Management.NotFoundError}
251+
* @throws {@link Management.TooManyRequestsError}
252+
*
253+
* @example
254+
* await client.organizations.discoveryDomains.getByName("id", "discovery_domain")
255+
*/
256+
public getByName(
257+
id: string,
258+
discovery_domain: string,
259+
requestOptions?: DiscoveryDomainsClient.RequestOptions,
260+
): core.HttpResponsePromise<Management.GetOrganizationDiscoveryDomainByNameResponseContent> {
261+
return core.HttpResponsePromise.fromPromise(this.__getByName(id, discovery_domain, requestOptions));
262+
}
263+
264+
private async __getByName(
265+
id: string,
266+
discovery_domain: string,
267+
requestOptions?: DiscoveryDomainsClient.RequestOptions,
268+
): Promise<core.WithRawResponse<Management.GetOrganizationDiscoveryDomainByNameResponseContent>> {
269+
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
270+
let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
271+
_authRequest.headers,
272+
this._options?.headers,
273+
requestOptions?.headers,
274+
);
275+
const _response = await (this._options.fetcher ?? core.fetcher)({
276+
url: core.url.join(
277+
(await core.Supplier.get(this._options.baseUrl)) ??
278+
(await core.Supplier.get(this._options.environment)) ??
279+
environments.ManagementEnvironment.Default,
280+
`organizations/${core.url.encodePathParam(id)}/discovery-domains/name/${core.url.encodePathParam(discovery_domain)}`,
281+
),
282+
method: "GET",
283+
headers: _headers,
284+
queryParameters: requestOptions?.queryParams,
285+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
286+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
287+
abortSignal: requestOptions?.abortSignal,
288+
fetchFn: this._options?.fetch,
289+
logging: this._options.logging,
290+
});
291+
if (_response.ok) {
292+
return {
293+
data: _response.body as Management.GetOrganizationDiscoveryDomainByNameResponseContent,
294+
rawResponse: _response.rawResponse,
295+
};
296+
}
297+
298+
if (_response.error.reason === "status-code") {
299+
switch (_response.error.statusCode) {
300+
case 400:
301+
throw new Management.BadRequestError(_response.error.body as unknown, _response.rawResponse);
302+
case 401:
303+
throw new Management.UnauthorizedError(_response.error.body as unknown, _response.rawResponse);
304+
case 403:
305+
throw new Management.ForbiddenError(_response.error.body as unknown, _response.rawResponse);
306+
case 404:
307+
throw new Management.NotFoundError(_response.error.body as unknown, _response.rawResponse);
308+
case 429:
309+
throw new Management.TooManyRequestsError(_response.error.body as unknown, _response.rawResponse);
310+
default:
311+
throw new errors.ManagementError({
312+
statusCode: _response.error.statusCode,
313+
body: _response.error.body,
314+
rawResponse: _response.rawResponse,
315+
});
316+
}
317+
}
318+
319+
return handleNonStatusCodeError(
320+
_response.error,
321+
_response.rawResponse,
322+
"GET",
323+
"/organizations/{id}/discovery-domains/name/{discovery_domain}",
324+
);
325+
}
326+
239327
/**
240328
* Retrieve details about a single organization discovery domain specified by ID.
241329
*

‎src/management/api/resources/refreshTokens/client/Client.ts‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,4 +167,89 @@ export class RefreshTokensClient {
167167

168168
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/refresh-tokens/{id}");
169169
}
170+
171+
/**
172+
* Update a refresh token by its ID.
173+
*
174+
* @param {string} id - ID of the refresh token to update.
175+
* @param {Management.UpdateRefreshTokenRequestContent} request
176+
* @param {RefreshTokensClient.RequestOptions} requestOptions - Request-specific configuration.
177+
*
178+
* @throws {@link Management.BadRequestError}
179+
* @throws {@link Management.UnauthorizedError}
180+
* @throws {@link Management.ForbiddenError}
181+
* @throws {@link Management.NotFoundError}
182+
* @throws {@link Management.TooManyRequestsError}
183+
*
184+
* @example
185+
* await client.refreshTokens.update("id")
186+
*/
187+
public update(
188+
id: string,
189+
request: Management.UpdateRefreshTokenRequestContent = {},
190+
requestOptions?: RefreshTokensClient.RequestOptions,
191+
): core.HttpResponsePromise<Management.UpdateRefreshTokenResponseContent> {
192+
return core.HttpResponsePromise.fromPromise(this.__update(id, request, requestOptions));
193+
}
194+
195+
private async __update(
196+
id: string,
197+
request: Management.UpdateRefreshTokenRequestContent = {},
198+
requestOptions?: RefreshTokensClient.RequestOptions,
199+
): Promise<core.WithRawResponse<Management.UpdateRefreshTokenResponseContent>> {
200+
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
201+
let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
202+
_authRequest.headers,
203+
this._options?.headers,
204+
requestOptions?.headers,
205+
);
206+
const _response = await (this._options.fetcher ?? core.fetcher)({
207+
url: core.url.join(
208+
(await core.Supplier.get(this._options.baseUrl)) ??
209+
(await core.Supplier.get(this._options.environment)) ??
210+
environments.ManagementEnvironment.Default,
211+
`refresh-tokens/${core.url.encodePathParam(id)}`,
212+
),
213+
method: "PATCH",
214+
headers: _headers,
215+
contentType: "application/json",
216+
queryParameters: requestOptions?.queryParams,
217+
requestType: "json",
218+
body: request,
219+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
220+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
221+
abortSignal: requestOptions?.abortSignal,
222+
fetchFn: this._options?.fetch,
223+
logging: this._options.logging,
224+
});
225+
if (_response.ok) {
226+
return {
227+
data: _response.body as Management.UpdateRefreshTokenResponseContent,
228+
rawResponse: _response.rawResponse,
229+
};
230+
}
231+
232+
if (_response.error.reason === "status-code") {
233+
switch (_response.error.statusCode) {
234+
case 400:
235+
throw new Management.BadRequestError(_response.error.body as unknown, _response.rawResponse);
236+
case 401:
237+
throw new Management.UnauthorizedError(_response.error.body as unknown, _response.rawResponse);
238+
case 403:
239+
throw new Management.ForbiddenError(_response.error.body as unknown, _response.rawResponse);
240+
case 404:
241+
throw new Management.NotFoundError(_response.error.body as unknown, _response.rawResponse);
242+
case 429:
243+
throw new Management.TooManyRequestsError(_response.error.body as unknown, _response.rawResponse);
244+
default:
245+
throw new errors.ManagementError({
246+
statusCode: _response.error.statusCode,
247+
body: _response.error.body,
248+
rawResponse: _response.rawResponse,
249+
});
250+
}
251+
}
252+
253+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/refresh-tokens/{id}");
254+
}
170255
}

0 commit comments

Comments
 (0)