Skip to content

/AWS1/IF_FND=>CREATEUSER()

About CreateUser

Creates a new user in FinSpace.

Method Signature

METHODS /AWS1/IF_FND~CREATEUSER
  IMPORTING
    !IV_EMAILADDRESS TYPE /AWS1/FNDEMAIL OPTIONAL
    !IV_TYPE TYPE /AWS1/FNDUSERTYPE OPTIONAL
    !IV_FIRSTNAME TYPE /AWS1/FNDFIRSTNAME OPTIONAL
    !IV_LASTNAME TYPE /AWS1/FNDLASTNAME OPTIONAL
    !IV_APIACCESS TYPE /AWS1/FNDAPIACCESS OPTIONAL
    !IV_APIACCESSPRINCIPALARN TYPE /AWS1/FNDROLEARN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/FNDCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fndcreateuserresponse
  RAISING
    /AWS1/CX_FNDACCESSDENIEDEX
    /AWS1/CX_FNDCONFLICTEXCEPTION
    /AWS1/CX_FNDINTERNALSERVEREX
    /AWS1/CX_FNDLIMITEXCEEDEDEX
    /AWS1/CX_FNDTHROTTLINGEX
    /AWS1/CX_FNDVALIDATIONEX
    /AWS1/CX_FNDCLIENTEXC
    /AWS1/CX_FNDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_emailaddress TYPE /AWS1/FNDEMAIL /AWS1/FNDEMAIL

The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

iv_type TYPE /AWS1/FNDUSERTYPE /AWS1/FNDUSERTYPE

The option to indicate the type of user. Use one of the following options to specify this parameter:

  • 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.

Optional arguments:

iv_firstname TYPE /AWS1/FNDFIRSTNAME /AWS1/FNDFIRSTNAME

The first name of the user that you want to register.

iv_lastname TYPE /AWS1/FNDLASTNAME /AWS1/FNDLASTNAME

The last name of the user that you want to register.

iv_apiaccess TYPE /AWS1/FNDAPIACCESS /AWS1/FNDAPIACCESS

The option to indicate 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_clienttoken TYPE /AWS1/FNDCLIENTTOKEN /AWS1/FNDCLIENTTOKEN

A token that ensures idempotency. This token expires in 10 minutes.

RETURNING

oo_output TYPE REF TO /aws1/cl_fndcreateuserresponse /AWS1/CL_FNDCREATEUSERRESPONSE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createuser(
  iv_apiaccess = |string|
  iv_apiaccessprincipalarn = |string|
  iv_clienttoken = |string|
  iv_emailaddress = |string|
  iv_firstname = |string|
  iv_lastname = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_userid = lo_result->get_userid( ).
ENDIF.