Skip to content

Commit

Permalink
Merge pull request #1423 from SEKOIA-IO/update-automation-library-doc…
Browse files Browse the repository at this point in the history
…umentation

Refresh automation library documentation
  • Loading branch information
squioc authored Nov 7, 2023
2 parents b1952e4 + 15ead97 commit 818d5d4
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
38 changes: 36 additions & 2 deletions _shared_content/automate/library/azure-active-directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,21 @@
| `tenant_id` | `string` | ID of the Azure AD tenant |
| `client_id` | `string` | Client ID. An application needs to be created in the Azure Portal and assigned relevent permissions. Its Client ID should then be used in this configuration. |
| `client_secret` | `string` | Client Secret associated with the registered application. Admin Consent has to be granted to the application for it to work. |
| `username` | `string` | The username of the delegated account used for some administrative tasks (eg: reset password) |
| `password` | `string` | The password of the delegated account used for some administrative tasks (eg: reset password) |

## Actions

### Delete app

Delete an app in azure AD. Requires the Application.ReadWrite.OwnedBy or Application.ReadWrite.All.

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `id` | `string` | Object ID of the app. |

### Disable User

Disable an Azure Active Directory user. Requires the User.ReadWrite.All permission.
Expand Down Expand Up @@ -45,7 +57,6 @@ Get the last sign ins of an Azure AD user. Requires the AuditLog.Read.All and Di
| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `id` | `string` | ID of the user. id or userPrincipalName should be specified. |
| `userPrincipalName` | `string` | Principal Name of the user. id or userPrincipalName should be specified. |


**Outputs**
Expand Down Expand Up @@ -116,7 +127,30 @@ Get information about an user's authentication methods (such as their MFA status
| `methodsRegistered` | `array` | |
| `defaultMfaMethod` | `string` | |

### Reset User Password

Reset a user's password. You will need UserAuthenticationMethod.ReadWrite.All deleguated permission. And to disable the MFA authentication in your azure AD

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `id` | `string` | ID of the user. id or userPrincipalName should be specified. |
| `userPrincipalName` | `string` | Principal Name of the user. id or userPrincipalName should be specified. |
| `userNewPassword` | `string` | New password, required to reset the old one of course. |

### Revoke Sign in

Invalidates all the refresh tokens issued to applications for a user. Requires the User.ReadWrite.All or Directory.ReadWrite.All permissions.

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `id` | `string` | ID of the app. |
| `userPrincipalName` | `string` | Principal Name of the user. id or userPrincipalName should be specified. |


## Extra

Module **`Azure Active Directory` v2.4**
Module **`Azure Active Directory` v2.5.4**
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ nav:
- Actions Library:
- AWS: xdr/features/automate/library/aws.md
- Azure Active Directory: xdr/features/automate/library/azure-active-directory.md
- Azure Active Directory: xdr/features/automate/library/azure-active-directory.md
- BinaryEdge's API: xdr/features/automate/library/binaryedge-s-api.md
- Censys: xdr/features/automate/library/censys.md
- Certificate Transparency: xdr/features/automate/library/certificate-transparency.md
Expand Down Expand Up @@ -430,6 +431,7 @@ nav:
- Actions: tip/features/automate/actions.md
- Actions Library:
- AWS: tip/features/automate/library/aws.md
- Azure Active Directory: tip/features/automate/library/azure-active-directory.md
- BinaryEdge's API: tip/features/automate/library/binaryedge-s-api.md
- Censys: tip/features/automate/library/censys.md
- Certificate Transparency: tip/features/automate/library/certificate-transparency.md
Expand Down

0 comments on commit 818d5d4

Please sign in to comment.