auth0 6.1.0 → 6.2.0

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

@@ -12,6 +12,18 @@ export declare const OauthScope: {
     /**
      * Delete Actions */
     readonly DeleteActions: "delete:actions";
+    /**
+     * Create Agents */
+    readonly CreateAgents: "create:agents";
+    /**
+     * Read Agents */
+    readonly ReadAgents: "read:agents";
+    /**
+     * Update Agents */
+    readonly UpdateAgents: "update:agents";
+    /**
+     * Delete Agents */
+    readonly DeleteAgents: "delete:agents";
     /**
      * Read Anomaly Blocks */
     readonly ReadAnomalyBlocks: "read:anomaly_blocks";
@@ -708,27 +720,39 @@ export declare const OauthScope: {
     /**
      * Delete Vdcs Templates */
     readonly DeleteVdcsTemplates: "delete:vdcs_templates";
+    /**
+     * Create Organization Client Associations */
+    readonly CreateOrganizationClients: "create:organization_clients";
+    /**
+     * Read Organization Client Associations */
+    readonly ReadOrganizationClients: "read:organization_clients";
+    /**
+     * Update Organization Client Associations */
+    readonly UpdateOrganizationClients: "update:organization_clients";
+    /**
+     * Delete Organization Client Associations */
+    readonly DeleteOrganizationClients: "delete:organization_clients";
 };
 export type OauthScope = (typeof OauthScope)[keyof typeof OauthScope];
-export interface NotFoundErrorBody {
+export interface TooManyRequestsErrorBody {
     message: string;
     statusCode: string;
-    error: NotFoundErrorBody.Error_;
+    error: TooManyRequestsErrorBody.Error_;
 }
-export declare namespace NotFoundErrorBody {
+export declare namespace TooManyRequestsErrorBody {
     const Error_: {
-        readonly NotFound: "Not Found";
+        readonly TooManyRequests: "Too Many Requests";
     };
     type Error_ = (typeof Error_)[keyof typeof Error_];
 }
-export interface TooManyRequestsErrorBody {
+export interface NotFoundErrorBody {
     message: string;
     statusCode: string;
-    error: TooManyRequestsErrorBody.Error_;
+    error: NotFoundErrorBody.Error_;
 }
-export declare namespace TooManyRequestsErrorBody {
+export declare namespace NotFoundErrorBody {
     const Error_: {
-        readonly TooManyRequests: "Too Many Requests";
+        readonly NotFound: "Not Found";
     };
     type Error_ = (typeof Error_)[keyof typeof Error_];
 }
@@ -1159,6 +1183,7 @@ export type AculContextConfigurationItem = Management.AculContextEnum
 export declare const AculContextEnum: {
     readonly BrandingSettings: "branding.settings";
     readonly BrandingThemesDefault: "branding.themes.default";
+    readonly CountryCodes: "country_codes";
     readonly ClientLogoUri: "client.logo_uri";
     readonly ClientDescription: "client.description";
     readonly OrganizationDisplayName: "organization.display_name";
@@ -1259,6 +1284,23 @@ export interface AddOrganizationConnectionResponseContent {
     is_signup_enabled?: boolean | undefined;
     connection?: Management.OrganizationConnectionInformation | undefined;
 }
+/**
+ * Arbitrary key-value metadata for the agent
+ */
+export type AgentMetadata = Record<string, unknown>;
+export interface AgentResponseContent {
+    /** The agent ID */
+    agent_id: string;
+    /** The agent name */
+    name: string;
+    /** When the agent was created */
+    created_at: string;
+    /** When the agent was last updated */
+    updated_at: string;
+    /** External identifier for the agent, if set. Omitted when not set. */
+    external_agent_id?: string | undefined;
+    metadata: Management.AgentMetadata;
+}
 /**
  * IP address to check.
  */
@@ -2969,6 +3011,20 @@ export interface ClientTokenVaultPrivilegedAccessWithPublicKey {
     ip_allowlist?: Management.TokenVaultPrivilegedAccessIpAllowlistEntry[] | undefined;
     grants?: Management.TokenVaultPrivilegedAccessGrant[] | undefined;
 }
+/**
+ * Conflict
+ */
+export interface ConflictSchema {
+    message: string;
+    statusCode: string;
+    error: ConflictSchema.Error_;
+}
+export declare namespace ConflictSchema {
+    const Error_: {
+        readonly Conflict: "Conflict";
+    };
+    type Error_ = (typeof Error_)[keyof typeof Error_];
+}
 export interface ConnectedAccount {
     /** The unique identifier for the connected account. */
     id: string;
@@ -3307,6 +3363,8 @@ export type ConnectionConfiguration = Record<string, string>;
 export interface ConnectionConnectedAccountsPurpose {
     active: boolean;
     cross_app_access?: boolean | undefined;
+    /** When true, allows storing a connected account without an upstream identity provider user id. At most one such connected account is allowed per user per connection. Default false preserves the strict behaviour (an upstream user id is required). */
+    allow_missing_user_id?: boolean | undefined;
 }
 /**
  * Configure the purpose of a connection to be used for connected accounts and Token Vault.
@@ -3314,6 +3372,8 @@ export interface ConnectionConnectedAccountsPurpose {
 export interface ConnectionConnectedAccountsPurposeXaa {
     cross_app_access?: boolean | undefined;
     active: boolean;
+    /** When true, allows storing a connected account without an upstream identity provider user id. At most one such connected account is allowed per user per connection. Default false preserves the strict behaviour (an upstream user id is required). */
+    allow_missing_user_id?: boolean | undefined;
 }
 /**
  * OAuth 2.0 PKCE (Proof Key for Code Exchange) settings. PKCE enhances security for public clients by preventing authorization code interception attacks. 'auto' (recommended) uses the strongest method supported by the IdP.
@@ -8673,6 +8733,13 @@ export interface CreateOrganizationAllConnectionResponseContent {
     connection_id: string;
     connection?: Management.OrganizationConnectionInformation | undefined;
 }
+export interface CreateOrganizationClientRequestItem {
+    /** The identifier of the client to associate. */
+    client_id: string;
+    /** Whether this client is used for member access to the organization. */
+    use_for_member_access: boolean;
+}
+export type CreateOrganizationClientsResponseContent = Management.OrganizationClient[];
 export interface CreateOrganizationDiscoveryDomainResponseContent {
     /** Organization discovery domain identifier. */
     id: string;
@@ -8721,6 +8788,9 @@ export interface CreateOrganizationResponseContent {
     metadata?: Management.OrganizationMetadata | undefined;
     token_quota?: Management.TokenQuota | undefined;
     third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum | undefined;
+    /** Whether app entitlement is active for this organization. */
+    is_app_entitlement_active?: boolean | undefined;
+    client?: Management.OrganizationClientAssociation | undefined;
     enabled_connections?: Management.OrganizationEnabledConnection[] | undefined;
     /** Accepts any additional properties */
     [key: string]: any;
@@ -8810,6 +8880,9 @@ export interface CreateRoleResponseContent {
     name?: string | undefined;
     /** Description of this role. */
     description?: string | undefined;
+    type?: Management.RoleTypeEnum | undefined;
+    /** The id of the entity that owns this role, such as an organization id. */
+    owner_id?: string | undefined;
 }
 export interface CreateRuleResponseContent {
     /** Name of this rule. */
@@ -9729,8 +9802,7 @@ export interface EventStreamCloudEvent {
     type?: string | undefined;
     /** Timestamp at which the event was generated */
     time?: string | undefined;
-    /** Event contents encoded as a string. */
-    data?: string | undefined;
+    data?: Management.EventStreamCloudEventData | undefined;
 }
 /**
  * The purpose of this event. This field will typically appear only in special cases
@@ -13877,6 +13949,10 @@ export interface EventStreamCloudEventContextTenant {
     /** Machine-generated unique tenant identifier. */
     tenant_id: string;
 }
+/**
+ * Event contents.
+ */
+export type EventStreamCloudEventData = Record<string, unknown>;
 /** Machine-readable error code. */
 export declare const EventStreamCloudEventErrorCodeEnum: {
     readonly InvalidCursor: "invalid_cursor";
@@ -16882,6 +16958,8 @@ export interface EventStreamDeliveryAttempt {
     timestamp: string;
     /** Delivery error message, if applicable */
     error_message?: string | undefined;
+    /** Duration of the delivery attempt in milliseconds */
+    duration?: number | undefined;
 }
 /** Type of event */
 export declare const EventStreamDeliveryEventTypeEnum: {
@@ -21059,9 +21137,19 @@ export interface GetOrganizationByNameResponseContent {
     metadata?: Management.OrganizationMetadata | undefined;
     token_quota?: Management.TokenQuota | undefined;
     third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum | undefined;
+    /** Whether app entitlement is active for this organization. */
+    is_app_entitlement_active?: boolean | undefined;
+    client?: Management.OrganizationClientAssociation | undefined;
     /** Accepts any additional properties */
     [key: string]: any;
 }
+export interface GetOrganizationClientResponseContent {
+    /** The identifier of the client associated with the organization. */
+    client_id: string;
+    /** Whether this client is used for member access to the organization. */
+    use_for_member_access: boolean;
+    client: Management.OrganizationClientMetadata;
+}
 export interface GetOrganizationConnectionResponseContent {
     /** ID of the connection. */
     connection_id?: string | undefined;
@@ -21134,6 +21222,9 @@ export interface GetOrganizationResponseContent {
     metadata?: Management.OrganizationMetadata | undefined;
     token_quota?: Management.TokenQuota | undefined;
     third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum | undefined;
+    /** Whether app entitlement is active for this organization. */
+    is_app_entitlement_active?: boolean | undefined;
+    client?: Management.OrganizationClientAssociation | undefined;
     /** Accepts any additional properties */
     [key: string]: any;
 }
@@ -21250,6 +21341,9 @@ export interface GetRoleResponseContent {
     name?: string | undefined;
     /** Description of this role. */
     description?: string | undefined;
+    type?: Management.RoleTypeEnum | undefined;
+    /** The id of the entity that owns this role, such as an organization id. */
+    owner_id?: string | undefined;
 }
 export interface GetRuleResponseContent {
     /** Name of this rule. */
@@ -21685,6 +21779,7 @@ export interface GuardianFactor {
     /** Whether trial limits have been exceeded. */
     trial_expired?: boolean | undefined;
     name?: Management.GuardianFactorNameEnum | undefined;
+    settings?: Management.GuardianFactorSettings | undefined;
 }
 /** Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`. */
 export declare const GuardianFactorNameEnum: {
@@ -21703,6 +21798,17 @@ export declare const GuardianFactorPhoneFactorMessageTypeEnum: {
     readonly Voice: "voice";
 };
 export type GuardianFactorPhoneFactorMessageTypeEnum = (typeof GuardianFactorPhoneFactorMessageTypeEnum)[keyof typeof GuardianFactorPhoneFactorMessageTypeEnum];
+/**
+ * Factor-specific settings. Only returned when include_settings=true.
+ */
+export interface GuardianFactorSettings {
+    /** The length of the OTP code. */
+    otp_length?: number | undefined;
+    /** The OTP expiration time in seconds. */
+    otp_expiration_time?: number | undefined;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
 export declare const GuardianFactorsProviderPushNotificationProviderDataEnum: {
     readonly Guardian: "guardian";
     readonly Sns: "sns";
@@ -22036,6 +22142,11 @@ export interface ListAculsResponseContentItem {
     /** Accepts any additional properties */
     [key: string]: any;
 }
+export interface ListAgentsResponseContent {
+    agents: Management.AgentResponseContent[];
+    /** A cursor to be used as the "from" query parameter for the next page of results. Omitted when there are no further results. */
+    next?: string | undefined;
+}
 export interface ListBrandingPhoneProvidersResponseContent {
     providers?: Management.PhoneProviderSchemaMasked[] | undefined;
 }
@@ -22098,6 +22209,12 @@ export interface ListEncryptionKeyOffsetPaginatedResponseContent {
     /** Encryption keys. */
     keys?: Management.EncryptionKey[] | undefined;
 }
+export interface ListEventStreamDeliveriesResponseContent {
+    /** List of event stream deliveries */
+    deliveries: Management.EventStreamDelivery[];
+    /** The cursor to be used as the "from" query parameter for the next page of results. */
+    next?: string | undefined;
+}
 export interface ListEventStreamsResponseContent {
     eventStreams?: Management.EventStreamResponseContent[] | undefined;
     /** Opaque identifier for use with the <i>from</i> query parameter for the next page of results. */
@@ -22177,6 +22294,12 @@ export interface ListOrganizationClientGrantsOffsetPaginatedResponseContent {
     total?: number | undefined;
     client_grants?: Management.OrganizationClientGrant[] | undefined;
 }
+export interface ListOrganizationClientsResponseContent {
+    /** The list of clients associated with the organization. */
+    clients: Management.OrganizationClient[];
+    /** An opaque token that, when present, can be passed as the `from` query parameter to retrieve the next page of results. */
+    next?: string | undefined;
+}
 export interface ListOrganizationConnectionsOffsetPaginatedResponseContent {
     start?: number | undefined;
     limit?: number | undefined;
@@ -22224,6 +22347,14 @@ export interface ListOrganizationMembersPaginatedResponseContent {
     /** Accepts any additional properties */
     [key: string]: any;
 }
+/**
+ * Checkpoint paginated list of groups assigned to a role within an organization.
+ */
+export interface ListOrganizationRoleGroupsResponseContent {
+    groups: Management.RoleGroup[];
+    /** A cursor to be used as the "from" query parameter for the next page of results. */
+    next?: string | undefined;
+}
 export interface ListOrganizationRoleMembersResponseContent {
     /** List of members assigned to the role within the organization. */
     members: Management.RoleMember[];
@@ -23079,6 +23210,20 @@ export interface NetworkAclsResponseContent {
     /** Accepts any additional properties */
     [key: string]: any;
 }
+/**
+ * Not Found
+ */
+export interface NotFoundSchema {
+    message: string;
+    statusCode: string;
+    error: NotFoundSchema.Error_;
+}
+export declare namespace NotFoundSchema {
+    const Error_: {
+        readonly NotFound: "Not Found";
+    };
+    type Error_ = (typeof Error_)[keyof typeof Error_];
+}
 export interface Organization {
     /** Organization identifier. */
     id?: string | undefined;
@@ -23090,6 +23235,9 @@ export interface Organization {
     metadata?: Management.OrganizationMetadata | undefined;
     token_quota?: Management.TokenQuota | undefined;
     third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum | undefined;
+    /** Whether app entitlement is active for this organization. */
+    is_app_entitlement_active?: boolean | undefined;
+    client?: Management.OrganizationClientAssociation | undefined;
     /** Accepts any additional properties */
     [key: string]: any;
 }
@@ -23142,6 +23290,20 @@ export interface OrganizationBrandingColors {
     /** HEX Color for background. */
     page_background: string;
 }
+export interface OrganizationClient {
+    /** The identifier of the client associated with the organization. */
+    client_id: string;
+    /** Whether this client is used for member access to the organization. */
+    use_for_member_access: boolean;
+    client: Management.OrganizationClientMetadata;
+}
+/**
+ * The organization's association with the client passed in the <code>include_client_association_for</code> query parameter.
+ */
+export interface OrganizationClientAssociation {
+    /** Whether this client is used for member access to the organization. */
+    use_for_member_access?: boolean | undefined;
+}
 export interface OrganizationClientGrant {
     /** ID of the client grant. */
     id?: string | undefined;
@@ -23155,6 +23317,29 @@ export interface OrganizationClientGrant {
     /** If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations. */
     allow_any_organization?: boolean | undefined;
 }
+/**
+ * Metadata about the associated client.
+ */
+export interface OrganizationClientMetadata {
+    /** The name of the client. */
+    name?: string | undefined;
+    /** The type of the client application. */
+    app_type?: string | undefined;
+    /** The URI of the client logo. */
+    logo_uri?: (string | null) | undefined;
+    /** Whether this client is a first-party client (true) or not (false). */
+    is_first_party?: boolean | undefined;
+    /** The grant types enabled for the client. */
+    grant_types?: string[] | undefined;
+    organization_usage?: Management.OrganizationClientMetadataOrganizationUsageEnum | undefined;
+}
+/** Whether organizations may be used with the client. */
+export declare const OrganizationClientMetadataOrganizationUsageEnum: {
+    readonly Deny: "deny";
+    readonly Allow: "allow";
+    readonly Require: "require";
+};
+export type OrganizationClientMetadataOrganizationUsageEnum = (typeof OrganizationClientMetadataOrganizationUsageEnum)[keyof typeof OrganizationClientMetadataOrganizationUsageEnum];
 export interface OrganizationConnection {
     /** ID of the connection. */
     connection_id?: string | undefined;
@@ -24033,6 +24218,32 @@ export interface Role {
     name?: string | undefined;
     /** Description of this role. */
     description?: string | undefined;
+    type?: Management.RoleTypeEnum | undefined;
+    /** The id of the entity that owns this role, such as an organization id. */
+    owner_id?: string | undefined;
+}
+/**
+ * A group assigned to a role in the context of an organization.
+ */
+export interface RoleGroup {
+    /** Unique identifier for the group (service-generated). */
+    id: string;
+    /** Name of the group. Must be unique within its connection. Must contain between 1 and 128 printable ASCII characters. */
+    name: string;
+    /** External identifier for the group, often used for SCIM synchronization. Max length of 256 characters. */
+    external_id?: string | undefined;
+    /** Identifier for the connection this group belongs to (if a connection group). */
+    connection_id?: string | undefined;
+    /** Identifier for the organization this group belongs to (if an organization group). */
+    organization_id?: (string | null) | undefined;
+    /** Identifier for the tenant this group belongs to. */
+    tenant_name?: string | undefined;
+    /** Description of the group. */
+    description?: (string | null) | undefined;
+    /** Timestamp of when the group was created. */
+    created_at?: string | undefined;
+    /** Timestamp of when the group was last updated. */
+    updated_at?: string | undefined;
 }
 export interface RoleMember {
     /** ID of this user. */
@@ -24044,6 +24255,12 @@ export interface RoleMember {
     /** Email address of this user. */
     email?: string | undefined;
 }
+/** The type of the role */
+export declare const RoleTypeEnum: {
+    readonly Tenant: "tenant";
+    readonly Organization: "organization";
+};
+export type RoleTypeEnum = (typeof RoleTypeEnum)[keyof typeof RoleTypeEnum];
 export interface RoleUser {
     /** ID of this user. */
     user_id?: string | undefined;
@@ -24509,6 +24726,8 @@ export interface SelfServiceProfileSsoTicketEnabledOrganization {
 export interface SelfServiceProfileSsoTicketGoogleWorkspaceConfig {
     /** Whether to enable Google Workspace Directory Sync for users during the self-service flow. */
     sync_users: boolean;
+    /** Whether to enable Google Workspace Directory Sync for groups during the self-service flow. */
+    sync_groups?: boolean | undefined;
 }
 /** The protocol used to connect to the the default application */
 export declare const SelfServiceProfileSsoTicketIdpInitiatedClientProtocolEnum: {
@@ -25052,6 +25271,16 @@ export type SynchronizeGroupsEnum = (typeof SynchronizeGroupsEnum)[keyof typeof
 export interface SynchronizedGroupPayload {
     /** Google Workspace Directory group ID. */
     id: string;
+    /** Google Workspace Directory group name. */
+    name?: string | undefined;
+    /** Google Workspace Directory group email. */
+    email?: string | undefined;
+    /** Number of direct members in the Google Workspace Directory group. */
+    direct_members_count?: number | undefined;
+}
+export interface SynchronizedGroupSelectionId {
+    /** Google Workspace Directory group ID. */
+    id: string;
 }
 /**
  * Settings related to OIDC RP-initiated Logout
@@ -26425,6 +26654,13 @@ export interface UpdateOrganizationAllConnectionResponseContent {
     connection_id: string;
     connection?: Management.OrganizationConnectionInformation | undefined;
 }
+export interface UpdateOrganizationClientResponseContent {
+    /** The identifier of the client associated with the organization. */
+    client_id: string;
+    /** Whether this client is used for member access to the organization. */
+    use_for_member_access: boolean;
+    client?: Management.OrganizationClientMetadata | undefined;
+}
 export interface UpdateOrganizationConnectionResponseContent {
     /** ID of the connection. */
     connection_id?: string | undefined;
@@ -26460,6 +26696,9 @@ export interface UpdateOrganizationResponseContent {
     metadata?: Management.OrganizationMetadata | undefined;
     token_quota?: Management.TokenQuota | undefined;
     third_party_client_access?: Management.OrganizationThirdPartyClientAccessEnum | undefined;
+    /** Whether app entitlement is active for this organization. */
+    is_app_entitlement_active?: boolean | undefined;
+    client?: Management.OrganizationClientAssociation | undefined;
     /** Accepts any additional properties */
     [key: string]: any;
 }
@@ -26560,6 +26799,9 @@ export interface UpdateRoleResponseContent {
     name?: string | undefined;
     /** Description of this role. */
     description?: string | undefined;
+    type?: Management.RoleTypeEnum | undefined;
+    /** The id of the entity that owns this role, such as an organization id. */
+    owner_id?: string | undefined;
 }
 export interface UpdateRuleResponseContent {
     /** Name of this rule. */
@@ -27059,6 +27301,9 @@ export interface UserEffectivePermissionRoleSourceResponseContent {
     name?: string | undefined;
     /** Description of this role. */
     description?: string | undefined;
+    type?: Management.RoleTypeEnum | undefined;
+    /** The id of the entity that owns this role, such as an organization id. */
+    owner_id?: string | undefined;
     /** List of sources where this role is coming from. */
     sources?: Management.UserEffectivePermissionRoleSourceEnum[] | undefined;
 }