auth0 4.29.0 → 4.31.0

package/dist/cjs/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";
@@ -2744,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";
@@ -3889,6 +3924,43 @@ export interface CreateTokenQuota {
      */
     client_credentials: TokenQuotaClientCredentials;
 }
+/**
+ *
+ */
+export interface CreateUserAttributeProfileRequestContent {
+    /**
+     * The name of the user attribute profile.
+     *
+     */
+    name: string;
+    /**
+     */
+    user_id?: UserAttributeProfileUserId;
+    /**
+     */
+    user_attributes: UserAttributeProfileUserAttributes;
+}
+/**
+ *
+ */
+export interface CreateUserAttributeProfileResponseContent {
+    /**
+     * User Attribute Profile identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of the user attribute profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    user_id?: UserAttributeProfileUserId;
+    /**
+     */
+    user_attributes?: UserAttributeProfileUserAttributes;
+}
 /**
  *
  */
@@ -9163,6 +9235,45 @@ export interface GetUniversalLogin200ResponseOneOf {
      */
     body: string;
 }
+/**
+ *
+ */
+export interface GetUserAttributeProfileResponseContent {
+    /**
+     * User Attribute Profile identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of the user attribute profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    user_id?: UserAttributeProfileUserId;
+    /**
+     */
+    user_attributes?: UserAttributeProfileUserAttributes;
+}
+/**
+ *
+ */
+export interface GetUserAttributeProfileTemplateResponseContent {
+    /**
+     * The id of the template.
+     *
+     */
+    id?: string;
+    /**
+     * The user-friendly name of the template displayed in the UI.
+     *
+     */
+    display_name?: string;
+    /**
+     */
+    template?: UserAttributeProfileTemplate;
+}
 /**
  *
  */
@@ -9574,6 +9685,27 @@ export interface ListPhoneTemplatesResponseContent {
      */
     templates?: Array<PhoneTemplate>;
 }
+/**
+ *
+ */
+export interface ListUserAttributeProfileTemplateResponseContent {
+    /**
+     */
+    user_attribute_profile_templates?: Array<UserAttributeProfileTemplateItem>;
+}
+/**
+ *
+ */
+export interface ListUserAttributeProfilesPaginatedResponseContent {
+    /**
+     * A cursor to be used as the "from" query parameter for the next page of results.
+     *
+     */
+    next?: string;
+    /**
+     */
+    user_attribute_profiles?: Array<UserAttributeProfile>;
+}
 /**
  *
  */
@@ -14849,6 +14981,9 @@ export interface PostSsoTicketRequest {
     /**
      */
     domain_aliases_config?: PostSsoTicketRequestDomainAliasesConfig;
+    /**
+     */
+    provisioning_config?: PostSsoTicketRequestProvisioningConfig;
 }
 /**
  * If provided, this will create a new connection for the SSO flow with the given configuration
@@ -14970,6 +15105,29 @@ export interface PostSsoTicketRequestEnabledOrganizationsInner {
      */
     show_as_button?: boolean;
 }
+/**
+ * Configuration for the setup of Provisioning in the self-service flow.
+ */
+export interface PostSsoTicketRequestProvisioningConfig {
+    /**
+     * The scopes of the SCIM tokens generated during the self-service flow.
+     *
+     */
+    scopes: Array<PostSsoTicketRequestProvisioningConfigScopesEnum>;
+    /**
+     * Lifetime of the tokens in seconds. Must be greater than 900. If not provided, the tokens don't expire.
+     *
+     */
+    token_lifetime?: number | null;
+}
+export declare const PostSsoTicketRequestProvisioningConfigScopesEnum: {
+    readonly getusers: "get:users";
+    readonly postusers: "post:users";
+    readonly putusers: "put:users";
+    readonly patchusers: "patch:users";
+    readonly deleteusers: "delete:users";
+};
+export type PostSsoTicketRequestProvisioningConfigScopesEnum = (typeof PostSsoTicketRequestProvisioningConfigScopesEnum)[keyof typeof PostSsoTicketRequestProvisioningConfigScopesEnum];
 /**
  *
  */
@@ -15829,6 +15987,11 @@ export interface ResourceServer {
     /**
      */
     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";
@@ -16267,6 +16430,32 @@ export interface Scope {
      */
     description?: string;
 }
+/**
+ * Configuration for the setup of Provisioning in the self-service flow.
+ */
+export interface SelfServiceProfileSsoTicketProvisioningConfig {
+    /**
+     * The scopes of the SCIM tokens generated during the self-service flow.
+     *
+     */
+    scopes: Array<SelfServiceProfileSsoTicketProvisioningScopeEnum>;
+    /**
+     * Lifetime of the tokens in seconds. Must be greater than 900. If not provided, the tokens don't expire.
+     *
+     */
+    token_lifetime?: number | null;
+}
+/**
+ *
+ */
+export declare const SelfServiceProfileSsoTicketProvisioningScopeEnum: {
+    readonly getusers: "get:users";
+    readonly postusers: "post:users";
+    readonly putusers: "put:users";
+    readonly patchusers: "patch:users";
+    readonly deleteusers: "delete:users";
+};
+export type SelfServiceProfileSsoTicketProvisioningScopeEnum = (typeof SelfServiceProfileSsoTicketProvisioningScopeEnum)[keyof typeof SelfServiceProfileSsoTicketProvisioningScopeEnum];
 /**
  *
  */
@@ -16354,6 +16543,11 @@ export interface SsProfile {
      *
      */
     allowed_strategies: Array<SsProfileAllowedStrategiesEnum>;
+    /**
+     * ID of the user-attribute-profile to associate with this self-service profile.
+     *
+     */
+    user_attribute_profile_id?: string;
 }
 export declare const SsProfileAllowedStrategiesEnum: {
     readonly oidc: "oidc";
@@ -16414,6 +16608,11 @@ export interface SsProfileCreate {
      *
      */
     allowed_strategies?: Array<SsProfileCreateAllowedStrategiesEnum>;
+    /**
+     * ID of the user-attribute-profile to associate with this self-service profile.
+     *
+     */
+    user_attribute_profile_id?: string;
 }
 export declare const SsProfileCreateAllowedStrategiesEnum: {
     readonly oidc: "oidc";
@@ -16465,6 +16664,11 @@ export interface SsProfileUpdate {
      *
      */
     allowed_strategies?: Array<SsProfileUpdateAllowedStrategiesEnum>;
+    /**
+     * ID of the user-attribute-profile to associate with this self-service profile.
+     *
+     */
+    user_attribute_profile_id?: string;
 }
 export declare const SsProfileUpdateAllowedStrategiesEnum: {
     readonly oidc: "oidc";
@@ -17745,6 +17949,297 @@ export interface UpdateTokenQuota {
      */
     client_credentials: TokenQuotaClientCredentials;
 }
+/**
+ *
+ */
+export interface UpdateUserAttributeProfileRequestContent {
+    /**
+     * The name of the user attribute profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    user_id?: UserAttributeProfilePatchUserId | null;
+    /**
+     */
+    user_attributes?: UserAttributeProfileUserAttributes;
+}
+/**
+ *
+ */
+export interface UpdateUserAttributeProfileResponseContent {
+    /**
+     * User Attribute Profile identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of the user attribute profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    user_id?: UserAttributeProfileUserId;
+    /**
+     */
+    user_attributes?: UserAttributeProfileUserAttributes;
+}
+/**
+ *
+ */
+export interface UserAttributeProfile {
+    /**
+     * User Attribute Profile identifier.
+     *
+     */
+    id?: string;
+    /**
+     * The name of the user attribute profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    user_id?: UserAttributeProfileUserId;
+    /**
+     */
+    user_attributes?: UserAttributeProfileUserAttributes;
+}
+/**
+ * OIDC mapping for this attribute
+ */
+export interface UserAttributeProfileOidcMapping {
+    /**
+     * OIDC mapping field
+     *
+     */
+    mapping: string;
+    /**
+     * Display name for the OIDC mapping
+     *
+     */
+    display_name?: string;
+}
+/**
+ *
+ */
+export type UserAttributeProfilePatchUserId = UserAttributeProfileUserId;
+/**
+ * SAML mapping override for this strategy
+ */
+export interface UserAttributeProfileSamlMapping extends Array<string> {
+}
+/**
+ * Strategy-specific overrides for this attribute
+ */
+export interface UserAttributeProfileStrategyOverrides {
+    /**
+     */
+    pingfederate?: UserAttributeProfileStrategyOverridesMapping;
+    /**
+     */
+    ad?: UserAttributeProfileStrategyOverridesMapping;
+    /**
+     */
+    adfs?: UserAttributeProfileStrategyOverridesMapping;
+    /**
+     */
+    waad?: UserAttributeProfileStrategyOverridesMapping;
+    /**
+     */
+    'google-apps'?: UserAttributeProfileStrategyOverridesMapping;
+    /**
+     */
+    okta?: UserAttributeProfileStrategyOverridesMapping;
+    /**
+     */
+    oidc?: UserAttributeProfileStrategyOverridesMapping;
+    /**
+     */
+    samlp?: UserAttributeProfileStrategyOverridesMapping;
+}
+/**
+ *
+ */
+export interface UserAttributeProfileStrategyOverridesMapping {
+    /**
+     */
+    oidc_mapping?: UserAttributeProfileOidcMapping;
+    /**
+     */
+    saml_mapping?: UserAttributeProfileSamlMapping;
+    /**
+     * SCIM mapping override for this strategy
+     *
+     */
+    scim_mapping?: string;
+}
+/**
+ * Strategy-specific overrides for user ID
+ */
+export interface UserAttributeProfileStrategyOverridesUserId {
+    /**
+     */
+    pingfederate?: UserAttributeProfileStrategyOverridesUserIdMapping;
+    /**
+     */
+    ad?: UserAttributeProfileStrategyOverridesUserIdMapping;
+    /**
+     */
+    adfs?: UserAttributeProfileStrategyOverridesUserIdMapping;
+    /**
+     */
+    waad?: UserAttributeProfileStrategyOverridesUserIdMapping;
+    /**
+     */
+    'google-apps'?: UserAttributeProfileStrategyOverridesUserIdMapping;
+    /**
+     */
+    okta?: UserAttributeProfileStrategyOverridesUserIdMapping;
+    /**
+     */
+    oidc?: UserAttributeProfileStrategyOverridesUserIdMapping;
+    /**
+     */
+    samlp?: UserAttributeProfileStrategyOverridesUserIdMapping;
+}
+/**
+ *
+ */
+export interface UserAttributeProfileStrategyOverridesUserIdMapping {
+    /**
+     */
+    oidc_mapping?: UserAttributeProfileUserIdOidcStrategyOverrideMapping;
+    /**
+     */
+    saml_mapping?: UserAttributeProfileSamlMapping;
+    /**
+     * SCIM mapping override for this strategy
+     *
+     */
+    scim_mapping?: string;
+}
+/**
+ * The structure of the template, which can be used as the payload for creating or updating a User Attribute Profile.
+ */
+export interface UserAttributeProfileTemplate {
+    /**
+     * The name of the user attribute profile.
+     *
+     */
+    name?: string;
+    /**
+     */
+    user_id?: UserAttributeProfileUserId;
+    /**
+     */
+    user_attributes?: UserAttributeProfileUserAttributes;
+}
+/**
+ *
+ */
+export interface UserAttributeProfileTemplateItem {
+    /**
+     * The id of the template.
+     *
+     */
+    id?: string;
+    /**
+     * The user-friendly name of the template displayed in the UI.
+     *
+     */
+    display_name?: string;
+    /**
+     */
+    template?: UserAttributeProfileTemplate;
+}
+/**
+ *
+ */
+export interface UserAttributeProfileUserAttributeAdditionalProperties {
+    /**
+     * Description of this attribute
+     *
+     */
+    description: string;
+    /**
+     * Display label for this attribute
+     *
+     */
+    label: string;
+    /**
+     * Whether this attribute is required in the profile
+     *
+     */
+    profile_required: boolean;
+    /**
+     * Auth0 mapping for this attribute
+     *
+     */
+    auth0_mapping: string;
+    /**
+     */
+    oidc_mapping?: UserAttributeProfileOidcMapping;
+    /**
+     */
+    saml_mapping?: UserAttributeProfileSamlMapping;
+    /**
+     * SCIM mapping for this attribute
+     *
+     */
+    scim_mapping?: string;
+    /**
+     */
+    strategy_overrides?: UserAttributeProfileStrategyOverrides;
+}
+/**
+ * User attributes configuration map. Keys are attribute names, values are the mapping configuration for each attribute.
+ */
+export interface UserAttributeProfileUserAttributes {
+    [key: string]: UserAttributeProfileUserAttributeAdditionalProperties;
+}
+/**
+ * User ID mapping configuration
+ */
+export interface UserAttributeProfileUserId {
+    /**
+     */
+    oidc_mapping?: UserAttributeProfileUserIdOidcMappingEnum;
+    /**
+     */
+    saml_mapping?: UserAttributeProfileUserIdSamlMapping;
+    /**
+     * SCIM mapping for user ID
+     *
+     */
+    scim_mapping?: string;
+    /**
+     */
+    strategy_overrides?: UserAttributeProfileStrategyOverridesUserId;
+}
+/**
+ * OIDC mapping for user ID
+ */
+export declare const UserAttributeProfileUserIdOidcMappingEnum: {
+    readonly sub: "sub";
+};
+export type UserAttributeProfileUserIdOidcMappingEnum = (typeof UserAttributeProfileUserIdOidcMappingEnum)[keyof typeof UserAttributeProfileUserIdOidcMappingEnum];
+/**
+ * OIDC mapping override for this strategy
+ */
+export declare const UserAttributeProfileUserIdOidcStrategyOverrideMapping: {
+    readonly sub: "sub";
+    readonly oid: "oid";
+    readonly email: "email";
+};
+export type UserAttributeProfileUserIdOidcStrategyOverrideMapping = (typeof UserAttributeProfileUserIdOidcStrategyOverrideMapping)[keyof typeof UserAttributeProfileUserIdOidcStrategyOverrideMapping];
+/**
+ * SAML mapping for user ID
+ */
+export interface UserAttributeProfileUserIdSamlMapping extends Array<string> {
+}
 /**
  *
  */
@@ -21918,6 +22413,61 @@ export interface PatchTokenExchangeProfilesByIdOperationRequest {
      */
     id: string;
 }
+/**
+ *
+ */
+export interface DeleteUserAttributeProfilesByIdRequest {
+    /**
+     * ID of the user-attribute-profile to delete.
+     *
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface GetUserAttributeProfileTemplateRequest {
+    /**
+     * ID of the user-attribute-profile-template to retrieve.
+     *
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface GetUserAttributeProfilesRequest {
+    /**
+     * Optional Id from which to start selection.
+     *
+     */
+    from?: string;
+    /**
+     * Number of results per page. Defaults to 5.
+     *
+     */
+    take?: number;
+}
+/**
+ *
+ */
+export interface GetUserAttributeProfilesByIdRequest {
+    /**
+     * ID of the user-attribute-profile to retrieve.
+     *
+     */
+    id: string;
+}
+/**
+ *
+ */
+export interface PatchUserAttributeProfilesByIdRequest {
+    /**
+     * ID of the user attribute profile to update.
+     *
+     */
+    id: string;
+}
 /**
  *
  */