Package com.oracle.bmc.identitydomains.model

Class User.Builder

  • Enclosing class:
    User
    public static class User.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public User.Builder id​(String id)
        Unique identifier for the SCIM Resource as defined by the Service Provider.

        Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

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

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

      • ocid

        public User.Builder ocid​(String ocid)
        Unique OCI identifier for the SCIM Resource.

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

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

      • schemas

        public User.Builder schemas​(List<String> schemas)
        REQUIRED.

        The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

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

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

      • idcsPreventedOperations

        public User.Builder idcsPreventedOperations​(List<IdcsPreventedOperations> idcsPreventedOperations)
        Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

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

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

      • tags

        public User.Builder tags​(List<Tags> tags)
        A list of tags on this resource.

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

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

      • deleteInProgress

        public User.Builder deleteInProgress​(Boolean deleteInProgress)
        A boolean flag indicating this resource in the process of being deleted.

        Usually set to true when synchronous deletion of the resource would take too long.

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

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

      • idcsLastUpgradedInRelease

        public User.Builder idcsLastUpgradedInRelease​(String idcsLastUpgradedInRelease)
        The release number when the resource was upgraded.

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

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

      • domainOcid

        public User.Builder domainOcid​(String domainOcid)
        OCI Domain Id (ocid) in which the resource lives.

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

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

      • compartmentOcid

        public User.Builder compartmentOcid​(String compartmentOcid)
        OCI Compartment Id (ocid) in which the resource lives.

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

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

      • tenancyOcid

        public User.Builder tenancyOcid​(String tenancyOcid)
        OCI Tenant Id (ocid) in which the resource lives.

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

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

      • externalId

        public User.Builder externalId​(String externalId)
        An identifier for the Resource as defined by the Service Consumer.

        The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer’s tenant.

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeNameMappings: [[columnHeaderName:External Id]] - idcsPii: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

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

      • userName

        public User.Builder userName​(String userName)
        User name

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeName: User ID - idcsCsvAttributeNameMappings: [[columnHeaderName:User Name, deprecatedColumnHeaderName:User ID]] - idcsPii: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: always - type: string - uniqueness: global

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

      • description

        public User.Builder description​(String description)
        Description of the user

        *Added In:** 2012271618

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

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

      • displayName

        public User.Builder displayName​(String displayName)
        Display name

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeName: Display Name - idcsCsvAttributeNameMappings: [[columnHeaderName:Display Name]] - idcsPii: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

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

      • nickName

        public User.Builder nickName​(String nickName)
        Nick name

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeName: Nick Name - idcsCsvAttributeNameMappings: [[columnHeaderName:Nick Name]] - idcsPii: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

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

      • profileUrl

        public User.Builder profileUrl​(String profileUrl)
        A fully-qualified URL to a page representing the User’s online profile

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeName: Profile URL - idcsCsvAttributeNameMappings: [[columnHeaderName:Profile Url]] - idcsPii: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: reference - uniqueness: none

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

      • title

        public User.Builder title​(String title)
        Title

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

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

      • userType

        public User.Builder userType​(User.UserType userType)
        Used to identify the organization-to-user relationship

        *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeName: User Type - idcsCsvAttributeNameMappings: [[columnHeaderName:User Type]] - idcsPii: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

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

      • locale

        public User.Builder locale​(String locale)
        Used to indicate the User’s default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on.

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

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

      • preferredLanguage

        public User.Builder preferredLanguage​(String preferredLanguage)
        User’s preferred written or spoken language used for localized user interfaces

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

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

      • timezone

        public User.Builder timezone​(String timezone)
        User’s timezone

        *SCIM++ Properties:** - caseExact: false - idcsCanonicalValueSourceFilter: attrName eq "timezones" and attrValues.value eq "$(timezone)" - idcsCanonicalValueSourceResourceType: AllowedValue - idcsCsvAttributeName: TimeZone - idcsCsvAttributeNameMappings: [[columnHeaderName:Time Zone, deprecatedColumnHeaderName:TimeZone]] - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

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

      • active

        public User.Builder active​(Boolean active)
        User status

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

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

      • password

        public User.Builder password​(String password)
        Password attribute.

        Max length for password is controlled via Password Policy.

        *SCIM++ Properties:** - idcsCsvAttributeName: Password - idcsCsvAttributeNameMappings: [[columnHeaderName:Password]] - idcsPii: true - idcsSearchable: false - idcsSensitive: hash - multiValued: false - mutability: writeOnly - required: false - returned: never - type: string - uniqueness: none

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

      • emails

        public User.Builder emails​(List<UserEmails> emails)
        A complex attribute representing emails

        *SCIM++ Properties:** - idcsCompositeKey: [value, type] - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Email, mapsTo:emails[work].value], [columnHeaderName:Home Email, mapsTo:emails[home].value], [columnHeaderName:Primary Email Type, mapsTo:emails[$(type)].primary], [columnHeaderName:Other Email, mapsTo:emails[other].value], [columnHeaderName:Recovery Email, mapsTo:emails[recovery].value], [columnHeaderName:Work Email Verified, mapsTo:emails[work].verified], [columnHeaderName:Home Email Verified, mapsTo:emails[home].verified], [columnHeaderName:Other Email Verified, mapsTo:emails[other].verified], [columnHeaderName:Recovery Email Verified, mapsTo:emails[recovery].verified]] - idcsPii: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

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

      • phoneNumbers

        public User.Builder phoneNumbers​(List<UserPhoneNumbers> phoneNumbers)
        Phone numbers

        *SCIM++ Properties:** - idcsCompositeKey: [value, type] - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Phone, mapsTo:phoneNumbers[work].value], [columnHeaderName:Mobile No, mapsTo:phoneNumbers[mobile].value], [columnHeaderName:Home Phone, mapsTo:phoneNumbers[home].value], [columnHeaderName:Fax, mapsTo:phoneNumbers[fax].value], [columnHeaderName:Pager, mapsTo:phoneNumbers[pager].value], [columnHeaderName:Other Phone, mapsTo:phoneNumbers[other].value], [columnHeaderName:Recovery Phone, mapsTo:phoneNumbers[recovery].value], [columnHeaderName:Primary Phone Type, mapsTo:phoneNumbers[$(type)].primary]] - idcsPii: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

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

      • ims

        public User.Builder ims​(List<UserIms> ims)
        User’s instant messaging addresses

        *SCIM++ Properties:** - idcsCompositeKey: [value, type] - idcsPii: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

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

      • photos

        public User.Builder photos​(List<UserPhotos> photos)
        URLs of photos for the User

        *SCIM++ Properties:** - idcsCompositeKey: [value, type] - idcsPii: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

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

      • addresses

        public User.Builder addresses​(List<Addresses> addresses)
        A physical mailing address for this User, as described in (address Element).

        Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.

        *SCIM++ Properties:** - idcsCompositeKey: [type] - idcsCsvAttributeNameMappings: [[columnHeaderName:Work Address Street, deprecatedColumnHeaderName:Work Street Address, mapsTo:addresses[work].streetAddress], [columnHeaderName:Work Address Locality, deprecatedColumnHeaderName:Work City, mapsTo:addresses[work].locality], [columnHeaderName:Work Address Region, deprecatedColumnHeaderName:Work State, mapsTo:addresses[work].region], [columnHeaderName:Work Address Postal Code, deprecatedColumnHeaderName:Work Postal Code, mapsTo:addresses[work].postalCode], [columnHeaderName:Work Address Country, deprecatedColumnHeaderName:Work Country, mapsTo:addresses[work].country], [columnHeaderName:Work Address Formatted, mapsTo:addresses[work].formatted], [columnHeaderName:Home Address Formatted, mapsTo:addresses[home].formatted], [columnHeaderName:Other Address Formatted, mapsTo:addresses[other].formatted], [columnHeaderName:Home Address Street, mapsTo:addresses[home].streetAddress], [columnHeaderName:Other Address Street, mapsTo:addresses[other].streetAddress], [columnHeaderName:Home Address Locality, mapsTo:addresses[home].locality], [columnHeaderName:Other Address Locality, mapsTo:addresses[other].locality], [columnHeaderName:Home Address Region, mapsTo:addresses[home].region], [columnHeaderName:Other Address Region, mapsTo:addresses[other].region], [columnHeaderName:Home Address Country, mapsTo:addresses[home].country], [columnHeaderName:Other Address Country, mapsTo:addresses[other].country], [columnHeaderName:Home Address Postal Code, mapsTo:addresses[home].postalCode], [columnHeaderName:Other Address Postal Code, mapsTo:addresses[other].postalCode], [columnHeaderName:Primary Address Type, mapsTo:addresses[$(type)].primary]] - idcsPii: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

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

      • groups

        public User.Builder groups​(List<UserGroups> groups)
        A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated

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

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

      • entitlements

        public User.Builder entitlements​(List<UserEntitlements> entitlements)
        A list of entitlements for the User that represent a thing the User has.

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

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

      • roles

        public User.Builder roles​(List<UserRoles> roles)
        A list of roles for the User that collectively represent who the User is; e.g., ‘Student’, ‘Faculty’.

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

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

      • x509Certificates

        public User.Builder x509Certificates​(List<UserX509Certificates> x509Certificates)
        A list of certificates issued to the User.

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

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

      • urnIetfParamsScimSchemasExtensionEnterprise2_0User

        public User.Builder urnIetfParamsScimSchemasExtensionEnterprise2_0User​(ExtensionEnterprise20User urnIetfParamsScimSchemasExtensionEnterprise2_0User)

      • urnIetfParamsScimSchemasOracleIdcsExtensionUserUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionUserUser​(ExtensionUserUser urnIetfParamsScimSchemasOracleIdcsExtensionUserUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionPasswordStateUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionPasswordStateUser​(ExtensionPasswordStateUser urnIetfParamsScimSchemasOracleIdcsExtensionPasswordStateUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionUserStateUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionUserStateUser​(ExtensionUserStateUser urnIetfParamsScimSchemasOracleIdcsExtensionUserStateUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionPosixUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionPosixUser​(ExtensionPosixUser urnIetfParamsScimSchemasOracleIdcsExtensionPosixUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionKerberosUserUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionKerberosUserUser​(ExtensionKerberosUserUser urnIetfParamsScimSchemasOracleIdcsExtensionKerberosUserUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionMfaUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionMfaUser​(ExtensionMfaUser urnIetfParamsScimSchemasOracleIdcsExtensionMfaUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionAdaptiveUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionAdaptiveUser​(ExtensionAdaptiveUser urnIetfParamsScimSchemasOracleIdcsExtensionAdaptiveUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionSffUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionSffUser​(ExtensionSffUser urnIetfParamsScimSchemasOracleIdcsExtensionSffUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionSecurityQuestionsUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionSecurityQuestionsUser​(ExtensionSecurityQuestionsUser urnIetfParamsScimSchemasOracleIdcsExtensionSecurityQuestionsUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionSelfRegistrationUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionSelfRegistrationUser​(ExtensionSelfRegistrationUser urnIetfParamsScimSchemasOracleIdcsExtensionSelfRegistrationUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionSocialAccountUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionSocialAccountUser​(ExtensionSocialAccountUser urnIetfParamsScimSchemasOracleIdcsExtensionSocialAccountUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionDbUserUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionDbUserUser​(ExtensionDbUserUser urnIetfParamsScimSchemasOracleIdcsExtensionDbUserUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionTermsOfUseUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionTermsOfUseUser​(ExtensionTermsOfUseUser urnIetfParamsScimSchemasOracleIdcsExtensionTermsOfUseUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionPasswordlessUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionPasswordlessUser​(ExtensionPasswordlessUser urnIetfParamsScimSchemasOracleIdcsExtensionPasswordlessUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionOciTags

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionOciTags​(ExtensionOCITags urnIetfParamsScimSchemasOracleIdcsExtensionOciTags)

      • urnIetfParamsScimSchemasOracleIdcsExtensionUserCredentialsUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionUserCredentialsUser​(ExtensionUserCredentialsUser urnIetfParamsScimSchemasOracleIdcsExtensionUserCredentialsUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionCapabilitiesUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionCapabilitiesUser​(ExtensionCapabilitiesUser urnIetfParamsScimSchemasOracleIdcsExtensionCapabilitiesUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionDbCredentialsUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionDbCredentialsUser​(ExtensionDbCredentialsUser urnIetfParamsScimSchemasOracleIdcsExtensionDbCredentialsUser)

      • urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser

        public User.Builder urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser​(ExtensionSelfChangeUser urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser)

      • build

        public User build()