Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace User

User Account

Enumerations

Properties

Functions

Properties

Optional active

active: undefined | false | true

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

Optional addresses

addresses: Array<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

Optional compartmentOcid

compartmentOcid: undefined | string

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

Optional deleteInProgress

deleteInProgress: undefined | false | true

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

Optional description

description: undefined | string

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

Optional displayName

displayName: undefined | string

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

Optional domainOcid

domainOcid: undefined | string

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

Optional emails

emails: Array<UserEmails>

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

Optional entitlements

entitlements: Array<UserEntitlements>

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

Optional externalId

externalId: undefined | string

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

Optional groups

groups: Array<UserGroups>

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

Optional id

id: undefined | string

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

Optional idcsCreatedBy

idcsCreatedBy: model.IdcsCreatedBy

Optional idcsLastModifiedBy

idcsLastModifiedBy: model.IdcsLastModifiedBy

Optional idcsLastUpgradedInRelease

idcsLastUpgradedInRelease: undefined | string

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

Optional idcsPreventedOperations

idcsPreventedOperations: Array<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

Optional 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

Optional locale

locale: undefined | string

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

Optional meta

meta: model.Meta

Optional name

name: model.UserName

Optional nickName

nickName: undefined | string

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

Optional ocid

ocid: undefined | string

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

Optional password

password: undefined | string

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

Optional phoneNumbers

phoneNumbers: Array<UserPhoneNumbers>

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

Optional photos

photos: Array<UserPhotos>

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

Optional preferredLanguage

preferredLanguage: undefined | string

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

Optional profileUrl

profileUrl: undefined | string

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

Optional 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

schemas

schemas: Array<string>

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

Optional tags

tags: Array<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

Optional tenancyOcid

tenancyOcid: undefined | string

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

Optional timezone

timezone: undefined | string

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

Optional title

title: undefined | string

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

Optional urnIetfParamsScimSchemasExtensionEnterprise2_0User

urnIetfParamsScimSchemasExtensionEnterprise2_0User: model.ExtensionEnterprise20User

Optional urnIetfParamsScimSchemasOracleIdcsExtensionAdaptiveUser

urnIetfParamsScimSchemasOracleIdcsExtensionAdaptiveUser: model.ExtensionAdaptiveUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionCapabilitiesUser

urnIetfParamsScimSchemasOracleIdcsExtensionCapabilitiesUser: model.ExtensionCapabilitiesUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionDbCredentialsUser

urnIetfParamsScimSchemasOracleIdcsExtensionDbCredentialsUser: model.ExtensionDbCredentialsUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionDbUserUser

urnIetfParamsScimSchemasOracleIdcsExtensionDbUserUser: model.ExtensionDbUserUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionKerberosUserUser

urnIetfParamsScimSchemasOracleIdcsExtensionKerberosUserUser: model.ExtensionKerberosUserUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionMfaUser

urnIetfParamsScimSchemasOracleIdcsExtensionMfaUser: model.ExtensionMfaUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionOciTags

urnIetfParamsScimSchemasOracleIdcsExtensionOciTags: model.ExtensionOCITags

Optional urnIetfParamsScimSchemasOracleIdcsExtensionPasswordStateUser

urnIetfParamsScimSchemasOracleIdcsExtensionPasswordStateUser: model.ExtensionPasswordStateUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionPasswordlessUser

urnIetfParamsScimSchemasOracleIdcsExtensionPasswordlessUser: model.ExtensionPasswordlessUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionPosixUser

urnIetfParamsScimSchemasOracleIdcsExtensionPosixUser: model.ExtensionPosixUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionSecurityQuestionsUser

urnIetfParamsScimSchemasOracleIdcsExtensionSecurityQuestionsUser: model.ExtensionSecurityQuestionsUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser

urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser: model.ExtensionSelfChangeUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionSelfRegistrationUser

urnIetfParamsScimSchemasOracleIdcsExtensionSelfRegistrationUser: model.ExtensionSelfRegistrationUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionSffUser

urnIetfParamsScimSchemasOracleIdcsExtensionSffUser: model.ExtensionSffUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionSocialAccountUser

urnIetfParamsScimSchemasOracleIdcsExtensionSocialAccountUser: model.ExtensionSocialAccountUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionTermsOfUseUser

urnIetfParamsScimSchemasOracleIdcsExtensionTermsOfUseUser: model.ExtensionTermsOfUseUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionUserCredentialsUser

urnIetfParamsScimSchemasOracleIdcsExtensionUserCredentialsUser: model.ExtensionUserCredentialsUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionUserStateUser

urnIetfParamsScimSchemasOracleIdcsExtensionUserStateUser: model.ExtensionUserStateUser

Optional urnIetfParamsScimSchemasOracleIdcsExtensionUserUser

urnIetfParamsScimSchemasOracleIdcsExtensionUserUser: model.ExtensionUserUser

userName

userName: string

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

Optional userType

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

Optional x509Certificates

x509Certificates: Array<UserX509Certificates>

A list of certificates issued to the User.

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

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: User): object

getJsonObj

  • getJsonObj(obj: User): object