Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IdentitySetting

Identity Settings

Properties

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 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 emitLockedMessageWhenUserIsLocked

emitLockedMessageWhenUserIsLocked: undefined | false | true

Indicates whether to show the 'user-is-locked' message during authentication if the user is already locked. The default value is false, which tells the system to show a generic 'authentication-failure' message. This is the most secure behavior. If the option is set to true, the system shows a more detailed 'error-message' that says the user is locked. This is more helpful but is less secure, for example, because the difference in error-messages could be used to determine which usernames exist and which do not.

*Added In:** 19.2.1

*SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - 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 - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - 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 meta

meta: model.Meta

Optional myProfile

myProfile: model.IdentitySettingsMyProfile

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 pOSIXGid

pOSIXGid: model.IdentitySettingsPOSIXGid

Optional pOSIXUid

pOSIXUid: model.IdentitySettingsPOSIXUid

Optional primaryEmailRequired

primaryEmailRequired: undefined | false | true

Indicates whether the primary email is required.

*Added In:** 19.1.4

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

Optional removeInvalidEmails

removeInvalidEmails: undefined | false | true

Indicates whether to remove non-RFC5322 compliant emails before creating a user.

*Added In:** 2106170416

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

Optional returnInactiveOverLockedMessage

returnInactiveOverLockedMessage: undefined | false | true

Added In: 2302092332

*SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none Determines the PasswordAuthenticator API response when a user is both 'locked' and 'inactive.' If false (default), a 'locked' message is shown. If true, an 'inactive' message is shown.

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 tokens

A list of tokens and their expiry length.

*SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [type] - multiValued: true - required: false - type: complex - uniqueness: none

Optional userAllowedToSetRecoveryEmail

userAllowedToSetRecoveryEmail: undefined | false | true

Indicates whether a user is allowed to change their own recovery email.

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

Functions

getDeserializedJsonObj

getJsonObj