Share via


IMicrosoftGraphFederatedIdentityCredential Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphFederatedIdentityCredentialTypeConverter))]
public interface IMicrosoftGraphFederatedIdentityCredential : Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphEntityAutoGenerated, Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Runtime.IAssociativeArray<object>
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphFederatedIdentityCredentialTypeConverter))>]
type IMicrosoftGraphFederatedIdentityCredential = interface
    interface IJsonSerializable
    interface IMicrosoftGraphEntityAutoGenerated
    interface IAssociativeArray<obj>
Public Interface IMicrosoftGraphFederatedIdentityCredential
Implements IAssociativeArray(Of Object), IMicrosoftGraphEntityAutoGenerated
Derived
Attributes
Implements

Properties

AdditionalProperties (Inherited from IAssociativeArray<T>)
Audience

Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD 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. Required.

Description

The un-validated, user-provided description of the federated identity credential. Optional.

Id

Read-only.

(Inherited from IMicrosoftGraphEntityAutoGenerated)
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. Required.

Item[String] (Inherited from IAssociativeArray<T>)
Name

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

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 Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq).

Methods

Add(String, T) (Inherited from IAssociativeArray<T>)
Clear() (Inherited from IAssociativeArray<T>)
ContainsKey(String) (Inherited from IAssociativeArray<T>)
Remove(String) (Inherited from IAssociativeArray<T>)
ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)
TryGetValue(String, T) (Inherited from IAssociativeArray<T>)

Applies to