Skip to content

Commit

Permalink
Updated Resources and Cmdlet documentation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
NikCharleboisPFE committed Oct 24, 2023
1 parent e7f2435 commit a58b818
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docs/resources/azure-ad/AADAttributeSet.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To authenticate with the Microsoft Graph API, this resource required the followi

- **Read**

- CustomSecAttributeDefinition.ReadWrite.All
- CustomSecAttributeDefinition.Read.All

- **Update**

Expand Down
85 changes: 85 additions & 0 deletions docs/docs/resources/azure-ad/AADSocialIdentityProvider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# AADSocialIdentityProvider

## Parameters

| Parameter | Attribute | DataType | Description | Allowed Values |
| --- | --- | --- | --- | --- |
| **ClientId** | Key | String | The client identifier for the application obtained when registering the application with the identity provider. | |
| **ClientSecret** | Write | String | The client secret for the application that is obtained when the application is registered with the identity provider. This is write-only. A read operation returns ****. | |
| **DisplayName** | Write | String | The display name of the identity provider. | |
| **IdentityProviderType** | Write | String | For a B2B scenario, possible values: Google, Facebook. For a B2C scenario, possible values: Microsoft, Google, Amazon, LinkedIn, Facebook, GitHub, Twitter, Weibo, QQ, WeChat. | `AADSignup`, `EmailOTP`, `Microsoft`, `MicrosoftAccount`, `Google`, `Amazon`, `LinkedIn`, `Facebook`, `GitHub`, `Twitter`, `Weibo`, `QQ`, `WeChat` |
| **Ensure** | Write | String | Present ensures the policy exists, absent ensures it is removed. | `Present`, `Absent` |
| **Credential** | Write | PSCredential | Credentials of the Admin | |
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. | |
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. | |
| **ApplicationSecret** | Write | PSCredential | Secret of the Azure Active Directory tenant used for authentication. | |
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. | |
| **ManagedIdentity** | Write | Boolean | Managed ID being used for authentication. | |


# AADIdentityProvider

## Description

Represents identity providers with External Identities for both Microsoft Entra ID and Azure AD B2C tenants. For Microsoft Entra B2B scenarios in a Microsoft Entra tenant, the identity provider type can be Google or Facebook.

## Permissions

### Microsoft Graph

To authenticate with the Microsoft Graph API, this resource required the following permissions:

#### Delegated permissions

- **Read**

- None

- **Update**

- None

#### Application permissions

- **Read**

- IdentityProvider.Read.All

- **Update**

- IdentityProvider.ReadWrite.All

## Examples

### Example 1

This example is used to test new resources and showcase the usage of new resources being worked on.
It is not meant to use as a production baseline.

```powershell
Configuration Example
{
param
(
[Parameter(Mandatory = $true)]
[PSCredential]
$credsCredential
)
Import-DscResource -ModuleName Microsoft365DSC
node localhost
{
AADSocialIdentityProvider "AADSocialIdentityProvider-Google"
{
ClientId = "Google-OAUTH";
ClientSecret = "FakeSecret";
Credential = $credsCredential;
DisplayName = "My Google Provider";
Ensure = "Present";
IdentityProviderType = "Google";
}
}
}
```

0 comments on commit a58b818

Please sign in to comment.