Skip to content

/AWS1/CL_SGM=>CREATEUSERPROFILE()

About CreateUserProfile

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.

Method Signature

IMPORTING

Required arguments:

IV_DOMAINID TYPE /AWS1/SGMDOMAINID /AWS1/SGMDOMAINID

The ID of the associated Domain.

IV_USERPROFILENAME TYPE /AWS1/SGMUSERPROFILENAME /AWS1/SGMUSERPROFILENAME

A name for the UserProfile. This value is not case sensitive.

Optional arguments:

IV_SINGLESIGNONUSERID TYPE /AWS1/SGMSINGLESIGNONUSERID /AWS1/SGMSINGLESIGNONUSERID

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

IV_SINGLESIGNONUSERVALUE TYPE /AWS1/SGMSTRING256 /AWS1/SGMSTRING256

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

IO_USERSETTINGS TYPE REF TO /AWS1/CL_SGMUSERSETTINGS /AWS1/CL_SGMUSERSETTINGS

A collection of settings.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_SGMCREATEUSERPFLRSP /AWS1/CL_SGMCREATEUSERPFLRSP