forked from pnp/cli-microsoft365
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds the entra administrativeunit roleassignment add command. Closes p…
- Loading branch information
1 parent
ab504e3
commit 1fb49ea
Showing
11 changed files
with
1,002 additions
and
0 deletions.
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 |
---|---|---|
|
@@ -13,6 +13,7 @@ const dictionary = [ | |
'approve', | ||
'assessment', | ||
'assets', | ||
'assignment', | ||
'audit', | ||
'bin', | ||
'builder', | ||
|
116 changes: 116 additions & 0 deletions
116
docs/docs/cmd/entra/administrativeunit/administrativeunit-roleassignment-add.mdx
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,116 @@ | ||
import Global from '/docs/cmd/_global.mdx'; | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
# entra administrativeunit roleassignment add | ||
|
||
Assigns a Microsoft Entra role with administrative unit scope to a user | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 entra administrativeunit roleassignment add [options] | ||
``` | ||
|
||
## Options | ||
|
||
```md definition-list | ||
`-i, --administrativeUnitId [administrativeUnitId]` | ||
: The id of the administrative unit. Specify either `administrativeUnitId` or `administrativeUnitName`. | ||
|
||
`-n, --administrativeUnitName [administrativeUnitName]` | ||
: The name of the administrative unit. Specify either `administrativeUnitId` or `administrativeUnitName`. | ||
|
||
`--roleDefinitionId [roleDefinitionId]` | ||
: The id of the role definition that the member is in. Specify either `roleDefinitionId` or `roleDefinitionName`. | ||
|
||
`--roleDefinitionName [roleDefinitionName]` | ||
: The name of the role definition that the member is in. Specify either `roleDefinitionId` or `roleDefinitionName`. | ||
|
||
`--userId [userId]` | ||
: The id of the user that is a member of the scoped role. Specify either `userId` or `userName`. | ||
|
||
`--userName [userName]` | ||
: The name of the user that is a member of the scoped role. Specify either `userId` or `userName`. | ||
``` | ||
|
||
<Global /> | ||
|
||
## Remarks | ||
|
||
:::info | ||
|
||
To use this command you must be either **Global Administrator** or **Privileged Role Administrator**. | ||
|
||
::: | ||
|
||
## Examples | ||
|
||
Assign a role definition specified by id to a user specified by id for an administrative unit specified by id | ||
|
||
```sh | ||
m365 entra administrativeunit roleassignment add --administrativeUnitId 81bb36e4-f4c6-4984-8e56-d4f8feae9e09 --roleDefinitionId 4d6ac14f-3453-41d0-bef9-a3e0c569773a --userId 5f91f951-7305-4a27-9b63-7b00906de09f | ||
``` | ||
|
||
Assign a role definition specified by name to a user specified by name for an administrative unit specified by name | ||
|
||
```sh | ||
m365 entra administrativeunit roleassignment add --administrativeUnitName 'Marketing Division' --roleDefinitionName 'License Administrator' --userName '[email protected]' | ||
``` | ||
|
||
## Response | ||
|
||
<Tabs> | ||
<TabItem value="JSON"> | ||
|
||
```json | ||
{ | ||
"id": "5wuT_mJe20eRr5jDpJo4sVH5kV8FcydKm2N7AJBt4J_kNruBxvSESY5W1Pj-rp4J-2", | ||
"principalId": "5f91f951-7305-4a27-9b63-7b00906de09f", | ||
"directoryScopeId": "/administrativeUnits/81bb36e4-f4c6-4984-8e56-d4f8feae9e09", | ||
"roleDefinitionId": "4d6ac14f-3453-41d0-bef9-a3e0c569773a" | ||
} | ||
``` | ||
|
||
</TabItem> | ||
<TabItem value="Text"> | ||
|
||
```text | ||
directoryScopeId: /administrativeUnits/81bb36e4-f4c6-4984-8e56-d4f8feae9e09 | ||
id : 4yeYchSc90m7G5YI8Va7uFH5kV8FcydKm2N7AJBt4J_kNruBxvSESY5W1Pj-rp4J-2 | ||
principalId : 5f91f951-7305-4a27-9b63-7b00906de09f | ||
roleDefinitionId: 4d6ac14f-3453-41d0-bef9-a3e0c569773a | ||
``` | ||
|
||
</TabItem> | ||
<TabItem value="CSV"> | ||
|
||
```csv | ||
id,principalId,directoryScopeId,roleDefinitionId | ||
UB-K8uf2cUWBi2oS8q9rbFH5kV8FcydKm2N7AJBt4J_kNruBxvSESY5W1Pj-rp4J-2,5f91f951-7305-4a27-9b63-7b00906de09f,/administrativeUnits/81bb36e4-f4c6-4984-8e56-d4f8feae9e09,4d6ac14f-3453-41d0-bef9-a3e0c569773a | ||
``` | ||
|
||
</TabItem> | ||
<TabItem value="Markdown"> | ||
|
||
```md | ||
# entra administrativeunit roleassignment add --administrativeUnitId "81bb36e4-f4c6-4984-8e56-d4f8feae9e09" --roleDefinitionId "4d6ac14f-3453-41d0-bef9-a3e0c569773a" --userId "5f91f951-7305-4a27-9b63-7b00906de09f" | ||
|
||
Date: 11/16/2023 | ||
|
||
## T8FqTVM00EG--aPgxWl3OlH5kV8FcydKm2N7AJBt4J_kNruBxvSESY5W1Pj-rp4J-2 | ||
|
||
Property | Value | ||
---------|------- | ||
id | T8FqTVM00EG--aPgxWl3OlH5kV8FcydKm2N7AJBt4J\_kNruBxvSESY5W1Pj-rp4J-2 | ||
principalId | 5f91f951-7305-4a27-9b63-7b00906de09f | ||
directoryScopeId | /administrativeUnits/81bb36e4-f4c6-4984-8e56-d4f8feae9e09 | ||
roleDefinitionId | 4d6ac14f-3453-41d0-bef9-a3e0c569773a | ||
``` | ||
|
||
</TabItem> | ||
</Tabs> | ||
|
||
## More information | ||
|
||
- [Roles with administrative unit scope](https://learn.microsoft.com/entra/identity/role-based-access-control/admin-units-assign-roles#roles-that-can-be-assigned-with-administrative-unit-scope) |
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
Oops, something went wrong.