Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/users/invitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,24 @@
description: Manage user invitations to create an account in the frontend or the Back Office.
---

# Inviting users
# Invite users

[[= product_name =]] allows you to create and send invitations to create an account in
the frontend as a customer, the Back Office as an employee, or the Corporate Portal as an organisation member.
the frontend as a customer, the Back Office as an employee, or the Corporate Portal as an organization member.

Check warning on line 8 in docs/users/invitations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/users/invitations.md#L8

[Ibexa.DontCapitalize] Don't capitalize 'Back Office' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Back Office' if inside the sentence.", "location": {"path": "docs/users/invitations.md", "range": {"start": {"line": 8, "column": 33}}}, "severity": "WARNING"}
You can send invitations to individual users or in bulk.

## Roles and Policies

To invite other members to the site or the Back Office, a user needs to have the `User:Invite` permission added to their Role.
You can limit the ability to invite other members to specific User Groups,
such as Editors, or to the specific Roles within the group, for example: Admin, Buyer.
You can limit the ability to invite other members to specific user groups, such as Editors, or to the specific Roles within the group, for example: Admin, Buyer.

Check warning on line 14 in docs/users/invitations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/users/invitations.md#L14

[Ibexa.DontCapitalize] Don't capitalize 'Roles' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Roles' if inside the sentence.", "location": {"path": "docs/users/invitations.md", "range": {"start": {"line": 14, "column": 112}}}, "severity": "WARNING"}

## Creating and sending invitations

Invitations are created with [InvitationService](../api/php_api/php_api_reference/classes/Ibexa-Contracts-User-Invitation-InvitationService.html),
but sending them requires additional setup.
[[= product_name =]] provides you with `Ibexa\User\Invitation\MailSender` implementation of
`InvitationSender` interface for sending invitations via email.
If you want to send invitations through different channels, you will need to create a custom setup.
If you want to send invitations through different channels, you need to create a custom setup.

## Invitation and registration form templates

Expand All @@ -29,7 +28,7 @@
To set up custom templates for invitation or registration forms,
create a template file and inform the system, through configuration, when to use this template.

You might also set a SiteAccess under `scope`, to which the new user will be invited.
You might also set a SiteAccess under `scope`, to which the new user is invited.
If the SiteAccess is not set, it falls back to the default `site` value.

For example, use the following [configuration](configuration.md#configuration-files):
Expand Down
50 changes: 50 additions & 0 deletions docs/users/update_basic_user_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---

Check warning on line 1 in docs/users/update_basic_user_data.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/users/update_basic_user_data.md#L1

[Ibexa.ReadingLevel] The grade level is 8.71. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 8.71. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/users/update_basic_user_data.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Update basic user account data from the console.
---

# Update basic user data from CLI

Multiple user management scenarios may result in having to update basic user account data, such as user status, the password, or email.
Especially, when a security breach occurs, you may need to revoke user access by disabling the account, or change the user's password.

You can do it without accessing the Admin UI, by running a console command.
You reference the user account with either user id or login.

## Disable or enable user account

To change the status of a user account, you must have the `user/activation` permission.

Disable the user account:

```bash
php bin/console ibexa:user:update-user --disable <user_reference>
```

Enable the user account:

```bash
php bin/console ibexa:user:update-user --enable <user_reference>
```

## Change password

To change the password, you must have the `user/password` permission.

Change the password associated with the user account:

```bash
php bin/console ibexa:user:update-user --password <user_reference>
```

After you run the command, enter the new password when prompted.
The command runs in silent mode and inputs are not echoed.

For more information about changing and revoking passwords, see [Passwords](passwords.md#revoking-passwords).

## Change email address

Change the email address associated with the user account:

```bash
php bin/console ibexa:user:update-user --email=<new_email_address> <user_reference>
```
3 changes: 2 additions & 1 deletion docs/users/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ All such user accounts have the same underlying mechanism and enable you to cont
"users/user_management_guide",
"users/invitations",
"users/user_registration",
], columns=3) =]]
"users/update_basic_user_data"
], columns=4) =]]

## Authenticate users

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,7 @@ nav:
- User setup:
- Invitations: users/invitations.md
- Registration: users/user_registration.md
- Update basic user data: users/update_basic_user_data.md
- User authentication:
- Login methods: users/login_methods.md
- Passwords: users/passwords.md
Expand Down
Loading