Skip to main content

Get-MsIdAuthorityUri

SYNOPSIS

Build Microsoft Identity Provider Authority URI

SYNTAX

Common (Default)

Get-MsIdAuthorityUri [-TenantName <String>] [-TenantId <String>] [-AppType <String>]
[-OAuth2EndpointVersion <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

AzureAd

Get-MsIdAuthorityUri [-AzureAd] [-TenantName <String>] [-TenantId <String>] [-AppType <String>]
[-OAuth2EndpointVersion <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

AzureAdB2c

Get-MsIdAuthorityUri [-AzureAdB2c] -TenantName <String> [-TenantId <String>] -Policy <String>
[-AppType <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Msa

Get-MsIdAuthorityUri [-Msa] [-AppType <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-MsIdAuthorityUri

Get common Microsoft authority URI endpoint.

EXAMPLE 2

Get-MsIdAuthorityUri -TenantId contoso.com

Get Microsoft IdP authority URI endpoint for a specific organizational tenant (Azure AD).

EXAMPLE 3

Get-MsIdAuthorityUri -AzureAd

Get Microsoft IdP authority URI endpoint for any organizational account (Azure AD).

EXAMPLE 4

Get-MsIdAuthorityUri -Msa

Get Microsoft IdP authority URI endpoint for any Microsoft consumer account (MSA).

EXAMPLE 5

Get-MsIdAuthorityUri -AzureAdB2c -TenantName contoso -Policy B2C_1_SignUp

Get Microsoft IdP authority URI endpoint for a specific organization B2C tenant (Azure AD B2C) using the B2C_1_SignUp policy.

PARAMETERS

-AzureAd

Use endpoint for organizational accounts (Azure AD).

Type: SwitchParameter
Parameter Sets: AzureAd
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AzureAdB2c

Use endpoint for organizational B2C accounts (Azure AD B2C).

Type: SwitchParameter
Parameter Sets: AzureAdB2c
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Msa

Use endpoint for Microsoft consumer accounts (MSA).

Type: SwitchParameter
Parameter Sets: Msa
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TenantName

Name of Azure AD tenant. For example: <TenantName>.onmicrosoft.com

Type: String
Parameter Sets: Common, AzureAd
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: AzureAdB2c
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TenantId

Azure AD tenant GUID or verified domain name. For example: contoso.onmicrosoft.com or contoso.com

Type: String
Parameter Sets: Common, AzureAd, AzureAdB2c
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Policy

Name of B2C Policy defined in Azure AD B2C tenant.

Type: String
Parameter Sets: AzureAdB2c
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AppType

Type of app integration ('OAuth2','Saml','WsFed'). 'OAuth2' is default.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: OAuth2
Accept pipeline input: False
Accept wildcard characters: False

-OAuth2EndpointVersion

OAuth2 endpoint version ('v1.0','v2.0'). v2.0 is default.

Type: String
Parameter Sets: Common, AzureAd
Aliases:

Required: False
Position: Named
Default value: V2.0
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.String

NOTES