Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. ApplicationOptionalClaims
Azure Active Directory (Azure AD) v6.2.0 published on Tuesday, Jan 21, 2025 by Pulumi
pulumi/pulumi-azuread

azuread.ApplicationOptionalClaims

Explore with Pulumi AI

azuread logo
Azure Active Directory (Azure AD) v6.2.0 published on Tuesday, Jan 21, 2025 by Pulumi
pulumi/pulumi-azuread

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";

const example = new azuread.ApplicationRegistration("example", {displayName: "example"});
const exampleApplicationOptionalClaims = new azuread.ApplicationOptionalClaims("example", {
    applicationId: example.id,
    accessTokens: [
        {
            name: "myclaim",
        },
        {
            name: "otherclaim",
        },
    ],
    idTokens: [{
        name: "userclaim",
        source: "user",
        essential: true,
        additionalProperties: ["emit_as_roles"],
    }],
    saml2Tokens: [{
        name: "samlexample",
    }],
});

    import pulumi
import pulumi_azuread as azuread

example = azuread.ApplicationRegistration("example", display_name="example")
example_application_optional_claims = azuread.ApplicationOptionalClaims("example",
    application_id=example.id,
    access_tokens=[
        {
            "name": "myclaim",
        },
        {
            "name": "otherclaim",
        },
    ],
    id_tokens=[{
        "name": "userclaim",
        "source": "user",
        "essential": True,
        "additional_properties": ["emit_as_roles"],
    }],
    saml2_tokens=[{
        "name": "samlexample",
    }])

    package main

import (
	"github.com/pulumi/pulumi-azuread/sdk/v6/go/azuread"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
			DisplayName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = azuread.NewApplicationOptionalClaims(ctx, "example", &azuread.ApplicationOptionalClaimsArgs{
			ApplicationId: example.ID(),
			AccessTokens: azuread.ApplicationOptionalClaimsAccessTokenArray{
				&azuread.ApplicationOptionalClaimsAccessTokenArgs{
					Name: pulumi.String("myclaim"),
				},
				&azuread.ApplicationOptionalClaimsAccessTokenArgs{
					Name: pulumi.String("otherclaim"),
				},
			},
			IdTokens: azuread.ApplicationOptionalClaimsIdTokenArray{
				&azuread.ApplicationOptionalClaimsIdTokenArgs{
					Name:      pulumi.String("userclaim"),
					Source:    pulumi.String("user"),
					Essential: pulumi.Bool(true),
					AdditionalProperties: pulumi.StringArray{
						pulumi.String("emit_as_roles"),
					},
				},
			},
			Saml2Tokens: azuread.ApplicationOptionalClaimsSaml2TokenArray{
				&azuread.ApplicationOptionalClaimsSaml2TokenArgs{
					Name: pulumi.String("samlexample"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureAD = Pulumi.AzureAD;

return await Deployment.RunAsync(() => 
{
    var example = new AzureAD.ApplicationRegistration("example", new()
    {
        DisplayName = "example",
    });

    var exampleApplicationOptionalClaims = new AzureAD.ApplicationOptionalClaims("example", new()
    {
        ApplicationId = example.Id,
        AccessTokens = new[]
        {
            new AzureAD.Inputs.ApplicationOptionalClaimsAccessTokenArgs
            {
                Name = "myclaim",
            },
            new AzureAD.Inputs.ApplicationOptionalClaimsAccessTokenArgs
            {
                Name = "otherclaim",
            },
        },
        IdTokens = new[]
        {
            new AzureAD.Inputs.ApplicationOptionalClaimsIdTokenArgs
            {
                Name = "userclaim",
                Source = "user",
                Essential = true,
                AdditionalProperties = new[]
                {
                    "emit_as_roles",
                },
            },
        },
        Saml2Tokens = new[]
        {
            new AzureAD.Inputs.ApplicationOptionalClaimsSaml2TokenArgs
            {
                Name = "samlexample",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuread.ApplicationRegistration;
import com.pulumi.azuread.ApplicationRegistrationArgs;
import com.pulumi.azuread.ApplicationOptionalClaims;
import com.pulumi.azuread.ApplicationOptionalClaimsArgs;
import com.pulumi.azuread.inputs.ApplicationOptionalClaimsAccessTokenArgs;
import com.pulumi.azuread.inputs.ApplicationOptionalClaimsIdTokenArgs;
import com.pulumi.azuread.inputs.ApplicationOptionalClaimsSaml2TokenArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ApplicationRegistration("example", ApplicationRegistrationArgs.builder()
            .displayName("example")
            .build());

        var exampleApplicationOptionalClaims = new ApplicationOptionalClaims("exampleApplicationOptionalClaims", ApplicationOptionalClaimsArgs.builder()
            .applicationId(example.id())
            .accessTokens(            
                ApplicationOptionalClaimsAccessTokenArgs.builder()
                    .name("myclaim")
                    .build(),
                ApplicationOptionalClaimsAccessTokenArgs.builder()
                    .name("otherclaim")
                    .build())
            .idTokens(ApplicationOptionalClaimsIdTokenArgs.builder()
                .name("userclaim")
                .source("user")
                .essential(true)
                .additionalProperties("emit_as_roles")
                .build())
            .saml2Tokens(ApplicationOptionalClaimsSaml2TokenArgs.builder()
                .name("samlexample")
                .build())
            .build());

    }
}

    resources:
  example:
    type: azuread:ApplicationRegistration
    properties:
      displayName: example
  exampleApplicationOptionalClaims:
    type: azuread:ApplicationOptionalClaims
    name: example
    properties:
      applicationId: ${example.id}
      accessTokens:
        - name: myclaim
        - name: otherclaim
      idTokens:
        - name: userclaim
          source: user
          essential: true
          additionalProperties:
            - emit_as_roles
      saml2Tokens:
        - name: samlexample

    Create ApplicationOptionalClaims Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApplicationOptionalClaims(name: string, args: ApplicationOptionalClaimsArgs, opts?: CustomResourceOptions);
    @overload
def ApplicationOptionalClaims(resource_name: str,
                              args: ApplicationOptionalClaimsInitArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def ApplicationOptionalClaims(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              application_id: Optional[str] = None,
                              access_tokens: Optional[Sequence[ApplicationOptionalClaimsAccessTokenArgs]] = None,
                              id_tokens: Optional[Sequence[ApplicationOptionalClaimsIdTokenArgs]] = None,
                              saml2_tokens: Optional[Sequence[ApplicationOptionalClaimsSaml2TokenArgs]] = None)
    func NewApplicationOptionalClaims(ctx *Context, name string, args ApplicationOptionalClaimsArgs, opts ...ResourceOption) (*ApplicationOptionalClaims, error)
    public ApplicationOptionalClaims(string name, ApplicationOptionalClaimsArgs args, CustomResourceOptions? opts = null)
    public ApplicationOptionalClaims(String name, ApplicationOptionalClaimsArgs args)
public ApplicationOptionalClaims(String name, ApplicationOptionalClaimsArgs args, CustomResourceOptions options)

    type: azuread:ApplicationOptionalClaims
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApplicationOptionalClaimsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApplicationOptionalClaimsInitArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApplicationOptionalClaimsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationOptionalClaimsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationOptionalClaimsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var applicationOptionalClaimsResource = new AzureAD.ApplicationOptionalClaims("applicationOptionalClaimsResource", new()
{
    ApplicationId = "string",
    AccessTokens = new[]
    {
        new AzureAD.Inputs.ApplicationOptionalClaimsAccessTokenArgs
        {
            Name = "string",
            AdditionalProperties = new[]
            {
                "string",
            },
            Essential = false,
            Source = "string",
        },
    },
    IdTokens = new[]
    {
        new AzureAD.Inputs.ApplicationOptionalClaimsIdTokenArgs
        {
            Name = "string",
            AdditionalProperties = new[]
            {
                "string",
            },
            Essential = false,
            Source = "string",
        },
    },
    Saml2Tokens = new[]
    {
        new AzureAD.Inputs.ApplicationOptionalClaimsSaml2TokenArgs
        {
            Name = "string",
            AdditionalProperties = new[]
            {
                "string",
            },
            Essential = false,
            Source = "string",
        },
    },
});

    example, err := azuread.NewApplicationOptionalClaims(ctx, "applicationOptionalClaimsResource", &azuread.ApplicationOptionalClaimsArgs{
	ApplicationId: pulumi.String("string"),
	AccessTokens: azuread.ApplicationOptionalClaimsAccessTokenArray{
		&azuread.ApplicationOptionalClaimsAccessTokenArgs{
			Name: pulumi.String("string"),
			AdditionalProperties: pulumi.StringArray{
				pulumi.String("string"),
			},
			Essential: pulumi.Bool(false),
			Source:    pulumi.String("string"),
		},
	},
	IdTokens: azuread.ApplicationOptionalClaimsIdTokenArray{
		&azuread.ApplicationOptionalClaimsIdTokenArgs{
			Name: pulumi.String("string"),
			AdditionalProperties: pulumi.StringArray{
				pulumi.String("string"),
			},
			Essential: pulumi.Bool(false),
			Source:    pulumi.String("string"),
		},
	},
	Saml2Tokens: azuread.ApplicationOptionalClaimsSaml2TokenArray{
		&azuread.ApplicationOptionalClaimsSaml2TokenArgs{
			Name: pulumi.String("string"),
			AdditionalProperties: pulumi.StringArray{
				pulumi.String("string"),
			},
			Essential: pulumi.Bool(false),
			Source:    pulumi.String("string"),
		},
	},
})

    var applicationOptionalClaimsResource = new ApplicationOptionalClaims("applicationOptionalClaimsResource", ApplicationOptionalClaimsArgs.builder()
    .applicationId("string")
    .accessTokens(ApplicationOptionalClaimsAccessTokenArgs.builder()
        .name("string")
        .additionalProperties("string")
        .essential(false)
        .source("string")
        .build())
    .idTokens(ApplicationOptionalClaimsIdTokenArgs.builder()
        .name("string")
        .additionalProperties("string")
        .essential(false)
        .source("string")
        .build())
    .saml2Tokens(ApplicationOptionalClaimsSaml2TokenArgs.builder()
        .name("string")
        .additionalProperties("string")
        .essential(false)
        .source("string")
        .build())
    .build());

    application_optional_claims_resource = azuread.ApplicationOptionalClaims("applicationOptionalClaimsResource",
    application_id="string",
    access_tokens=[{
        "name": "string",
        "additional_properties": ["string"],
        "essential": False,
        "source": "string",
    }],
    id_tokens=[{
        "name": "string",
        "additional_properties": ["string"],
        "essential": False,
        "source": "string",
    }],
    saml2_tokens=[{
        "name": "string",
        "additional_properties": ["string"],
        "essential": False,
        "source": "string",
    }])

    const applicationOptionalClaimsResource = new azuread.ApplicationOptionalClaims("applicationOptionalClaimsResource", {
    applicationId: "string",
    accessTokens: [{
        name: "string",
        additionalProperties: ["string"],
        essential: false,
        source: "string",
    }],
    idTokens: [{
        name: "string",
        additionalProperties: ["string"],
        essential: false,
        source: "string",
    }],
    saml2Tokens: [{
        name: "string",
        additionalProperties: ["string"],
        essential: false,
        source: "string",
    }],
});

    type: azuread:ApplicationOptionalClaims
properties:
    accessTokens:
        - additionalProperties:
            - string
          essential: false
          name: string
          source: string
    applicationId: string
    idTokens:
        - additionalProperties:
            - string
          essential: false
          name: string
          source: string
    saml2Tokens:
        - additionalProperties:
            - string
          essential: false
          name: string
          source: string

    ApplicationOptionalClaims Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApplicationOptionalClaims resource accepts the following input properties:

    ApplicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    AccessTokens List<Pulumi.AzureAD.Inputs.ApplicationOptionalClaimsAccessToken>
    One or more access_token blocks as documented below.
    IdTokens List<Pulumi.AzureAD.Inputs.ApplicationOptionalClaimsIdToken>
    One or more id_token blocks as documented below.
    Saml2Tokens List<Pulumi.AzureAD.Inputs.ApplicationOptionalClaimsSaml2Token>

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    ApplicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    AccessTokens []ApplicationOptionalClaimsAccessTokenArgs
    One or more access_token blocks as documented below.
    IdTokens []ApplicationOptionalClaimsIdTokenArgs
    One or more id_token blocks as documented below.
    Saml2Tokens []ApplicationOptionalClaimsSaml2TokenArgs

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    applicationId String
    The resource ID of the application registration. Changing this forces a new resource to be created.
    accessTokens List<ApplicationOptionalClaimsAccessToken>
    One or more access_token blocks as documented below.
    idTokens List<ApplicationOptionalClaimsIdToken>
    One or more id_token blocks as documented below.
    saml2Tokens List<ApplicationOptionalClaimsSaml2Token>

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    applicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    accessTokens ApplicationOptionalClaimsAccessToken[]
    One or more access_token blocks as documented below.
    idTokens ApplicationOptionalClaimsIdToken[]
    One or more id_token blocks as documented below.
    saml2Tokens ApplicationOptionalClaimsSaml2Token[]

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    application_id str
    The resource ID of the application registration. Changing this forces a new resource to be created.
    access_tokens Sequence[ApplicationOptionalClaimsAccessTokenArgs]
    One or more access_token blocks as documented below.
    id_tokens Sequence[ApplicationOptionalClaimsIdTokenArgs]
    One or more id_token blocks as documented below.
    saml2_tokens Sequence[ApplicationOptionalClaimsSaml2TokenArgs]

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    applicationId String
    The resource ID of the application registration. Changing this forces a new resource to be created.
    accessTokens List<Property Map>
    One or more access_token blocks as documented below.
    idTokens List<Property Map>
    One or more id_token blocks as documented below.
    saml2Tokens List<Property Map>

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApplicationOptionalClaims resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApplicationOptionalClaims Resource

    Get an existing ApplicationOptionalClaims resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApplicationOptionalClaimsState, opts?: CustomResourceOptions): ApplicationOptionalClaims
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tokens: Optional[Sequence[ApplicationOptionalClaimsAccessTokenArgs]] = None,
        application_id: Optional[str] = None,
        id_tokens: Optional[Sequence[ApplicationOptionalClaimsIdTokenArgs]] = None,
        saml2_tokens: Optional[Sequence[ApplicationOptionalClaimsSaml2TokenArgs]] = None) -> ApplicationOptionalClaims
    func GetApplicationOptionalClaims(ctx *Context, name string, id IDInput, state *ApplicationOptionalClaimsState, opts ...ResourceOption) (*ApplicationOptionalClaims, error)
    public static ApplicationOptionalClaims Get(string name, Input<string> id, ApplicationOptionalClaimsState? state, CustomResourceOptions? opts = null)
    public static ApplicationOptionalClaims get(String name, Output<String> id, ApplicationOptionalClaimsState state, CustomResourceOptions options)
    resources:  _:    type: azuread:ApplicationOptionalClaims    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessTokens List<Pulumi.AzureAD.Inputs.ApplicationOptionalClaimsAccessToken>
    One or more access_token blocks as documented below.
    ApplicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    IdTokens List<Pulumi.AzureAD.Inputs.ApplicationOptionalClaimsIdToken>
    One or more id_token blocks as documented below.
    Saml2Tokens List<Pulumi.AzureAD.Inputs.ApplicationOptionalClaimsSaml2Token>

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    AccessTokens []ApplicationOptionalClaimsAccessTokenArgs
    One or more access_token blocks as documented below.
    ApplicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    IdTokens []ApplicationOptionalClaimsIdTokenArgs
    One or more id_token blocks as documented below.
    Saml2Tokens []ApplicationOptionalClaimsSaml2TokenArgs

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    accessTokens List<ApplicationOptionalClaimsAccessToken>
    One or more access_token blocks as documented below.
    applicationId String
    The resource ID of the application registration. Changing this forces a new resource to be created.
    idTokens List<ApplicationOptionalClaimsIdToken>
    One or more id_token blocks as documented below.
    saml2Tokens List<ApplicationOptionalClaimsSaml2Token>

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    accessTokens ApplicationOptionalClaimsAccessToken[]
    One or more access_token blocks as documented below.
    applicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    idTokens ApplicationOptionalClaimsIdToken[]
    One or more id_token blocks as documented below.
    saml2Tokens ApplicationOptionalClaimsSaml2Token[]

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    access_tokens Sequence[ApplicationOptionalClaimsAccessTokenArgs]
    One or more access_token blocks as documented below.
    application_id str
    The resource ID of the application registration. Changing this forces a new resource to be created.
    id_tokens Sequence[ApplicationOptionalClaimsIdTokenArgs]
    One or more id_token blocks as documented below.
    saml2_tokens Sequence[ApplicationOptionalClaimsSaml2TokenArgs]

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    accessTokens List<Property Map>
    One or more access_token blocks as documented below.
    applicationId String
    The resource ID of the application registration. Changing this forces a new resource to be created.
    idTokens List<Property Map>
    One or more id_token blocks as documented below.
    saml2Tokens List<Property Map>

    One or more saml2_token blocks as documented below.

    At least one of access_token, id_token or saml2_token must be specified

    Supporting Types

    ApplicationOptionalClaimsAccessToken, ApplicationOptionalClaimsAccessTokenArgs

    Name string
    The name of the optional claim.
    AdditionalProperties List<string>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    Essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    Source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    Name string
    The name of the optional claim.
    AdditionalProperties []string
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    Essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    Source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name String
    The name of the optional claim.
    additionalProperties List<String>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential Boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source String
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name string
    The name of the optional claim.
    additionalProperties string[]
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name str
    The name of the optional claim.
    additional_properties Sequence[str]
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source str
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name String
    The name of the optional claim.
    additionalProperties List<String>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential Boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source String
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.

    ApplicationOptionalClaimsIdToken, ApplicationOptionalClaimsIdTokenArgs

    Name string
    The name of the optional claim.
    AdditionalProperties List<string>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    Essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    Source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    Name string
    The name of the optional claim.
    AdditionalProperties []string
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    Essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    Source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name String
    The name of the optional claim.
    additionalProperties List<String>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential Boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source String
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name string
    The name of the optional claim.
    additionalProperties string[]
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name str
    The name of the optional claim.
    additional_properties Sequence[str]
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source str
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name String
    The name of the optional claim.
    additionalProperties List<String>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential Boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source String
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.

    ApplicationOptionalClaimsSaml2Token, ApplicationOptionalClaimsSaml2TokenArgs

    Name string
    The name of the optional claim.
    AdditionalProperties List<string>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    Essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    Source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    Name string
    The name of the optional claim.
    AdditionalProperties []string
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    Essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    Source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name String
    The name of the optional claim.
    additionalProperties List<String>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential Boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source String
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name string
    The name of the optional claim.
    additionalProperties string[]
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source string
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name str
    The name of the optional claim.
    additional_properties Sequence[str]
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential bool
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source str
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.
    name String
    The name of the optional claim.
    additionalProperties List<String>
    List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim. Possible values are: cloud_displayname, dns_domain_and_sam_account_name, emit_as_roles, include_externally_authenticated_upn_without_hash, include_externally_authenticated_upn, max_size_limit, netbios_domain_and_sam_account_name, on_premise_security_identifier, sam_account_name, and use_guid.
    essential Boolean
    Whether the claim specified by the client is necessary to ensure a smooth authorization experience.
    source String
    The source of the claim. If source is absent, the claim is a predefined optional claim. If source is user, the value of name is the extension property from the user object.

    Import

    Application Optional Claims can be imported using the object ID of the application, in the following format.

    $ pulumi import azuread:index/applicationOptionalClaims:ApplicationOptionalClaims example /applications/00000000-0000-0000-0000-000000000000

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Active Directory (Azure AD) pulumi/pulumi-azuread
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuread Terraform Provider.
    azuread logo
    Azure Active Directory (Azure AD) v6.2.0 published on Tuesday, Jan 21, 2025 by Pulumi
    pulumi/pulumi-azuread