Class ExtensionUserUser.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • isFederatedUser

        public ExtensionUserUser.Builder isFederatedUser​(Boolean isFederatedUser)
        A Boolean value indicating whether or not the user is federated.

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeName: Federated - idcsCsvAttributeNameMappings: [[columnHeaderName:Federated]] - idcsSearchable: true - multiValued: false - mutability: readWrite - idcsRequiresWriteForAccessFlows: true - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isFederatedUser - the value to set
        Returns:
        this builder
      • isAuthenticationDelegated

        public ExtensionUserUser.Builder isAuthenticationDelegated​(Boolean isAuthenticationDelegated)
        A Boolean value indicating whether or not authentication request by this user should be delegated to a remote app.

        This value should be true only when the User was originally synced from an app which is enabled for delegated authentication

        *Added In:** 17.4.6

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: immutable - required: false - returned: never - type: boolean - uniqueness: none

        Parameters:
        isAuthenticationDelegated - the value to set
        Returns:
        this builder
      • status

        public ExtensionUserUser.Builder status​(ExtensionUserUser.Status status)
        A supplemental status indicating the reason why a user is disabled

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

        Parameters:
        status - the value to set
        Returns:
        this builder
      • provider

        public ExtensionUserUser.Builder provider​(ExtensionUserUser.Provider provider)
        Registration provider

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        provider - the value to set
        Returns:
        this builder
      • preferredUiLandingPage

        public ExtensionUserUser.Builder preferredUiLandingPage​(ExtensionUserUser.PreferredUiLandingPage preferredUiLandingPage)
        User’s preferred landing page following login, logout and reset password.

        *Added In:** 2302092332

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        preferredUiLandingPage - the value to set
        Returns:
        this builder
      • creationMechanism

        public ExtensionUserUser.Builder creationMechanism​(ExtensionUserUser.CreationMechanism creationMechanism)
        User creation mechanism

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeNameMappings: [[defaultValue:import]] - idcsSearchable: true - multiValued: false - mutability: immutable - idcsRequiresWriteForAccessFlows: true - required: false - returned: request - type: string - uniqueness: none

        Parameters:
        creationMechanism - the value to set
        Returns:
        this builder
      • groupMembershipLastModified

        public ExtensionUserUser.Builder groupMembershipLastModified​(String groupMembershipLastModified)
        Specifies date time when a User’s group membership was last modified.

        *Added In:** 2304270343

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: dateTime - uniqueness: none

        Parameters:
        groupMembershipLastModified - the value to set
        Returns:
        this builder
      • doNotShowGettingStarted

        public ExtensionUserUser.Builder doNotShowGettingStarted​(Boolean doNotShowGettingStarted)
        A Boolean value indicating whether or not to hide the getting started page

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        doNotShowGettingStarted - the value to set
        Returns:
        this builder
      • bypassNotification

        public ExtensionUserUser.Builder bypassNotification​(Boolean bypassNotification)
        A Boolean value indicating whether or not to send email notification after creating the user.

        This attribute is not used in update/replace operations.

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeNameMappings: [[columnHeaderName:ByPass Notification]] - idcsSearchable: false - multiValued: false - mutability: immutable - idcsRequiresWriteForAccessFlows: true - required: false - returned: never - type: boolean - uniqueness: none

        Parameters:
        bypassNotification - the value to set
        Returns:
        this builder
      • isAccountRecoveryEnrolled

        public ExtensionUserUser.Builder isAccountRecoveryEnrolled​(Boolean isAccountRecoveryEnrolled)
        A Boolean value indicating whether or not a user is enrolled for account recovery

        *Added In:** 19.1.4

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: boolean - uniqueness: none

        Parameters:
        isAccountRecoveryEnrolled - the value to set
        Returns:
        this builder
      • accountRecoveryRequired

        public ExtensionUserUser.Builder accountRecoveryRequired​(Boolean accountRecoveryRequired)
        Boolean value to prompt user to setup account recovery during login.

        *Added In:** 19.1.4

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: request - type: boolean - uniqueness: none

        Parameters:
        accountRecoveryRequired - the value to set
        Returns:
        this builder
      • userFlowControlledByExternalClient

        public ExtensionUserUser.Builder userFlowControlledByExternalClient​(Boolean userFlowControlledByExternalClient)
        A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow.

        *Added In:** 18.4.2

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: immutable - required: false - returned: never - type: boolean - uniqueness: none

        Parameters:
        userFlowControlledByExternalClient - the value to set
        Returns:
        this builder
      • isGroupMembershipNormalized

        public ExtensionUserUser.Builder isGroupMembershipNormalized​(Boolean isGroupMembershipNormalized)
        A Boolean value indicating whether or not group membership is normalized for this user.

        *Deprecated Since: 19.3.3**

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: immutable - required: false - returned: never - type: boolean - uniqueness: none

        Parameters:
        isGroupMembershipNormalized - the value to set
        Returns:
        this builder
      • isGroupMembershipSyncedToUsersGroups

        public ExtensionUserUser.Builder isGroupMembershipSyncedToUsersGroups​(Boolean isGroupMembershipSyncedToUsersGroups)
        A Boolean value Indicates whether this User’s group membership has been sync’ed from Group.members to UsersGroups.

        *Added In:** 19.3.3

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: immutable - required: false - returned: never - type: boolean - uniqueness: none

        Parameters:
        isGroupMembershipSyncedToUsersGroups - the value to set
        Returns:
        this builder
      • notificationEmailTemplateId

        public ExtensionUserUser.Builder notificationEmailTemplateId​(String notificationEmailTemplateId)
        Specifies the EmailTemplate to be used when sending notification to the user this request is for.

        If specified, it overrides the default EmailTemplate for this event.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: writeOnly - required: false - returned: never - type: string - uniqueness: none

        Parameters:
        notificationEmailTemplateId - the value to set
        Returns:
        this builder
      • serviceUser

        public ExtensionUserUser.Builder serviceUser​(Boolean serviceUser)
        Indicates if User is a Service User

        *Added In:** 2306131901

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeName: Service User - idcsCsvAttributeNameMappings: [[columnHeaderName:Service User]] - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        serviceUser - the value to set
        Returns:
        this builder
      • supportAccounts

        public ExtensionUserUser.Builder supportAccounts​(List<UserExtSupportAccounts> supportAccounts)
        A list of Support Accounts corresponding to user.

        *Added In:** 2103141444

        *SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        supportAccounts - the value to set
        Returns:
        this builder
      • idcsAppRolesLimitedToGroups

        public ExtensionUserUser.Builder idcsAppRolesLimitedToGroups​(List<UserExtIdcsAppRolesLimitedToGroups> idcsAppRolesLimitedToGroups)
        Description:

        *Added In:** 19.2.1

        *SCIM++ Properties:** - idcsCompositeKey: [value, idcsAppRoleId] - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex

        Parameters:
        idcsAppRolesLimitedToGroups - the value to set
        Returns:
        this builder
      • accounts

        public ExtensionUserUser.Builder accounts​(List<UserExtAccounts> accounts)
        Accounts assigned to this User.

        Each value of this attribute refers to an app-specific identity that is owned by this User. Therefore, this attribute is a convenience that allows one to see on each User the Apps to which that User has access.

        *SCIM++ Properties:** - idcsPii: true - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        accounts - the value to set
        Returns:
        this builder
      • grants

        public ExtensionUserUser.Builder grants​(List<UserExtGrants> grants)
        Grants to this User.

        Each value of this attribute refers to a Grant to this User of some App (and optionally of some entitlement). Therefore, this attribute is a convenience that allows one to see on each User all of the Grants to that User.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        grants - the value to set
        Returns:
        this builder
      • appRoles

        public ExtensionUserUser.Builder appRoles​(List<UserExtAppRoles> appRoles)
        A list of all AppRoles to which this User belongs directly, indirectly or implicitly.

        The User could belong directly because the User is a member of the AppRole, could belong indirectly because the User is a member of a Group that is a member of the AppRole, or could belong implicitly because the AppRole is public.

        *SCIM++ Properties:** - idcsCompositeKey: [value] - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        appRoles - the value to set
        Returns:
        this builder