/AWS1/CL_IDSUSER

A user object that contains the metadata and attributes for a specified user.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_identitystoreid TYPE /AWS1/IDSIDENTITYSTOREID /AWS1/IDSIDENTITYSTOREID

The globally unique identifier for the identity store.

iv_userid TYPE /AWS1/IDSRESOURCEID /AWS1/IDSRESOURCEID

The identifier for a user in the identity store.

Optional arguments:

iv_username TYPE /AWS1/IDSUSERNAME /AWS1/IDSUSERNAME

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

it_externalids TYPE /AWS1/CL_IDSEXTERNALID=>TT_EXTERNALIDS TT_EXTERNALIDS

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

io_name TYPE REF TO /AWS1/CL_IDSNAME /AWS1/CL_IDSNAME

An object containing the name of the user.

iv_displayname TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

Prefix search supports a maximum of 1,000 characters for the string.

iv_nickname TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

A string containing an alternate name for the user.

iv_profileurl TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

A string containing a URL that might be associated with the user.

it_emails TYPE /AWS1/CL_IDSEMAIL=>TT_EMAILS TT_EMAILS

A list of Email objects containing email addresses associated with the user.

it_addresses TYPE /AWS1/CL_IDSADDRESS=>TT_ADDRESSES TT_ADDRESSES

A list of Address objects containing addresses associated with the user.

it_phonenumbers TYPE /AWS1/CL_IDSPHONENUMBER=>TT_PHONENUMBERS TT_PHONENUMBERS

A list of PhoneNumber objects containing phone numbers associated with the user.

iv_usertype TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

iv_title TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

iv_preferredlanguage TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

A string containing the preferred language of the user. For example, "American English" or "en-us."

iv_locale TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

A string containing the geographical region or location of the user.

iv_timezone TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

A string containing the time zone of the user.

iv_userstatus TYPE /AWS1/IDSUSERSTATUS /AWS1/IDSUSERSTATUS

The current status of the user account.

it_photos TYPE /AWS1/CL_IDSPHOTO=>TT_PHOTOS TT_PHOTOS

A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

iv_website TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

The user's personal website or blog URL. This field stores website information for personal or professional use.

iv_birthdate TYPE /AWS1/IDSSENSITIVESTRINGTYPE /AWS1/IDSSENSITIVESTRINGTYPE

The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.

iv_createdat TYPE /AWS1/IDSDATETYPE /AWS1/IDSDATETYPE

The date and time the user was created.

iv_createdby TYPE /AWS1/IDSSTRINGTYPE /AWS1/IDSSTRINGTYPE

The identifier of the user or system that created the user.

iv_updatedat TYPE /AWS1/IDSDATETYPE /AWS1/IDSDATETYPE

The date and time the user was last updated.

iv_updatedby TYPE /AWS1/IDSSTRINGTYPE /AWS1/IDSSTRINGTYPE

The identifier of the user or system that last updated the user.

it_extensions TYPE /AWS1/CL_RT_DOCUMENT=>TT_MAP TT_MAP

A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.

---

Queryable Attributes

IdentityStoreId

The globally unique identifier for the identity store.

Accessible with the following methods

Method	Description
GET_IDENTITYSTOREID()	Getter for IDENTITYSTOREID, with configurable default
ASK_IDENTITYSTOREID()	Getter for IDENTITYSTOREID w/ exceptions if field has no val
HAS_IDENTITYSTOREID()	Determine if IDENTITYSTOREID has a value

UserId

The identifier for a user in the identity store.

Accessible with the following methods

Method	Description
GET_USERID()	Getter for USERID, with configurable default
ASK_USERID()	Getter for USERID w/ exceptions if field has no value
HAS_USERID()	Determine if USERID has a value

UserName

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

Accessible with the following methods

Method	Description
GET_USERNAME()	Getter for USERNAME, with configurable default
ASK_USERNAME()	Getter for USERNAME w/ exceptions if field has no value
HAS_USERNAME()	Determine if USERNAME has a value

ExternalIds

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

Accessible with the following methods

Method	Description
GET_EXTERNALIDS()	Getter for EXTERNALIDS, with configurable default
ASK_EXTERNALIDS()	Getter for EXTERNALIDS w/ exceptions if field has no value
HAS_EXTERNALIDS()	Determine if EXTERNALIDS has a value

Name

An object containing the name of the user.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME

DisplayName

A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

Prefix search supports a maximum of 1,000 characters for the string.

Accessible with the following methods

Method	Description
GET_DISPLAYNAME()	Getter for DISPLAYNAME, with configurable default
ASK_DISPLAYNAME()	Getter for DISPLAYNAME w/ exceptions if field has no value
HAS_DISPLAYNAME()	Determine if DISPLAYNAME has a value

NickName

A string containing an alternate name for the user.

Accessible with the following methods

Method	Description
GET_NICKNAME()	Getter for NICKNAME, with configurable default
ASK_NICKNAME()	Getter for NICKNAME w/ exceptions if field has no value
HAS_NICKNAME()	Determine if NICKNAME has a value

ProfileUrl

A string containing a URL that might be associated with the user.

Accessible with the following methods

Method	Description
GET_PROFILEURL()	Getter for PROFILEURL, with configurable default
ASK_PROFILEURL()	Getter for PROFILEURL w/ exceptions if field has no value
HAS_PROFILEURL()	Determine if PROFILEURL has a value

Emails

A list of Email objects containing email addresses associated with the user.

Accessible with the following methods

Method	Description
GET_EMAILS()	Getter for EMAILS, with configurable default
ASK_EMAILS()	Getter for EMAILS w/ exceptions if field has no value
HAS_EMAILS()	Determine if EMAILS has a value

Addresses

A list of Address objects containing addresses associated with the user.

Accessible with the following methods

Method	Description
GET_ADDRESSES()	Getter for ADDRESSES, with configurable default
ASK_ADDRESSES()	Getter for ADDRESSES w/ exceptions if field has no value
HAS_ADDRESSES()	Determine if ADDRESSES has a value

PhoneNumbers

A list of PhoneNumber objects containing phone numbers associated with the user.

Accessible with the following methods

Method	Description
GET_PHONENUMBERS()	Getter for PHONENUMBERS, with configurable default
ASK_PHONENUMBERS()	Getter for PHONENUMBERS w/ exceptions if field has no value
HAS_PHONENUMBERS()	Determine if PHONENUMBERS has a value

UserType

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

Accessible with the following methods

Method	Description
GET_USERTYPE()	Getter for USERTYPE, with configurable default
ASK_USERTYPE()	Getter for USERTYPE w/ exceptions if field has no value
HAS_USERTYPE()	Determine if USERTYPE has a value

Title

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

Accessible with the following methods

Method	Description
GET_TITLE()	Getter for TITLE, with configurable default
ASK_TITLE()	Getter for TITLE w/ exceptions if field has no value
HAS_TITLE()	Determine if TITLE has a value

PreferredLanguage

A string containing the preferred language of the user. For example, "American English" or "en-us."

Accessible with the following methods

Method	Description
GET_PREFERREDLANGUAGE()	Getter for PREFERREDLANGUAGE, with configurable default
ASK_PREFERREDLANGUAGE()	Getter for PREFERREDLANGUAGE w/ exceptions if field has no v
HAS_PREFERREDLANGUAGE()	Determine if PREFERREDLANGUAGE has a value

Locale

A string containing the geographical region or location of the user.

Accessible with the following methods

Method	Description
GET_LOCALE()	Getter for LOCALE, with configurable default
ASK_LOCALE()	Getter for LOCALE w/ exceptions if field has no value
HAS_LOCALE()	Determine if LOCALE has a value

Timezone

A string containing the time zone of the user.

Accessible with the following methods

Method	Description
GET_TIMEZONE()	Getter for TIMEZONE, with configurable default
ASK_TIMEZONE()	Getter for TIMEZONE w/ exceptions if field has no value
HAS_TIMEZONE()	Determine if TIMEZONE has a value

UserStatus

The current status of the user account.

Accessible with the following methods

Method	Description
GET_USERSTATUS()	Getter for USERSTATUS, with configurable default
ASK_USERSTATUS()	Getter for USERSTATUS w/ exceptions if field has no value
HAS_USERSTATUS()	Determine if USERSTATUS has a value

Photos

A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

Accessible with the following methods

Method	Description
GET_PHOTOS()	Getter for PHOTOS, with configurable default
ASK_PHOTOS()	Getter for PHOTOS w/ exceptions if field has no value
HAS_PHOTOS()	Determine if PHOTOS has a value

Website

The user's personal website or blog URL. This field stores website information for personal or professional use.

Accessible with the following methods

Method	Description
GET_WEBSITE()	Getter for WEBSITE, with configurable default
ASK_WEBSITE()	Getter for WEBSITE w/ exceptions if field has no value
HAS_WEBSITE()	Determine if WEBSITE has a value

Birthdate

The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.

Accessible with the following methods

Method	Description
GET_BIRTHDATE()	Getter for BIRTHDATE, with configurable default
ASK_BIRTHDATE()	Getter for BIRTHDATE w/ exceptions if field has no value
HAS_BIRTHDATE()	Determine if BIRTHDATE has a value

CreatedAt

The date and time the user was created.

Accessible with the following methods

Method	Description
GET_CREATEDAT()	Getter for CREATEDAT, with configurable default
ASK_CREATEDAT()	Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT()	Determine if CREATEDAT has a value

CreatedBy

The identifier of the user or system that created the user.

Accessible with the following methods

Method	Description
GET_CREATEDBY()	Getter for CREATEDBY, with configurable default
ASK_CREATEDBY()	Getter for CREATEDBY w/ exceptions if field has no value
HAS_CREATEDBY()	Determine if CREATEDBY has a value

UpdatedAt

The date and time the user was last updated.

Accessible with the following methods

Method	Description
GET_UPDATEDAT()	Getter for UPDATEDAT, with configurable default
ASK_UPDATEDAT()	Getter for UPDATEDAT w/ exceptions if field has no value
HAS_UPDATEDAT()	Determine if UPDATEDAT has a value

UpdatedBy

The identifier of the user or system that last updated the user.

Accessible with the following methods

Method	Description
GET_UPDATEDBY()	Getter for UPDATEDBY, with configurable default
ASK_UPDATEDBY()	Getter for UPDATEDBY w/ exceptions if field has no value
HAS_UPDATEDBY()	Determine if UPDATEDBY has a value

Extensions

A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.

Accessible with the following methods

Method	Description
GET_EXTENSIONS()	Getter for EXTENSIONS, with configurable default
ASK_EXTENSIONS()	Getter for EXTENSIONS w/ exceptions if field has no value
HAS_EXTENSIONS()	Determine if EXTENSIONS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_USERS

TYPES TT_USERS TYPE STANDARD TABLE OF REF TO /AWS1/CL_IDSUSER WITH DEFAULT KEY
.