-
Notifications
You must be signed in to change notification settings - Fork 330
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds engage community user add
. Closes #6293
#6388
Draft
MathijsVerbeeck
wants to merge
2
commits into
pnp:main
Choose a base branch
from
MathijsVerbeeck:add-viva-engage-community-user-add
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
import Global from '/docs/cmd/_global.mdx'; | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
# viva engage community user add | ||
|
||
Adds a user to a specific Microsoft 365 Viva Engage community | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 viva engage community user add [options] | ||
``` | ||
|
||
## Options | ||
|
||
```md definition-list | ||
`-i, --communityId [communityId]` | ||
: The ID of the Viva Engage community. Specify `communityId`, `communityDisplayName` or `entraGroupId`. | ||
|
||
`-n, --communityDisplayName [communityDisplayName]` | ||
: The display name of the Viva Engage community. Specify `communityId`, `communityDisplayName` or `entraGroupId`. | ||
|
||
`--ids [ids]` | ||
: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids` or `userNames` but not both. | ||
|
||
`--userNames [userNames]` | ||
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both. | ||
|
||
`--entraGroupId [entraGroupId]` | ||
: The ID of the Microsoft 365 group. Specify `communityId`, `communityDisplayName` or `entraGroupId`. | ||
|
||
`-r, --role <role>` | ||
: The role to be assigned to the new users. Valid values: `Admin`, `Member`. | ||
``` | ||
|
||
<Global /> | ||
|
||
## Examples | ||
|
||
Add a single user specified by ID as a member to a community specified by display name. | ||
|
||
```sh | ||
m365 viva engage community user add --communityDisplayName "All company" --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member | ||
``` | ||
|
||
Add multiple users specified by ID as members to a community specified by ID. | ||
|
||
```sh | ||
m365 viva engage community user add --communityId eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIzNjAyMDAxMTAwOSJ9 --ids "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member | ||
``` | ||
|
||
Add a single user specified by UPN as an admin to a community specified by display name. | ||
|
||
```sh | ||
m365 viva engage community user add --communityDisplayName "All company" --userNames [email protected] --role Admin | ||
``` | ||
|
||
Adds multiple users specified by UPN as admins to a community specified by its group ID. | ||
|
||
```sh | ||
m365 viva engage community user add --entraGroupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userNames "[email protected],[email protected]" --role Admin | ||
``` | ||
|
||
## Response | ||
|
||
The command won't return a response on success. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,5 @@ export interface Community { | |
displayName: string; | ||
description?: string; | ||
privacy: string; | ||
groupId: string; | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say place this one right below communityDisplayName, as it's an optionset