Skip to content

/AWS1/CL_FNDGETUSERRESPONSE

GetUserResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_userid TYPE /AWS1/FNDUSERID /AWS1/FNDUSERID

The unique identifier for the user that is retrieved.

iv_status TYPE /AWS1/FNDUSERSTATUS /AWS1/FNDUSERSTATUS

The current status of the user.

  • CREATING – The creation is in progress.

  • ENABLED – The user is created and is currently active.

  • DISABLED – The user is currently inactive.

iv_firstname TYPE /AWS1/FNDFIRSTNAME /AWS1/FNDFIRSTNAME

The first name of the user.

iv_lastname TYPE /AWS1/FNDLASTNAME /AWS1/FNDLASTNAME

The last name of the user.

iv_emailaddress TYPE /AWS1/FNDEMAIL /AWS1/FNDEMAIL

The email address that is associated with the user.

iv_type TYPE /AWS1/FNDUSERTYPE /AWS1/FNDUSERTYPE

Indicates the type of user.

  • SUPER_USER – A user with permission to all the functionality and data in FinSpace.

  • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

iv_apiaccess TYPE /AWS1/FNDAPIACCESS /AWS1/FNDAPIACCESS

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

  • ENABLED – The user has permissions to use the APIs.

  • DISABLED – The user does not have permissions to use any APIs.

iv_apiaccessprincipalarn TYPE /AWS1/FNDROLEARN /AWS1/FNDROLEARN

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

iv_createtime TYPE /AWS1/FNDTIMESTAMPEPOCH /AWS1/FNDTIMESTAMPEPOCH

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

iv_lastenabledtime TYPE /AWS1/FNDTIMESTAMPEPOCH /AWS1/FNDTIMESTAMPEPOCH

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

iv_lastdisabledtime TYPE /AWS1/FNDTIMESTAMPEPOCH /AWS1/FNDTIMESTAMPEPOCH

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

iv_lastmodifiedtime TYPE /AWS1/FNDTIMESTAMPEPOCH /AWS1/FNDTIMESTAMPEPOCH

Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.

iv_lastlogintime TYPE /AWS1/FNDTIMESTAMPEPOCH /AWS1/FNDTIMESTAMPEPOCH

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

Queryable Attributes

userId

The unique identifier for the user that is retrieved.

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

status

The current status of the user.

  • CREATING – The creation is in progress.

  • ENABLED – The user is created and is currently active.

  • DISABLED – The user is currently inactive.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

firstName

The first name of the user.

Accessible with the following methods

Method Description
GET_FIRSTNAME() Getter for FIRSTNAME, with configurable default
ASK_FIRSTNAME() Getter for FIRSTNAME w/ exceptions if field has no value
HAS_FIRSTNAME() Determine if FIRSTNAME has a value

lastName

The last name of the user.

Accessible with the following methods

Method Description
GET_LASTNAME() Getter for LASTNAME, with configurable default
ASK_LASTNAME() Getter for LASTNAME w/ exceptions if field has no value
HAS_LASTNAME() Determine if LASTNAME has a value

emailAddress

The email address that is associated with the user.

Accessible with the following methods

Method Description
GET_EMAILADDRESS() Getter for EMAILADDRESS, with configurable default
ASK_EMAILADDRESS() Getter for EMAILADDRESS w/ exceptions if field has no value
HAS_EMAILADDRESS() Determine if EMAILADDRESS has a value

type

Indicates the type of user.

  • SUPER_USER – A user with permission to all the functionality and data in FinSpace.

  • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE, with configurable default
ASK_TYPE() Getter for TYPE w/ exceptions if field has no value
HAS_TYPE() Determine if TYPE has a value

apiAccess

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

  • ENABLED – The user has permissions to use the APIs.

  • DISABLED – The user does not have permissions to use any APIs.

Accessible with the following methods

Method Description
GET_APIACCESS() Getter for APIACCESS, with configurable default
ASK_APIACCESS() Getter for APIACCESS w/ exceptions if field has no value
HAS_APIACCESS() Determine if APIACCESS has a value

apiAccessPrincipalArn

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

Accessible with the following methods

Method Description
GET_APIACCESSPRINCIPALARN() Getter for APIACCESSPRINCIPALARN, with configurable default
ASK_APIACCESSPRINCIPALARN() Getter for APIACCESSPRINCIPALARN w/ exceptions if field has
HAS_APIACCESSPRINCIPALARN() Determine if APIACCESSPRINCIPALARN has a value

createTime

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

Accessible with the following methods

Method Description
GET_CREATETIME() Getter for CREATETIME

lastEnabledTime

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

Accessible with the following methods

Method Description
GET_LASTENABLEDTIME() Getter for LASTENABLEDTIME

lastDisabledTime

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

Accessible with the following methods

Method Description
GET_LASTDISABLEDTIME() Getter for LASTDISABLEDTIME

lastModifiedTime

Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.

Accessible with the following methods

Method Description
GET_LASTMODIFIEDTIME() Getter for LASTMODIFIEDTIME

lastLoginTime

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

Accessible with the following methods

Method Description
GET_LASTLOGINTIME() Getter for LASTLOGINTIME