auth0 4.28.0 → 4.30.0

package/dist/esm/management/__generated/models/index.d.ts

@@ -103,10 +103,10 @@ export interface Client {
      */
     client_secret: string;
     /**
-     * Type of client used to determine which settings are applicable. Can be `spa`, `native`, `non_interactive`, or `regular_web`.
+     * The type of application this client represents
      *
      */
-    app_type: string;
+    app_type: ClientAppTypeEnum;
     /**
      * URL of the logo to display for this client. Recommended size is 150x150 pixels.
      *
@@ -286,6 +286,34 @@ export interface Client {
      */
     token_quota: TokenQuota;
 }
+export declare const ClientAppTypeEnum: {
+    readonly native: "native";
+    readonly spa: "spa";
+    readonly regular_web: "regular_web";
+    readonly non_interactive: "non_interactive";
+    readonly resource_server: "resource_server";
+    readonly express_configuration: "express_configuration";
+    readonly rms: "rms";
+    readonly box: "box";
+    readonly cloudbees: "cloudbees";
+    readonly concur: "concur";
+    readonly dropbox: "dropbox";
+    readonly mscrm: "mscrm";
+    readonly echosign: "echosign";
+    readonly egnyte: "egnyte";
+    readonly newrelic: "newrelic";
+    readonly office365: "office365";
+    readonly salesforce: "salesforce";
+    readonly sentry: "sentry";
+    readonly sharepoint: "sharepoint";
+    readonly slack: "slack";
+    readonly springcm: "springcm";
+    readonly zendesk: "zendesk";
+    readonly zoom: "zoom";
+    readonly sso_integration: "sso_integration";
+    readonly oag: "oag";
+};
+export type ClientAppTypeEnum = (typeof ClientAppTypeEnum)[keyof typeof ClientAppTypeEnum];
 export declare const ClientTokenEndpointAuthMethodEnum: {
     readonly none: "none";
     readonly client_secret_post: "client_secret_post";
@@ -1064,7 +1092,7 @@ export interface ClientCreate {
      */
     token_endpoint_auth_method?: ClientCreateTokenEndpointAuthMethodEnum;
     /**
-     * Type of client used to determine which settings are applicable. Can be `spa`, `native`, `non_interactive`, or `regular_web`.
+     * The type of application this client represents
      *
      */
     app_type?: ClientCreateAppTypeEnum;
@@ -1190,6 +1218,11 @@ export interface ClientCreate {
     /**
      */
     token_quota?: CreateTokenQuota;
+    /**
+     * The identifier of the resource server that this client is linked to.
+     *
+     */
+    resource_server_identifier?: string;
 }
 export declare const ClientCreateTokenEndpointAuthMethodEnum: {
     readonly none: "none";
@@ -1202,6 +1235,7 @@ export declare const ClientCreateAppTypeEnum: {
     readonly spa: "spa";
     readonly regular_web: "regular_web";
     readonly non_interactive: "non_interactive";
+    readonly resource_server: "resource_server";
     readonly rms: "rms";
     readonly box: "box";
     readonly cloudbees: "cloudbees";
@@ -2199,6 +2233,14 @@ export interface ClientGrant {
      *
      */
     allow_any_organization: boolean;
+    /**
+     */
+    subject_type?: ClientGrantSubjectTypeEnum;
+    /**
+     * Types of authorization_details allowed for this client grant.
+     *
+     */
+    authorization_details_types?: Array<string>;
 }
 export declare const ClientGrantOrganizationUsageEnum: {
     readonly deny: "deny";
@@ -2206,6 +2248,11 @@ export declare const ClientGrantOrganizationUsageEnum: {
     readonly require: "require";
 };
 export type ClientGrantOrganizationUsageEnum = (typeof ClientGrantOrganizationUsageEnum)[keyof typeof ClientGrantOrganizationUsageEnum];
+export declare const ClientGrantSubjectTypeEnum: {
+    readonly client: "client";
+    readonly user: "user";
+};
+export type ClientGrantSubjectTypeEnum = (typeof ClientGrantSubjectTypeEnum)[keyof typeof ClientGrantSubjectTypeEnum];
 /**
  *
  */
@@ -2235,6 +2282,14 @@ export interface ClientGrantCreate {
      *
      */
     scope: Array<string>;
+    /**
+     */
+    subject_type?: ClientGrantCreateSubjectTypeEnum;
+    /**
+     * Types of authorization_details allowed for this client grant.
+     *
+     */
+    authorization_details_types?: Array<string>;
 }
 export declare const ClientGrantCreateOrganizationUsageEnum: {
     readonly deny: "deny";
@@ -2242,6 +2297,11 @@ export declare const ClientGrantCreateOrganizationUsageEnum: {
     readonly require: "require";
 };
 export type ClientGrantCreateOrganizationUsageEnum = (typeof ClientGrantCreateOrganizationUsageEnum)[keyof typeof ClientGrantCreateOrganizationUsageEnum];
+export declare const ClientGrantCreateSubjectTypeEnum: {
+    readonly client: "client";
+    readonly user: "user";
+};
+export type ClientGrantCreateSubjectTypeEnum = (typeof ClientGrantCreateSubjectTypeEnum)[keyof typeof ClientGrantCreateSubjectTypeEnum];
 /**
  * Configuration related to JWTs for the client.
  */
@@ -2718,6 +2778,7 @@ export declare const ClientUpdateAppTypeEnum: {
     readonly spa: "spa";
     readonly regular_web: "regular_web";
     readonly non_interactive: "non_interactive";
+    readonly resource_server: "resource_server";
     readonly rms: "rms";
     readonly box: "box";
     readonly cloudbees: "cloudbees";
@@ -4257,7 +4318,7 @@ export type EmailProviderUpdateCredentials = any;
  */
 export interface EmailTemplateUpdate {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     template: EmailTemplateUpdateTemplateEnum;
@@ -4306,6 +4367,7 @@ export declare const EmailTemplateUpdateTemplateEnum: {
     readonly verify_email: "verify_email";
     readonly verify_email_by_code: "verify_email_by_code";
     readonly reset_email: "reset_email";
+    readonly reset_email_by_code: "reset_email_by_code";
     readonly welcome_email: "welcome_email";
     readonly blocked_account: "blocked_account";
     readonly stolen_credentials: "stolen_credentials";
@@ -4314,6 +4376,7 @@ export declare const EmailTemplateUpdateTemplateEnum: {
     readonly user_invitation: "user_invitation";
     readonly change_password: "change_password";
     readonly password_reset: "password_reset";
+    readonly async_approval: "async_approval";
 };
 export type EmailTemplateUpdateTemplateEnum = (typeof EmailTemplateUpdateTemplateEnum)[keyof typeof EmailTemplateUpdateTemplateEnum];
 /**
@@ -5575,6 +5638,70 @@ export interface GetClientConnections200Response {
      */
     next?: string;
 }
+/**
+ *
+ */
+export type GetClientGrantOrganizations200Response = Array<GetClientGrantOrganizations200ResponseOneOfInner> | GetClientGrantOrganizations200ResponseOneOf | GetClientGrantOrganizations200ResponseOneOf1;
+/**
+ *
+ */
+export interface GetClientGrantOrganizations200ResponseOneOf {
+    /**
+     */
+    start?: number;
+    /**
+     */
+    limit?: number;
+    /**
+     */
+    total?: number;
+    /**
+     */
+    organizations?: Array<GetClientGrantOrganizations200ResponseOneOfInner>;
+}
+/**
+ *
+ */
+export interface GetClientGrantOrganizations200ResponseOneOf1 {
+    /**
+     * Opaque identifier for use with the <i>from</i> query parameter for the next page of results.<br/>This identifier is valid for 24 hours.
+     *
+     */
+    next?: string;
+    /**
+     */
+    organizations?: Array<GetClientGrantOrganizations200ResponseOneOfInner>;
+}
+/**
+ *
+ */
+export interface GetClientGrantOrganizations200ResponseOneOfInner {
+    [key: string]: any | any;
+    /**
+     * Organization identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of this organization.
+     *
+     */
+    name?: string;
+    /**
+     * Friendly name of this organization.
+     *
+     */
+    display_name?: string;
+    /**
+     */
+    branding?: OrganizationBranding;
+    /**
+     */
+    metadata?: OrganizationMetadata;
+    /**
+     */
+    token_quota?: TokenQuota;
+}
 /**
  *
  */
@@ -5867,7 +5994,7 @@ export interface GetDeviceCredentials200ResponseOneOf {
  */
 export interface GetEmailTemplatesByTemplateName200Response {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     template: GetEmailTemplatesByTemplateName200ResponseTemplateEnum;
@@ -5925,6 +6052,7 @@ export declare const GetEmailTemplatesByTemplateName200ResponseTemplateEnum: {
     readonly user_invitation: "user_invitation";
     readonly change_password: "change_password";
     readonly password_reset: "password_reset";
+    readonly async_approval: "async_approval";
 };
 export type GetEmailTemplatesByTemplateName200ResponseTemplateEnum = (typeof GetEmailTemplatesByTemplateName200ResponseTemplateEnum)[keyof typeof GetEmailTemplatesByTemplateName200ResponseTemplateEnum];
 /**
@@ -9637,6 +9765,40 @@ export interface LogLocationInfo {
      */
     continent_code: string;
 }
+/**
+ * Theme defines how to style the login pages.
+ */
+export interface OrganizationBranding {
+    /**
+     * URL of logo to display on login page.
+     *
+     */
+    logo_url?: string;
+    /**
+     */
+    colors?: OrganizationBrandingColors;
+}
+/**
+ * Color scheme used to customize the login pages.
+ */
+export interface OrganizationBrandingColors {
+    /**
+     * HEX Color for primary elements.
+     *
+     */
+    primary: string;
+    /**
+     * HEX Color for background.
+     *
+     */
+    page_background: string;
+}
+/**
+ * Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
+ */
+export interface OrganizationMetadata {
+    [key: string]: any;
+}
 /**
  *
  */
@@ -9964,6 +10126,11 @@ export interface PatchClientGrantsByIdRequest {
      *
      */
     allow_any_organization?: boolean | null;
+    /**
+     * Types of authorization_details allowed for this client grant.
+     *
+     */
+    authorization_details_types?: Array<string>;
 }
 export declare const PatchClientGrantsByIdRequestOrganizationUsageEnum: {
     readonly deny: "deny";
@@ -10036,7 +10203,7 @@ export type PatchCustomDomainsByIdRequestCustomClientIpHeaderEnum = (typeof Patc
  */
 export interface PatchEmailTemplatesByTemplateNameRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     template?: PatchEmailTemplatesByTemplateNameRequestTemplateEnum;
@@ -10094,6 +10261,7 @@ export declare const PatchEmailTemplatesByTemplateNameRequestTemplateEnum: {
     readonly user_invitation: "user_invitation";
     readonly change_password: "change_password";
     readonly password_reset: "password_reset";
+    readonly async_approval: "async_approval";
 };
 export type PatchEmailTemplatesByTemplateNameRequestTemplateEnum = (typeof PatchEmailTemplatesByTemplateNameRequestTemplateEnum)[keyof typeof PatchEmailTemplatesByTemplateNameRequestTemplateEnum];
 /**
@@ -11692,7 +11860,7 @@ export interface PostDeviceCredentials201Response {
  */
 export interface PostEmailTemplatesRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     template: PostEmailTemplatesRequestTemplateEnum;
@@ -11750,6 +11918,7 @@ export declare const PostEmailTemplatesRequestTemplateEnum: {
     readonly user_invitation: "user_invitation";
     readonly change_password: "change_password";
     readonly password_reset: "password_reset";
+    readonly async_approval: "async_approval";
 };
 export type PostEmailTemplatesRequestTemplateEnum = (typeof PostEmailTemplatesRequestTemplateEnum)[keyof typeof PostEmailTemplatesRequestTemplateEnum];
 /**
@@ -15692,6 +15861,14 @@ export interface ResourceServer {
     /**
      */
     proof_of_possession: ResourceServerProofOfPossession | null;
+    /**
+     */
+    subject_type_authorization?: ResourceServerSubjectTypeAuthorization;
+    /**
+     * The client ID of the client that this resource server is linked to
+     *
+     */
+    client_id?: string;
 }
 export declare const ResourceServerSigningAlgEnum: {
     readonly HS256: "HS256";
@@ -15780,6 +15957,9 @@ export interface ResourceServerCreate {
     /**
      */
     proof_of_possession?: ResourceServerProofOfPossession | null;
+    /**
+     */
+    subject_type_authorization?: ResourceServerSubjectTypeAuthorization;
 }
 export declare const ResourceServerCreateSigningAlgEnum: {
     readonly HS256: "HS256";
@@ -15819,6 +15999,50 @@ export declare const ResourceServerProofOfPossessionMechanismEnum: {
     readonly dpop: "dpop";
 };
 export type ResourceServerProofOfPossessionMechanismEnum = (typeof ResourceServerProofOfPossessionMechanismEnum)[keyof typeof ResourceServerProofOfPossessionMechanismEnum];
+/**
+ * Defines application permission access for a resource server
+ */
+export interface ResourceServerSubjectTypeAuthorization {
+    /**
+     */
+    user?: ResourceServerSubjectTypeAuthorizationUser;
+    /**
+     */
+    client?: ResourceServerSubjectTypeAuthorizationClient;
+}
+/**
+ * Access Permissions for client-initiated flows
+ */
+export interface ResourceServerSubjectTypeAuthorizationClient {
+    [key: string]: any | any;
+    /**
+     * Defines the client flows policy for the resource server
+     *
+     */
+    policy?: ResourceServerSubjectTypeAuthorizationClientPolicyEnum;
+}
+export declare const ResourceServerSubjectTypeAuthorizationClientPolicyEnum: {
+    readonly deny_all: "deny_all";
+    readonly require_client_grant: "require_client_grant";
+};
+export type ResourceServerSubjectTypeAuthorizationClientPolicyEnum = (typeof ResourceServerSubjectTypeAuthorizationClientPolicyEnum)[keyof typeof ResourceServerSubjectTypeAuthorizationClientPolicyEnum];
+/**
+ * Access Permissions for user-initiated flows
+ */
+export interface ResourceServerSubjectTypeAuthorizationUser {
+    [key: string]: any | any;
+    /**
+     * Defines the user flows policy for the resource server
+     *
+     */
+    policy?: ResourceServerSubjectTypeAuthorizationUserPolicyEnum;
+}
+export declare const ResourceServerSubjectTypeAuthorizationUserPolicyEnum: {
+    readonly allow_all: "allow_all";
+    readonly deny_all: "deny_all";
+    readonly require_client_grant: "require_client_grant";
+};
+export type ResourceServerSubjectTypeAuthorizationUserPolicyEnum = (typeof ResourceServerSubjectTypeAuthorizationUserPolicyEnum)[keyof typeof ResourceServerSubjectTypeAuthorizationUserPolicyEnum];
 /**
  *
  */
@@ -15931,6 +16155,9 @@ export interface ResourceServerUpdate {
     /**
      */
     proof_of_possession?: ResourceServerProofOfPossession | null;
+    /**
+     */
+    subject_type_authorization?: ResourceServerSubjectTypeAuthorization;
 }
 export declare const ResourceServerUpdateSigningAlgEnum: {
     readonly HS256: "HS256";
@@ -18340,6 +18567,56 @@ export interface DeleteClientGrantsByIdRequest {
      */
     id: string;
 }
+/**
+ *
+ */
+export interface GetClientGrantOrganizationsRequest {
+    /**
+     * ID of the client grant
+     *
+     */
+    id: string;
+    /**
+     * Page index of the results to return. First page is 0.
+     *
+     */
+    page?: number;
+    /**
+     * Number of results per page. Defaults to 50.
+     *
+     */
+    per_page?: number;
+    /**
+     * Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
+     *
+     */
+    include_totals?: boolean;
+    /**
+     * Optional Id from which to start selection.
+     *
+     */
+    from?: string;
+    /**
+     * Number of results per page. Defaults to 50.
+     *
+     */
+    take?: number;
+}
+/**
+ *
+ */
+export declare const GetClientGrantsAllowAnyOrganizationEnum: {
+    readonly true: true;
+};
+export type GetClientGrantsAllowAnyOrganizationEnum = (typeof GetClientGrantsAllowAnyOrganizationEnum)[keyof typeof GetClientGrantsAllowAnyOrganizationEnum];
+/**
+ *
+ */
+export declare const GetClientGrantsSubjectTypeEnum: {
+    readonly client: "client";
+    readonly user: "user";
+};
+export type GetClientGrantsSubjectTypeEnum = (typeof GetClientGrantsSubjectTypeEnum)[keyof typeof GetClientGrantsSubjectTypeEnum];
 /**
  *
  */
@@ -18359,6 +18636,16 @@ export interface GetClientGrantsRequest {
      *
      */
     include_totals?: boolean;
+    /**
+     * Optional Id from which to start selection.
+     *
+     */
+    from?: string;
+    /**
+     * Number of results per page. Defaults to 50.
+     *
+     */
+    take?: number;
     /**
      * Optional filter on audience.
      *
@@ -18369,6 +18656,16 @@ export interface GetClientGrantsRequest {
      *
      */
     client_id?: string;
+    /**
+     * Optional filter on allow_any_organization.
+     *
+     */
+    allow_any_organization?: GetClientGrantsAllowAnyOrganizationEnum;
+    /**
+     * The subject type for this grant.
+     *
+     */
+    subject_type?: GetClientGrantsSubjectTypeEnum;
 }
 /**
  *
@@ -19130,6 +19427,7 @@ export declare const GetEmailTemplatesByTemplateNameTemplateNameEnum: {
     readonly user_invitation: "user_invitation";
     readonly change_password: "change_password";
     readonly password_reset: "password_reset";
+    readonly async_approval: "async_approval";
 };
 export type GetEmailTemplatesByTemplateNameTemplateNameEnum = (typeof GetEmailTemplatesByTemplateNameTemplateNameEnum)[keyof typeof GetEmailTemplatesByTemplateNameTemplateNameEnum];
 /**
@@ -19137,7 +19435,7 @@ export type GetEmailTemplatesByTemplateNameTemplateNameEnum = (typeof GetEmailTe
  */
 export interface GetEmailTemplatesByTemplateNameRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     templateName: GetEmailTemplatesByTemplateNameTemplateNameEnum;
@@ -19158,6 +19456,7 @@ export declare const PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum:
     readonly user_invitation: "user_invitation";
     readonly change_password: "change_password";
     readonly password_reset: "password_reset";
+    readonly async_approval: "async_approval";
 };
 export type PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum = (typeof PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum)[keyof typeof PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum];
 /**
@@ -19165,7 +19464,7 @@ export type PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum = (typeof
  */
 export interface PatchEmailTemplatesByTemplateNameOperationRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     templateName: PatchEmailTemplatesByTemplateNameOperationTemplateNameEnum;
@@ -19186,6 +19485,7 @@ export declare const PutEmailTemplatesByTemplateNameTemplateNameEnum: {
     readonly user_invitation: "user_invitation";
     readonly change_password: "change_password";
     readonly password_reset: "password_reset";
+    readonly async_approval: "async_approval";
 };
 export type PutEmailTemplatesByTemplateNameTemplateNameEnum = (typeof PutEmailTemplatesByTemplateNameTemplateNameEnum)[keyof typeof PutEmailTemplatesByTemplateNameTemplateNameEnum];
 /**
@@ -19193,7 +19493,7 @@ export type PutEmailTemplatesByTemplateNameTemplateNameEnum = (typeof PutEmailTe
  */
 export interface PutEmailTemplatesByTemplateNameRequest {
     /**
-     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `change_password` (legacy), or `password_reset` (legacy).
+     * Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
      *
      */
     templateName: PutEmailTemplatesByTemplateNameTemplateNameEnum;