auth0 6.1.0 → 6.2.0

package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/client/Client.mjs

@@ -0,0 +1,108 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { normalizeClientOptionsWithAuth, } from "../../../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../../../core/index.mjs";
+import { mergeHeaders } from "../../../../../../../../core/headers.mjs";
+import * as environments from "../../../../../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../../../../../errors/index.mjs";
+import * as Management from "../../../../../../../index.mjs";
+export class GroupsClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Retrieve the list of groups assigned to a role in the context of an organization.
+     *
+     * @param {string} organization_id - ID of the organization.
+     * @param {string} role_id - ID of the role.
+     * @param {Management.ListOrganizationRoleGroupsRequestParameters} request
+     * @param {GroupsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.BadRequestError}
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.NotFoundError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.organizations.roles.groups.list("organization_id", "role_id", {
+     *         from: "from",
+     *         take: 1
+     *     })
+     */
+    list(organization_id_1, role_id_1) {
+        return __awaiter(this, arguments, void 0, function* (organization_id, role_id, request = {}, requestOptions) {
+            const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+                const { from: from_, take = 50 } = request;
+                const _queryParams = {
+                    from: from_,
+                    take,
+                };
+                const _authRequest = yield this._options.authProvider.getAuthRequest();
+                let _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+                const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                    url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ManagementEnvironment.Default, `organizations/${core.url.encodePathParam(organization_id)}/roles/${core.url.encodePathParam(role_id)}/groups`),
+                    method: "GET",
+                    headers: _headers,
+                    queryString: core.url
+                        .queryBuilder()
+                        .addMany(_queryParams)
+                        .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                        .build(),
+                    timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                    maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                    abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                    logging: this._options.logging,
+                });
+                if (_response.ok) {
+                    return {
+                        data: _response.body,
+                        rawResponse: _response.rawResponse,
+                    };
+                }
+                if (_response.error.reason === "status-code") {
+                    switch (_response.error.statusCode) {
+                        case 400:
+                            throw new Management.BadRequestError(_response.error.body, _response.rawResponse);
+                        case 401:
+                            throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
+                        case 403:
+                            throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
+                        case 404:
+                            throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
+                        case 429:
+                            throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                        default:
+                            throw new errors.ManagementError({
+                                statusCode: _response.error.statusCode,
+                                body: _response.error.body,
+                                rawResponse: _response.rawResponse,
+                            });
+                    }
+                }
+                return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/organizations/{organization_id}/roles/{role_id}/groups");
+            }));
+            const dataWithRawResponse = yield list(request).withRawResponse();
+            return new core.Page({
+                response: dataWithRawResponse.data,
+                rawResponse: dataWithRawResponse.rawResponse,
+                hasNextPage: (response) => (response === null || response === void 0 ? void 0 : response.next) != null && !(typeof (response === null || response === void 0 ? void 0 : response.next) === "string" && (response === null || response === void 0 ? void 0 : response.next) === ""),
+                getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.groups) !== null && _a !== void 0 ? _a : []; },
+                loadPage: (response) => {
+                    return list(core.setObjectProperty(request, "from", response === null || response === void 0 ? void 0 : response.next));
+                },
+            });
+        });
+    }
+}

package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/client/index.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/client/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/exports.d.mts

@@ -0,0 +1,2 @@
+export { GroupsClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { GroupsClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/management/api/resources/organizations/resources/roles/resources/index.d.mts

@@ -1 +1,2 @@
+export * as groups from "./groups/index.mjs";
 export * as members from "./members/index.mjs";

package/dist/esm/management/api/resources/organizations/resources/roles/resources/index.mjs

@@ -1 +1,2 @@
+export * as groups from "./groups/index.mjs";
 export * as members from "./members/index.mjs";

package/dist/esm/management/api/resources/organizations/resources/roles/resources/members/client/Client.d.mts

@@ -12,6 +12,11 @@ export declare class MembersClient {
     constructor(options: MembersClient.Options);
     /**
      * List the organization members assigned a specific role within the context of an organization.
+     * <ul>
+     *   <li>
+     *     <b>Note</b>: Returns only members with direct role assignments. For groups assigned to this role within the organization, use <code>GET /api/v2/organizations/{organization_id}/roles/{role_id}/groups</code>.
+     *   </li>
+     * </ul>
      *
      * @param {string} id - ID of the organization.
      * @param {string} role_id - ID of the role to retrieve the assigned members for.

package/dist/esm/management/api/resources/organizations/resources/roles/resources/members/client/Client.mjs

@@ -21,6 +21,11 @@ export class MembersClient {
     }
     /**
      * List the organization members assigned a specific role within the context of an organization.
+     * <ul>
+     *   <li>
+     *     <b>Note</b>: Returns only members with direct role assignments. For groups assigned to this role within the organization, use <code>GET /api/v2/organizations/{organization_id}/roles/{role_id}/groups</code>.
+     *   </li>
+     * </ul>
      *
      * @param {string} id - ID of the organization.
      * @param {string} role_id - ID of the role to retrieve the assigned members for.

package/dist/esm/management/api/resources/roles/client/Client.d.mts

@@ -37,7 +37,9 @@ export declare class RolesClient {
      *         per_page: 1,
      *         page: 1,
      *         include_totals: true,
-     *         name_filter: "name_filter"
+     *         name_filter: "name_filter",
+     *         type: "tenant",
+     *         owner_id: "owner_id"
      *     })
      */
     list(request?: Management.ListRolesRequestParameters, requestOptions?: RolesClient.RequestOptions): Promise<core.Page<Management.Role, Management.ListRolesOffsetPaginatedResponseContent>>;

package/dist/esm/management/api/resources/roles/client/Client.mjs

@@ -52,19 +52,23 @@ export class RolesClient {
      *         per_page: 1,
      *         page: 1,
      *         include_totals: true,
-     *         name_filter: "name_filter"
+     *         name_filter: "name_filter",
+     *         type: "tenant",
+     *         owner_id: "owner_id"
      *     })
      */
     list() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-                const { per_page: perPage = 50, page = 0, include_totals: includeTotals = true, name_filter: nameFilter, } = request;
+                const { per_page: perPage = 50, page = 0, include_totals: includeTotals = true, name_filter: nameFilter, type: type_, owner_id: ownerId, } = request;
                 const _queryParams = {
                     per_page: perPage,
                     page,
                     include_totals: includeTotals,
                     name_filter: nameFilter,
+                    type: type_ !== undefined ? type_ : undefined,
+                    owner_id: ownerId,
                 };
                 const _authRequest = yield this._options.authProvider.getAuthRequest();
                 let _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);

package/dist/esm/management/api/resources/roles/resources/users/client/Client.d.mts

@@ -13,6 +13,8 @@ export declare class UsersClient {
     /**
      * Retrieve list of users associated with a specific role. For Dashboard instructions, review [View Users Assigned to Roles](https://auth0.com/docs/manage-users/access-control/configure-core-rbac/roles/view-users-assigned-to-roles).
      *
+     * **Note**: Returns only users with direct role assignments. For groups assigned to this role, use `GET /api/v2/roles/{id}/groups`.
+     *
      * This endpoint supports two types of pagination:
      *
      * - Offset pagination
@@ -41,6 +43,7 @@ export declare class UsersClient {
      *
      * @example
      *     await client.roles.users.list("id", {
+     *         include_totals: true,
      *         from: "from",
      *         take: 1
      *     })

package/dist/esm/management/api/resources/roles/resources/users/client/Client.mjs

@@ -22,6 +22,8 @@ export class UsersClient {
     /**
      * Retrieve list of users associated with a specific role. For Dashboard instructions, review [View Users Assigned to Roles](https://auth0.com/docs/manage-users/access-control/configure-core-rbac/roles/view-users-assigned-to-roles).
      *
+     * **Note**: Returns only users with direct role assignments. For groups assigned to this role, use `GET /api/v2/roles/{id}/groups`.
+     *
      * This endpoint supports two types of pagination:
      *
      * - Offset pagination
@@ -50,6 +52,7 @@ export class UsersClient {
      *
      * @example
      *     await client.roles.users.list("id", {
+     *         include_totals: true,
      *         from: "from",
      *         take: 1
      *     })
@@ -58,8 +61,9 @@ export class UsersClient {
         return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
             const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-                const { from: from_, take = 50 } = request;
+                const { include_totals: includeTotals = true, from: from_, take = 50 } = request;
                 const _queryParams = {
+                    include_totals: includeTotals,
                     from: from_,
                     take,
                 };

package/dist/esm/management/api/resources/users/resources/groups/client/Client.d.mts

@@ -27,6 +27,7 @@ export declare class GroupsClient {
      *     await client.users.groups.get("id", {
      *         fields: "fields",
      *         include_fields: true,
+     *         include_totals: true,
      *         from: "from",
      *         take: 1
      *     })

package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs

@@ -36,6 +36,7 @@ export class GroupsClient {
      *     await client.users.groups.get("id", {
      *         fields: "fields",
      *         include_fields: true,
+     *         include_totals: true,
      *         from: "from",
      *         take: 1
      *     })
@@ -44,10 +45,11 @@ export class GroupsClient {
         return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
             const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-                const { fields, include_fields: includeFields, from: from_, take = 50 } = request;
+                const { fields, include_fields: includeFields, include_totals: includeTotals = true, from: from_, take = 50, } = request;
                 const _queryParams = {
                     fields,
                     include_fields: includeFields,
+                    include_totals: includeTotals,
                     from: from_,
                     take,
                 };

package/dist/esm/management/api/resources/users/resources/permissions/client/Client.d.mts

@@ -13,6 +13,8 @@ export declare class PermissionsClient {
     /**
      * Retrieve all permissions associated with the user.
      *
+     * **Note**: Returns only permissions from direct assignments and directly assigned roles. For permissions a user has via group-based role assignments, use `GET /api/v2/users/{id}/effective-permissions`.
+     *
      * @param {string} id - ID of the user to retrieve the permissions for.
      * @param {Management.ListUserPermissionsRequestParameters} request
      * @param {PermissionsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs

@@ -22,6 +22,8 @@ export class PermissionsClient {
     /**
      * Retrieve all permissions associated with the user.
      *
+     * **Note**: Returns only permissions from direct assignments and directly assigned roles. For permissions a user has via group-based role assignments, use `GET /api/v2/users/{id}/effective-permissions`.
+     *
      * @param {string} id - ID of the user to retrieve the permissions for.
      * @param {Management.ListUserPermissionsRequestParameters} request
      * @param {PermissionsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/management/api/resources/users/resources/refreshToken/client/Client.d.mts

@@ -24,6 +24,7 @@ export declare class RefreshTokenClient {
      *
      * @example
      *     await client.users.refreshToken.list("user_id", {
+     *         include_totals: true,
      *         from: "from",
      *         take: 1
      *     })

package/dist/esm/management/api/resources/users/resources/refreshToken/client/Client.mjs

@@ -33,6 +33,7 @@ export class RefreshTokenClient {
      *
      * @example
      *     await client.users.refreshToken.list("user_id", {
+     *         include_totals: true,
      *         from: "from",
      *         take: 1
      *     })
@@ -41,8 +42,9 @@ export class RefreshTokenClient {
         return __awaiter(this, arguments, void 0, function* (user_id, request = {}, requestOptions) {
             const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-                const { from: from_, take = 50 } = request;
+                const { include_totals: includeTotals = true, from: from_, take = 50 } = request;
                 const _queryParams = {
+                    include_totals: includeTotals,
                     from: from_,
                     take,
                 };

package/dist/esm/management/api/resources/users/resources/roles/client/Client.d.mts

@@ -15,6 +15,8 @@ export declare class RolesClient {
      *
      * **Note**: This action retrieves all roles assigned to a user in the context of your whole tenant. To retrieve Organization-specific roles, use the following endpoint: [Get user roles assigned to an Organization member](https://auth0.com/docs/api/management/v2/organizations/get-organization-member-roles).
      *
+     * **Note**: Returns only direct role assignments. To also include group-based role assignments, use `GET /api/v2/users/{id}/effective-roles`.
+     *
      * @param {string} id - ID of the user to list roles for.
      * @param {Management.ListUserRolesRequestParameters} request
      * @param {RolesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs

@@ -24,6 +24,8 @@ export class RolesClient {
      *
      * **Note**: This action retrieves all roles assigned to a user in the context of your whole tenant. To retrieve Organization-specific roles, use the following endpoint: [Get user roles assigned to an Organization member](https://auth0.com/docs/api/management/v2/organizations/get-organization-member-roles).
      *
+     * **Note**: Returns only direct role assignments. To also include group-based role assignments, use `GET /api/v2/users/{id}/effective-roles`.
+     *
      * @param {string} id - ID of the user to list roles for.
      * @param {Management.ListUserRolesRequestParameters} request
      * @param {RolesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/management/api/resources/users/resources/sessions/client/Client.d.mts

@@ -24,6 +24,7 @@ export declare class SessionsClient {
      *
      * @example
      *     await client.users.sessions.list("user_id", {
+     *         include_totals: true,
      *         from: "from",
      *         take: 1
      *     })

package/dist/esm/management/api/resources/users/resources/sessions/client/Client.mjs

@@ -33,6 +33,7 @@ export class SessionsClient {
      *
      * @example
      *     await client.users.sessions.list("user_id", {
+     *         include_totals: true,
      *         from: "from",
      *         take: 1
      *     })
@@ -41,8 +42,9 @@ export class SessionsClient {
         return __awaiter(this, arguments, void 0, function* (user_id, request = {}, requestOptions) {
             const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-                const { from: from_, take = 50 } = request;
+                const { include_totals: includeTotals = true, from: from_, take = 50 } = request;
                 const _queryParams = {
+                    include_totals: includeTotals,
                     from: from_,
                     take,
                 };