Smarter by Design.Simpler for Business
profile
The profile command manages the own account of the user who is logged in at that moment: it shows their information, changes their password and updates their contact information and language preference. The accounts of other users are managed not with this command but with the users command.
This command affects only the session owner
Every operation that is done is bound to the session used in the authentication; the command does not allow another user to be selected.
Command Summary
# Tab after the command
admin@TR7LBWAF01> profile
change-password config info
admin@TR7LBWAF01> profile info # show my information
admin@TR7LBWAF01> profile change-password # change my password
admin@TR7LBWAF01> profile config … # update my information
admin@TR7LBWAF01>
There is no adding, listing or deleting in this branch: all three subcommands work on the session owner's own record.
profile info — Viewing the Information
It brings the profile information of the logged-in user: the user name, the e-mail address, the phone number, the assigned roles and the language preference. It is a read-only operation; it does not change anything.
| Field | What it does | What is written after it |
|---|---|---|
--info | Writes what the command will do without running it | It does not take a value; it is written on its own |
profile change-password — Changing the Password
Step 1 Write the command
profile change-passwordStep 2 Enter the current password
It is asked without appearing on the screen.
Step 3 Enter the new password
It must meet the password complexity rules of the system.
| Order | Field | Status | Value |
|---|---|---|---|
| 1 | oldPassword | Conditionally required | The current password for verifying the identity; it is asked secretly after the command. It is not requested if one is working in recovery mode |
| 2 | newPassword | Required | The new password of the account; it is asked secretly after the command and must meet the complexity rules of the system |
A password change can drop the sessions
According to the description of the endpoint, after a successful password change the existing sessions can be invalidated and re-authentication can be needed.
The passwords do not appear on the screen
Both fields are asked secretly: they are not written on the command line but entered when they are requested. For this reason it is safer to wait for the password to be asked instead of writing it inside the command.
profile config — Contact and Language
Only the fields that are written are updated; the ones that are not written stay as they are.
| Field | What it does | What is written after it |
|---|---|---|
--emailAddress | Updates the e-mail address of the account | An e-mail address |
--phoneNumber | Updates the phone number of the account | A phone number |
--language | Selects the language of the interface and the system messages | en (the default) · tr |
A change of the language preference takes effect immediately in the current session.
Examples
admin@TR7LBWAF01> profile info
admin@TR7LBWAF01> profile config --emailAddress admin@kurum.com.tr --phoneNumber <number>
admin@TR7LBWAF01> profile config --language tr
admin@TR7LBWAF01>
# both passwords are asked without appearing on the screen
admin@TR7LBWAF01> profile change-password
oldPassword: ********
newPassword: ********
admin@TR7LBWAF01>
Things to Know
- The command manages only the session owner. In order to change another user's password or update their information, the
userscommand is used. - The current password is not requested in recovery mode. The
oldPasswordfield does not come up in the completion list when one is working in recovery mode. - The new password must comply with the rules. A password that does not meet the password complexity requirements of the system is not accepted.
- The update works partially. In the
profile configcommand only the fields that are written change; the others stay as they are. profile infodoes not change anything. It is a read-only operation and the information it returns is specific to the session token.
