auth0 6.1.0 → 6.3.0

package/dist/cjs/management/api/requests/requests.d.ts

@@ -93,6 +93,44 @@ export interface UpdateActionRequestContent {
 export interface TestActionRequestContent {
     payload: Management.TestActionPayload;
 }
+/**
+ * @example
+ *     {
+ *         from: "from",
+ *         take: 1
+ *     }
+ */
+export interface ListAgentsRequestParameters {
+    /** Optional Id from which to start selection. */
+    from?: string | null;
+    /** Number of results per page. Defaults to 50. */
+    take?: number | null;
+}
+/**
+ * @example
+ *     {
+ *         name: "name"
+ *     }
+ */
+export interface CreateAgentRequestContent {
+    /** The agent name. Cannot contain <, >, or null bytes. */
+    name: string;
+    /** Optional client ID to associate with the agent */
+    client_id?: string;
+    /** Optional external identifier for the agent. Immutable after creation. Must be unique within the tenant. */
+    external_agent_id?: string;
+    metadata?: Management.AgentMetadata;
+}
+/**
+ * @example
+ *     {}
+ */
+export interface PatchAgentRequestParameters {
+    /** The agent name. Cannot contain <, >, or null bytes. */
+    name?: string;
+    /** Arbitrary key-value metadata for the agent. Pass null to clear all metadata. */
+    metadata?: Record<string, unknown> | null;
+}
 /**
  * @example
  *     {}
@@ -108,6 +146,7 @@ export interface UpdateBrandingRequestContent {
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1,
  *         audience: "audience",
@@ -118,6 +157,8 @@ export interface UpdateBrandingRequestContent {
  *     }
  */
 export interface ListClientGrantsRequestParameters {
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -461,6 +502,7 @@ export interface CreateConnectionProfileRequestContent {
     enabled_features?: Management.ConnectionProfileEnabledFeatures;
     connection_config?: Management.ConnectionProfileConfig;
     strategy_overrides?: Management.ConnectionProfileStrategyOverrides;
+    cross_app_access_resource_app?: Management.ConnectionProfileCrossAppAccessResourceApp;
 }
 /**
  * @example
@@ -473,10 +515,12 @@ export interface UpdateConnectionProfileRequestContent {
     enabled_features?: Management.ConnectionProfileEnabledFeatures;
     connection_config?: Management.ConnectionProfileConfig;
     strategy_overrides?: Management.ConnectionProfileStrategyOverrides;
+    cross_app_access_resource_app?: Management.ConnectionProfileCrossAppAccessResourceApp;
 }
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1,
  *         strategy: ["ad"],
@@ -486,6 +530,8 @@ export interface UpdateConnectionProfileRequestContent {
  *     }
  */
 export interface ListConnectionsQueryParameters {
+    /** true if a query summary must be included in the result, false otherwise. Not returned when using checkpoint pagination. Default <code>false</code>. */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -594,7 +640,7 @@ export interface CreateCustomDomainRequestContent {
     type: Management.CustomDomainProvisioningTypeEnum;
     verification_method?: Management.CustomDomainVerificationMethodEnum;
     tls_policy?: Management.CustomDomainTlsPolicyEnum;
-    custom_client_ip_header?: Management.CustomDomainCustomClientIpHeader | undefined;
+    custom_client_ip_header?: (Management.CustomDomainCustomClientIpHeader | undefined) | null;
     domain_metadata?: Management.DomainMetadata;
     /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided, the full domain will be used. */
     relying_party_identifier?: string;
@@ -616,7 +662,7 @@ export interface SetDefaultCustomDomainRequestContent {
 export interface UpdateCustomDomainRequestContent {
     /** recommended includes TLS 1.2 */
     tls_policy?: Management.CustomDomainTlsPolicyEnum;
-    custom_client_ip_header?: Management.CustomDomainCustomClientIpHeader | undefined;
+    custom_client_ip_header?: (Management.CustomDomainCustomClientIpHeader | undefined) | null;
     domain_metadata?: Management.DomainMetadata;
     /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. Set to null to remove the rpId and fall back to using the full domain. */
     relying_party_identifier?: string | null;
@@ -897,13 +943,13 @@ export interface GetFormRequestParameters {
  */
 export interface UpdateFormRequestContent {
     name?: string;
-    messages?: Management.FormMessagesNullable | undefined;
-    languages?: Management.FormLanguagesNullable | undefined;
-    translations?: Management.FormTranslationsNullable | undefined;
-    nodes?: Management.FormNodeListNullable | undefined;
-    start?: Management.FormStartNodeNullable | undefined;
-    ending?: Management.FormEndingNodeNullable | undefined;
-    style?: Management.FormStyleNullable | undefined;
+    messages?: (Management.FormMessagesNullable | undefined) | null;
+    languages?: (Management.FormLanguagesNullable | undefined) | null;
+    translations?: (Management.FormTranslationsNullable | undefined) | null;
+    nodes?: (Management.FormNodeListNullable | undefined) | null;
+    start?: (Management.FormStartNodeNullable | undefined) | null;
+    ending?: (Management.FormEndingNodeNullable | undefined) | null;
+    style?: (Management.FormStyleNullable | undefined) | null;
 }
 /**
  * @example
@@ -949,6 +995,7 @@ export interface DeleteUserGrantByUserIdRequestParameters {
  *         search: "search",
  *         fields: "fields",
  *         include_fields: true,
+ *         include_totals: true,
  *         from: "from",
  *         take: 1
  *     }
@@ -966,6 +1013,8 @@ export interface ListGroupsRequestParameters {
     fields?: string | null;
     /** Whether specified fields are to be included (true) or excluded (false). */
     include_fields?: boolean | null;
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -1154,18 +1203,24 @@ export interface UpdateNetworkAclRequestContent {
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1,
- *         sort: "sort"
+ *         sort: "sort",
+ *         include_client_association_for: "include_client_association_for"
  *     }
  */
 export interface ListOrganizationsRequestParameters {
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
     take?: number | null;
     /** Field to sort by. Use <code>field:order</code> where order is <code>1</code> for ascending and <code>-1</code> for descending. e.g. <code>created_at:1</code>. We currently support sorting by the following fields: <code>name</code>, <code>display_name</code> and <code>created_at</code>. */
     sort?: string | null;
+    /** Client ID. When set, each returned organization that has an association with this client gains a <code>client</code> object describing it; organizations without one omit the field. */
+    include_client_association_for?: string | null;
 }
 /**
  * @example
@@ -1184,6 +1239,8 @@ export interface CreateOrganizationRequestContent {
     enabled_connections?: Management.ConnectionForOrganization[];
     token_quota?: Management.CreateTokenQuota;
     third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum;
+    /** Whether app entitlement is active for this organization. */
+    is_app_entitlement_active?: boolean;
 }
 /**
  * @example
@@ -1198,6 +1255,8 @@ export interface UpdateOrganizationRequestContent {
     metadata?: Management.OrganizationMetadata;
     token_quota?: Management.UpdateTokenQuota | null;
     third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum;
+    /** Whether app entitlement is active for this organization. */
+    is_app_entitlement_active?: boolean;
 }
 /**
  * @example
@@ -1414,7 +1473,9 @@ export interface UpdateResourceServerRequestContent {
  *         per_page: 1,
  *         page: 1,
  *         include_totals: true,
- *         name_filter: "name_filter"
+ *         name_filter: "name_filter",
+ *         type: "tenant",
+ *         owner_id: "owner_id"
  *     }
  */
 export interface ListRolesRequestParameters {
@@ -1426,6 +1487,10 @@ export interface ListRolesRequestParameters {
     include_totals?: boolean | null;
     /** Optional filter on name (case-insensitive). */
     name_filter?: string | null;
+    /** Optional filter on the type of the role */
+    type?: Management.RoleTypeEnum | null;
+    /** Filter organization-level roles by owner ID. Required when type is "organization". */
+    owner_id?: string | null;
 }
 /**
  * @example
@@ -1438,6 +1503,10 @@ export interface CreateRoleRequestContent {
     name: string;
     /** Description of the role. */
     description?: string;
+    /** The type of the role. Defaults to tenant. */
+    type?: Management.RoleTypeEnum;
+    /** The ID of the organization that owns this role. Required when type is "organization". */
+    owner_id?: string;
 }
 /**
  * @example
@@ -1571,7 +1640,7 @@ export interface UpdateSelfServiceProfileRequestContent {
     /** The name of the self-service Profile. */
     name?: string;
     description?: (Management.SelfServiceProfileDescription | undefined) | null;
-    branding?: Management.SelfServiceProfileBranding | undefined;
+    branding?: (Management.SelfServiceProfileBranding | undefined) | null;
     /** List of IdP strategies that will be shown to users during the Self-Service Enterprise Configuration flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `auth0-samlp`, `okta-samlp`, `keycloak-samlp`, `pingfederate`] */
     allowed_strategies?: Management.SelfServiceProfileAllowedStrategyEnum[];
     user_attributes?: (Management.SelfServiceProfileUserAttributes | undefined) | null;
@@ -1734,7 +1803,7 @@ export interface CreateUserAttributeProfileRequestContent {
  */
 export interface UpdateUserAttributeProfileRequestContent {
     name?: Management.UserAttributeProfileName;
-    user_id?: Management.UserAttributeProfilePatchUserId | undefined;
+    user_id?: (Management.UserAttributeProfilePatchUserId | undefined) | null;
     user_attributes?: Management.UserAttributeProfileUserAttributes;
 }
 /**
@@ -2402,11 +2471,14 @@ export interface CreatePhoneTemplateTestNotificationRequestContent {
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1
  *     }
  */
 export interface ListClientGrantOrganizationsRequestParameters {
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -2481,7 +2553,8 @@ export interface ListDirectoryProvisioningsRequestParameters {
  * @example
  *     {
  *         from: "from",
- *         take: 1
+ *         take: 1,
+ *         q: "q"
  *     }
  */
 export interface ListSynchronizedGroupsRequestParameters {
@@ -2489,6 +2562,20 @@ export interface ListSynchronizedGroupsRequestParameters {
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
     take?: number | null;
+    /** Query in <a target='_new' href ='https://lucene.apache.org/core/2_9_4/queryparsersyntax.html'>Lucene query string syntax</a>. Only prefix search on "name" or "email" fields are allowed, with a single wildcard suffix. Operators, modifiers, and groupings are not allowed. Terms are treated as case-insensitive. Example query: "name:engineering*". */
+    q?: string | null;
+}
+/**
+ * @example
+ *     {
+ *         groups: [{
+ *                 id: "id"
+ *             }]
+ *     }
+ */
+export interface AddSynchronizedGroupsRequestContent {
+    /** Array of Google Workspace Directory group objects to synchronize. */
+    groups: Management.SynchronizedGroupPayload[];
 }
 /**
  * @example
@@ -2502,6 +2589,18 @@ export interface ReplaceSynchronizedGroupsRequestContent {
     /** Array of Google Workspace Directory group objects to synchronize. */
     groups: Management.SynchronizedGroupPayload[];
 }
+/**
+ * @example
+ *     {
+ *         groups: [{
+ *                 id: "id"
+ *             }]
+ *     }
+ */
+export interface DeleteSynchronizedGroupsRequestContent {
+    /** Array of groups to remove from the selection set. */
+    groups: Management.SynchronizedGroupSelectionId[];
+}
 /**
  * @example
  *     {
@@ -2647,11 +2746,14 @@ export interface CreateEventStreamRedeliveryRequestContent {
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1
  *     }
  */
 export interface ListFlowExecutionsRequestParameters {
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -3043,6 +3145,21 @@ export interface ImportEncryptionKeyRequestContent {
     /** Base64 encoded ciphertext of key material wrapped by public wrapping key. */
     wrapped_key: string;
 }
+/**
+ * @example
+ *     {
+ *         name: "name",
+ *         alg: "hmac-sha256",
+ *         value: "value"
+ *     }
+ */
+export interface CreateKeysNetworkAclsRequestContent {
+    /** Customer-supplied label with no cryptographic meaning. Must be unique across all Network ACL keys for the tenant. */
+    name: string;
+    alg: Management.NetworkAclKeyAlgorithmEnum;
+    /** Base64-encoded raw key material. Constraints on the decoded value depend on the algorithm specified. Currently only HMAC-SHA256 is supported. */
+    value: string;
+}
 /**
  * @example
  *     {
@@ -3078,6 +3195,50 @@ export interface AssociateOrganizationClientGrantRequestContent {
     /** A Client Grant ID to add to the organization. */
     grant_id: string;
 }
+/**
+ * @example
+ *     {
+ *         from: "from",
+ *         take: 1
+ *     }
+ */
+export interface ListOrganizationClientsRequestParameters {
+    /** Optional Id from which to start selection. */
+    from?: string | null;
+    /** Number of results per page. Defaults to 50. Values greater than the maximum of 100 are capped at 100. */
+    take?: number | null;
+}
+/**
+ * @example
+ *     {
+ *         clients: [{
+ *                 client_id: "client_id",
+ *                 use_for_member_access: true
+ *             }]
+ *     }
+ */
+export interface CreateOrganizationClientsRequestContent {
+    /** List of clients to associate with the organization. */
+    clients: Management.CreateOrganizationClientRequestItem[];
+}
+/**
+ * @example
+ *     {
+ *         clients: ["clients"]
+ *     }
+ */
+export interface DeleteOrganizationClientsRequestContent {
+    /** List of client IDs to disassociate from the organization. */
+    clients: string[];
+}
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateOrganizationClientRequestContent {
+    /** Whether this client is used for member access to the organization. */
+    use_for_member_access?: boolean;
+}
 /**
  * @example
  *     {
@@ -3283,6 +3444,7 @@ export interface GetOrganizationInvitationRequestParameters {
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1,
  *         fields: "fields",
@@ -3290,6 +3452,8 @@ export interface GetOrganizationInvitationRequestParameters {
  *     }
  */
 export interface ListOrganizationMembersRequestParameters {
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -3449,6 +3613,19 @@ export interface ListOrganizationRoleMembersRequestParameters {
     /** Whether specified fields are to be included (true) or excluded (false). Defaults to true. */
     include_fields?: boolean | null;
 }
+/**
+ * @example
+ *     {
+ *         from: "from",
+ *         take: 1
+ *     }
+ */
+export interface ListOrganizationRoleGroupsRequestParameters {
+    /** Optional Id from which to start selection. */
+    from?: string | null;
+    /** Number of results per page. Defaults to 50. */
+    take?: number | null;
+}
 /**
  * @example
  *     {
@@ -3606,11 +3783,14 @@ export interface DeleteRolePermissionsRequestContent {
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1
  *     }
  */
 export interface ListRoleUsersRequestParameters {
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -3853,6 +4033,7 @@ export interface ListUserEffectiveRolesRequestParameters {
  *     {
  *         fields: "fields",
  *         include_fields: true,
+ *         include_totals: true,
  *         from: "from",
  *         take: 1
  *     }
@@ -3862,6 +4043,8 @@ export interface GetUserGroupsRequestParameters {
     fields?: string | null;
     /** Whether specified fields are to be included (true) or excluded (false). */
     include_fields?: boolean | null;
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** Optional Id from which to start selection. */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -4010,11 +4193,14 @@ export interface DeleteUserRolesRequestContent {
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1
  *     }
  */
 export interface ListRefreshTokensRequestParameters {
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** An optional cursor from which to start the selection (exclusive). */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */
@@ -4023,11 +4209,14 @@ export interface ListRefreshTokensRequestParameters {
 /**
  * @example
  *     {
+ *         include_totals: true,
  *         from: "from",
  *         take: 1
  *     }
  */
 export interface ListUserSessionsRequestParameters {
+    /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
+    include_totals?: boolean | null;
     /** An optional cursor from which to start the selection (exclusive). */
     from?: string | null;
     /** Number of results per page. Defaults to 50. */

package/dist/cjs/management/api/resources/agents/client/Client.d.ts

@@ -0,0 +1,100 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Management from "../../../index.js";
+export declare namespace AgentsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AgentsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AgentsClient.Options>;
+    constructor(options: AgentsClient.Options);
+    /**
+     * Get agents
+     *
+     * @param {Management.ListAgentsRequestParameters} request
+     * @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.BadRequestError}
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.agents.list({
+     *         from: "from",
+     *         take: 1
+     *     })
+     */
+    list(request?: Management.ListAgentsRequestParameters, requestOptions?: AgentsClient.RequestOptions): Promise<core.Page<Management.AgentResponseContent, Management.ListAgentsResponseContent>>;
+    /**
+     * Create an agent
+     *
+     * @param {Management.CreateAgentRequestContent} request
+     * @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.BadRequestError}
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.ConflictError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.agents.create({
+     *         name: "name"
+     *     })
+     */
+    create(request: Management.CreateAgentRequestContent, requestOptions?: AgentsClient.RequestOptions): core.HttpResponsePromise<Management.AgentResponseContent>;
+    private __create;
+    /**
+     * Get an agent
+     *
+     * @param {string} id - The agent ID
+     * @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.NotFoundError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.agents.read("id")
+     */
+    read(id: string, requestOptions?: AgentsClient.RequestOptions): core.HttpResponsePromise<Management.AgentResponseContent>;
+    private __read;
+    /**
+     * Delete an agent
+     *
+     * @param {string} id - The agent ID
+     * @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Management.BadRequestError}
+     * @throws {@link Management.UnauthorizedError}
+     * @throws {@link Management.ForbiddenError}
+     * @throws {@link Management.TooManyRequestsError}
+     *
+     * @example
+     *     await client.agents.delete("id")
+     */
+    delete(id: string, requestOptions?: AgentsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+    /**
+     * Update an agent
+     *
+     * @param {string} id - The agent ID
+     * @param {Management.PatchAgentRequestParameters} request
+     * @param {AgentsClient.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.agents.update("id")
+     */
+    update(id: string, request?: Management.PatchAgentRequestParameters, requestOptions?: AgentsClient.RequestOptions): core.HttpResponsePromise<Management.AgentResponseContent>;
+    private __update;
+}