Update-MgBetaApplicationFederatedIdentityCredentialByName

Module:

Microsoft.Graph.Beta.Applications

Create a new federatedIdentityCredential object for an application if it doesn't exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.

Note

To view the v1.0 release of this cmdlet, view Update-MgApplicationFederatedIdentityCredentialByName

Syntax

Update-MgBetaApplicationFederatedIdentityCredentialByName
      -ApplicationId <String>
      -Name <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-Audiences <String[]>]
      [-Description <String>]
      [-Id <String>]
      [-Issuer <String>]
      [-Name1 <String>]
      [-Subject <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgBetaApplicationFederatedIdentityCredentialByName
      -ApplicationId <String>
      -Name <String>
      -BodyParameter <IMicrosoftGraphFederatedIdentityCredential>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgBetaApplicationFederatedIdentityCredentialByName
      [-Name <String>]
      -InputObject <IApplicationsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-Audiences <String[]>]
      [-Description <String>]
      [-Id <String>]
      [-Issuer <String>]
      [-Subject <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgBetaApplicationFederatedIdentityCredentialByName
      -InputObject <IApplicationsIdentity>
      -BodyParameter <IMicrosoftGraphFederatedIdentityCredential>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Create a new federatedIdentityCredential object for an application if it doesn't exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Application.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Application.ReadWrite.All	Not available.
Application	Application.ReadWrite.OwnedBy	Application.ReadWrite.All

Parameters

-AdditionalProperties

Additional Parameters

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

-ApplicationId

The unique identifier of application

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

-Audiences

The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

federatedIdentityCredential To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

The un-validated, user-provided description of the federated identity credential. It has a limit of 600 characters. Optional.

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

-Headers

Optional headers that will be added to the request.

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

-Id

The unique identifier for an entity. Read-only.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Issuer

The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. It has a limit of 600 characters. Required.

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

-Name

Alternate key of federatedIdentityCredential

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

-Name1

The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created. Alternate key. Required. Not nullable. Supports $filter (eq).

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

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

-Subject

Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Microsoft Entra ID. The combination of issuer and subject must be unique on the app. It has a limit of 600 characters. Supports $filter (eq).

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

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IApplicationsIdentity

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphFederatedIdentityCredential

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphFederatedIdentityCredential

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphFederatedIdentityCredential>: federatedIdentityCredential

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Id <String>]: The unique identifier for an entity. Read-only.
• [Audiences <String- []>]: The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required.
• [Description <String>]: The un-validated, user-provided description of the federated identity credential. It has a limit of 600 characters. Optional.
• [Issuer <String>]: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. It has a limit of 600 characters. Required.
• [Name <String>]: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created. Alternate key. Required. Not nullable. Supports $filter (eq).
• [Subject <String>]: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Microsoft Entra ID. The combination of issuer and subject must be unique on the app. It has a limit of 600 characters. Supports $filter (eq).

INPUTOBJECT <IApplicationsIdentity>: Identity Parameter

• [AppId <String>]: Alternate key of application
• [AppManagementPolicyId <String>]: The unique identifier of appManagementPolicy
• [AppRoleAssignmentId <String>]: The unique identifier of appRoleAssignment
• [ApplicationId <String>]: The unique identifier of application
• [ApplicationTemplateId <String>]: The unique identifier of applicationTemplate
• [ClaimsMappingPolicyId <String>]: The unique identifier of claimsMappingPolicy
• [ConnectorGroupId <String>]: The unique identifier of connectorGroup
• [ConnectorId <String>]: The unique identifier of connector
• [DelegatedPermissionClassificationId <String>]: The unique identifier of delegatedPermissionClassification
• [DirectoryDefinitionId <String>]: The unique identifier of directoryDefinition
• [DirectoryObjectId <String>]: The unique identifier of directoryObject
• [EndpointId <String>]: The unique identifier of endpoint
• [ExtensionPropertyId <String>]: The unique identifier of extensionProperty
• [FederatedIdentityCredentialId <String>]: The unique identifier of federatedIdentityCredential
• [GroupId <String>]: The unique identifier of group
• [HomeRealmDiscoveryPolicyId <String>]: The unique identifier of homeRealmDiscoveryPolicy
• [IPApplicationSegmentId <String>]: The unique identifier of ipApplicationSegment
• [LicenseDetailsId <String>]: The unique identifier of licenseDetails
• [Name <String>]: Alternate key of federatedIdentityCredential
• [OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant
• [OnPremisesAgentGroupId <String>]: The unique identifier of onPremisesAgentGroup
• [OnPremisesAgentGroupId1 <String>]: The unique identifier of onPremisesAgentGroup
• [OnPremisesAgentId <String>]: The unique identifier of onPremisesAgent
• [OnPremisesPublishingProfileId <String>]: The unique identifier of onPremisesPublishingProfile
• [PermissionGrantPreApprovalPolicyId <String>]: The unique identifier of permissionGrantPreApprovalPolicy
• [PublishedResourceId <String>]: The unique identifier of publishedResource
• [ServicePrincipalId <String>]: The unique identifier of servicePrincipal
• [SynchronizationJobId <String>]: The unique identifier of synchronizationJob
• [SynchronizationTemplateId <String>]: The unique identifier of synchronizationTemplate
• [TargetDeviceGroupId <String>]: The unique identifier of targetDeviceGroup
• [TokenIssuancePolicyId <String>]: The unique identifier of tokenIssuancePolicy
• [TokenLifetimePolicyId <String>]: The unique identifier of tokenLifetimePolicy
• [UniqueName <String>]: Alternate key of application
• [UserId <String>]: The unique identifier of user

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.applications/update-mgbetaapplicationfederatedidentitycredentialbyname
• https://learn.microsoft.com/graph/api/federatedidentitycredential-upsert?view=graph-rest-beta