AdfsNativeClientApplication - X-Guardian/AdfsDsc GitHub Wiki

AdfsNativeClientApplication

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key String Specifies the name for the native client application.
Identifier Required String Specifies the identifier for the native client application.
ApplicationGroup Identifier Required String Specifies the ID of an application group.
RedirectUri Write StringArray[] Specifies an array of redirection URIs for the OAuth 2.0 client to register with AD FS. The redirection URI is specified by the OAuth 2.0 client when it requests authorization to access a resource in ADFS.
Description Write String Specifies a description for the native client application.
LogoutUri Write String Specifies the logout URI for the OAuth 2.0 client to register with the AD FS. When AD FS initiates a logout it redirects the client's user-agent to this URI by rendering this URI in an iframe. The value of this parameter must be an absolute URI, may include a query component, and must not include a fragment component.
Ensure Write String Specifies whether the ADFS native client application should be present or absent. Default value is 'Present'. Present, Absent

Description

The AdfsNativeClientApplication DSC resource manages Native Client Applications within Active Directory Federation Services. Native Client Applications are a construct that represents a native application that runs on a phone, tablet or PC and needs to authenticate a user with ADFS.

Requirements

  • Target machine must be running ADFS on Windows Server 2016 or above to use this resource.

Examples

Example 1

This configuration will add a native client application role to an application in Active Directory Federation Services (AD FS).

Configuration AdfsNativeClientApplication_Config
{
    Import-DscResource -ModuleName AdfsDsc

    Node localhost
    {
        AdfsNativeClientApplication NativeApp1
        {
            Name                       = 'NativeApp1'
            ApplicationGroupIdentifier = 'AppGroup1'
            Identifier                 = 'e7bfb303-c5f6-4028-a360-b6293d41338c'
            RedirectUri                = 'https://nativeapp1.contoso.com'
            Description                = 'App1 Native App'
            LogoutUri                  = 'https://nativeapp1.contoso.com/logout'
        }
    }
}