Add-AdfsWebApiApplication

Add-AdfsWebApiApplication is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.

Synopsis

Adds a Web API application role to an application in AD FS.

Description

The Add-AdfsWebApiApplication cmdlet adds a Web API application role to an application in Active Directory Federation Services (AD FS).

Parameters

 -AccessControlPolicyName
Specifies the name of an access control policy.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-AccessControlPolicyParameters <Object>
    Specifies the parameters of an access control policy.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-AdditionalAuthenticationRules <String>
    Specifies additional authentication rules.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-AdditionalAuthenticationRulesFile <String>
    Specifies a file that contains all the rules for additional authentication for this relying party.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-AllowedAuthenticationClassReferences <String[]>
    Specifies an array of allow authentication class references.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-AllowedClientTypes <AllowedClientTypes>
    Specifies allowed client types. The acceptable values for this parameter are:

    -- None 
    -- Public 
    -- Confidential

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-AlwaysRequireAuthentication <SwitchParameter>
    Indicates that this Web API application role always requires authentication, even if it previously authenticated credentials for access. Specify this parameter to require users to always supply credentials to access sensitive resources.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-ApplicationGroup <ApplicationGroup>
    Specifies an application group.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true(ByValue)
    Accept wildcard characters?  false

-ApplicationGroupIdentifier <String>
    Specifies the ID of an application group.

    Required?                    true
    Position?                    1
    Default value                none
    Accept pipeline input?       true(ByValue,ByPropertyName)
    Accept wildcard characters?  false

-ClaimsProviderName <String[]>
    Specifies an array of claims provider names that you can configure for a relying party trust for Home Realm Discovery (HRD) scenario.


    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-DelegationAuthorizationRules <String>
    Specifies delegation authorization rules.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-DelegationAuthorizationRulesFile <String>
    Specifies a file that contains all the rules for delegation authentication for this relying party.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Description <String>
    Specifies a description.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Identifier <String[]>
    Specifies an array of identifiers.

    Required?                    true
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ImpersonationAuthorizationRules <String>
    Specifies the impersonation authorization rules.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-ImpersonationAuthorizationRulesFile <String>
    Specifies a file that contains all the rules for impersonation authentication for this relying party.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-IssuanceAuthorizationRules <String>
    Specifies the issuance authorization rules.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-IssuanceAuthorizationRulesFile <String>
    Specifies a file that contains all the rules for issuance authentication for this relying party.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-IssuanceTransformRules <String>
    Specifies the issuance transform rules.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-IssuanceTransformRulesFile <String>
    Specifies a file that contains all the rules for issuance transform for this relying party.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-IssueOAuthRefreshTokensTo <RefreshTokenIssuanceDeviceTypes>
    Specifies the refresh token issuance device types. The acceptable values for this parameter are:

    -- NoDevice 
    -- WorkplaceJoinedDevices 
    -- AllDevices

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Name <String>
    Specifies a name.

    Required?                    true
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-NotBeforeSkew <Int32>
    Specifies the not before skew value.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-PassThru <SwitchParameter>
    Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-RefreshTokenProtectionEnabled <Boolean>
    Indicates whether refresh token protection is enabled.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-RequestMFAFromClaimsProviders <SwitchParameter>
    Indicates that the request MFA from claims providers option is used.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       true(ByPropertyName)
    Accept wildcard characters?  false

-TokenLifetime <Int32>
    Specifies the token lifetime.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?                    false
Position?                    named
Default value                false
Accept pipeline input?       false
Accept wildcard characters?  false

Syntax

Add-AdfsWebApiApplication [-ApplicationGroupIdentifier] <String> -Name <String> -Identifier <String[]> [-AllowedAuthenticationClassReferences <String[]>] [-ClaimsProviderName <String[]>] [-IssuanceAuthorizationRules <String>] [-IssuanceAuthorizationRulesFile <String>] [-DelegationAuthorizationRules <String>] [-DelegationAuthorizationRulesFile <String>] [-ImpersonationAuthorizationRules <String>] [-ImpersonationAuthorizationRulesFile <String>] [-IssuanceTransformRules <String>] [-IssuanceTransformRulesFile <String>] [-AdditionalAuthenticationRules <String>] [-AdditionalAuthenticationRulesFile <String>] [-AccessControlPolicyName <String>] [-AccessControlPolicyParameters <Object>] [-NotBeforeSkew <Int32>] [-Description <String>] [-TokenLifetime <Int32>] [-AlwaysRequireAuthentication] [-AllowedClientTypes <AllowedClientTypes>] [-IssueOAuthRefreshTokensTo <RefreshTokenIssuanceDeviceTypes>] [-RefreshTokenProtectionEnabled <Boolean>] [-RequestMFAFromClaimsProviders] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

Add-AdfsWebApiApplication [-ApplicationGroup] <ApplicationGroup> -Name <String> -Identifier <String[]> [-AllowedAuthenticationClassReferences <String[]>] [-ClaimsProviderName <String[]>] [-IssuanceAuthorizationRules <String>] [-IssuanceAuthorizationRulesFile <String>] [-DelegationAuthorizationRules <String>] [-DelegationAuthorizationRulesFile <String>] [-ImpersonationAuthorizationRules <String>] [-ImpersonationAuthorizationRulesFile <String>] [-IssuanceTransformRules <String>] [-IssuanceTransformRulesFile <String>] [-AdditionalAuthenticationRules <String>] [-AdditionalAuthenticationRulesFile <String>] [-AccessControlPolicyName <String>] [-AccessControlPolicyParameters <Object>] [-NotBeforeSkew <Int32>] [-Description <String>] [-TokenLifetime <Int32>] [-AlwaysRequireAuthentication] [-AllowedClientTypes <AllowedClientTypes>] [-IssueOAuthRefreshTokensTo <RefreshTokenIssuanceDeviceTypes>] [-RefreshTokenProtectionEnabled <Boolean>] [-RequestMFAFromClaimsProviders] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

You can check the Version, CommandType and Source of this cmdlet by giving below command

Get-Command Add-AdfsWebApiApplication

You can also read about

To know more PowerShell cmdlets(Commands) on Active Directory Federation Services(ADFS) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft