1. Docs
  2. Reference
  3. API
  4. @pulumi/azuread
  5. types
  6. output

Module types/output

This page documents the language specification for the azuread package. If you're looking for help working with the inputs, outputs, or functions of azuread resources in a Pulumi program, please see the resource documentation for examples and API reference.

APIs

APIs

interface ApplicationAppRole

interface ApplicationAppRole

property allowedMemberTypes

allowedMemberTypes: string[];

Specifies whether this app role definition can be assigned to users and groups by setting to User, or to other applications (that are accessing this application in daemon service scenarios) by setting to Application, or to both.

property description

description: string;

Permission help text that appears in the admin app assignment and consent experiences.

property displayName

displayName: string;

Display name for the permission that appears in the admin consent and app assignment experiences.

property id

id: string;

The unique identifier of the appRole.

property isEnabled

isEnabled?: undefined | false | true;

Determines if the permission is enabled: defaults to true.

property value

value?: undefined | string;

The value of the scope claim that the resource application should expect in the OAuth 2.0 access token.

interface ApplicationOauth2Permission

interface ApplicationOauth2Permission

property adminConsentDescription

adminConsentDescription: string;

Permission help text that appears in the admin consent and app assignment experiences.

property adminConsentDisplayName

adminConsentDisplayName: string;

Display name for the permission that appears in the admin consent and app assignment experiences.

property id

id: string;

The unique identifier for one of the OAuth2Permission or AppRole instances that the resource application exposes.

property isEnabled

isEnabled: boolean;

Determines if the app role is enabled: Defaults to true.

property type

type: string;

Type of an application: webapp/api or native. Defaults to webapp/api. For native apps type identifierUris property can not not be set.

property userConsentDescription

userConsentDescription: string;

Permission help text that appears in the end user consent experience.

property userConsentDisplayName

userConsentDisplayName: string;

Display name for the permission that appears in the end user consent experience.

property value

value: string;

Specifies the value of the roles claim that the application should expect in the authentication and access tokens.

interface ApplicationOptionalClaims

interface ApplicationOptionalClaims

property accessTokens

accessTokens?: ApplicationOptionalClaimsAccessToken[];

property idTokens

idTokens?: ApplicationOptionalClaimsIdToken[];

interface ApplicationOptionalClaimsAccessToken

interface ApplicationOptionalClaimsAccessToken

property additionalProperties

additionalProperties?: string[];

List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.

property essential

essential?: undefined | false | true;

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

property name

name: string;

The name of the optional claim.

property source

source?: undefined | 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.

interface ApplicationOptionalClaimsIdToken

interface ApplicationOptionalClaimsIdToken

property additionalProperties

additionalProperties?: string[];

List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.

property essential

essential?: undefined | false | true;

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

property name

name: string;

The display name for the application.

property source

source?: undefined | 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.

interface ApplicationRequiredResourceAccess

interface ApplicationRequiredResourceAccess

property resourceAccesses

resourceAccesses: ApplicationRequiredResourceAccessResourceAccess[];

A collection of resourceAccess blocks as documented below.

property resourceAppId

resourceAppId: string;

The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application.

interface ApplicationRequiredResourceAccessResourceAccess

interface ApplicationRequiredResourceAccessResourceAccess

property id

id: string;

The unique identifier for one of the OAuth2Permission or AppRole instances that the resource application exposes.

property type

type: string;

Specifies whether the id property references an OAuth2Permission or an AppRole. Possible values are Scope or Role.

interface GetApplicationAppRole

interface GetApplicationAppRole

property allowedMemberTypes

allowedMemberTypes: string[];

Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in daemon service scenarios). Possible values are: User and Application, or both.

property description

description: string;

Permission help text that appears in the admin app assignment and consent experiences.

property displayName

displayName: string;

Display name for the permission that appears in the admin consent and app assignment experiences.

property id

id: string;

The unique identifier of the appRole.

property isEnabled

isEnabled: boolean;

Determines if the app role is enabled.

property value

value: string;

Specifies the value of the roles claim that the application should expect in the authentication and access tokens.

interface GetApplicationOauth2Permission

interface GetApplicationOauth2Permission

property adminConsentDescription

adminConsentDescription: string;

The description of the admin consent

property adminConsentDisplayName

adminConsentDisplayName: string;

The display name of the admin consent

property id

id: string;

The unique identifier of the appRole.

property isEnabled

isEnabled: boolean;

Determines if the app role is enabled.

property type

type: string;

The type of the permission

property userConsentDescription

userConsentDescription: string;

The description of the user consent

property userConsentDisplayName

userConsentDisplayName: string;

The display name of the user consent

property value

value: string;

Specifies the value of the roles claim that the application should expect in the authentication and access tokens.

interface GetApplicationOptionalClaims

interface GetApplicationOptionalClaims

property accessTokens

accessTokens?: GetApplicationOptionalClaimsAccessToken[];

property idTokens

idTokens?: GetApplicationOptionalClaimsIdToken[];

interface GetApplicationOptionalClaimsAccessToken

interface GetApplicationOptionalClaimsAccessToken

property additionalProperties

additionalProperties?: string[];

List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.

property essential

essential?: undefined | false | true;

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

property name

name: string;

Specifies the name of the Application within Azure Active Directory.

property source

source?: undefined | 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.

interface GetApplicationOptionalClaimsIdToken

interface GetApplicationOptionalClaimsIdToken

property additionalProperties

additionalProperties?: string[];

List of Additional Properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim.

property essential

essential?: undefined | false | true;

Whether the claim specified by the client is necessary to ensure a smooth authorization experience.

property name

name: string;

Specifies the name of the Application within Azure Active Directory.

property source

source?: undefined | 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.

interface GetApplicationRequiredResourceAccess

interface GetApplicationRequiredResourceAccess

property resourceAccesses

resourceAccesses: GetApplicationRequiredResourceAccessResourceAccess[];

A collection of resourceAccess blocks as documented below

property resourceAppId

resourceAppId: string;

The unique identifier for the resource that the application requires access to.

interface GetApplicationRequiredResourceAccessResourceAccess

interface GetApplicationRequiredResourceAccessResourceAccess

property id

id: string;

The unique identifier of the appRole.

property type

type: string;

The type of the permission

interface GetDomainsDomain

interface GetDomainsDomain

property authenticationType

authenticationType: string;

The authentication type of the domain (Managed or Federated).

property domainName

domainName: string;

The name of the domain.

property isDefault

isDefault: boolean;

True if this is the default domain that is used for user creation.

property isInitial

isInitial: boolean;

True if this is the initial domain created by Azure Activie Directory.

property isVerified

isVerified: boolean;

True if the domain has completed domain ownership verification.

interface GetServicePrincipalAppRole

interface GetServicePrincipalAppRole

property allowedMemberTypes

allowedMemberTypes: string[];

Specifies whether this app role definition can be assigned to users and groups, or to other applications (that are accessing this application in daemon service scenarios). Possible values are: User and Application, or both.

property description

description: string;

Permission help text that appears in the admin app assignment and consent experiences.

property displayName

displayName: string;

The Display Name of the Azure AD Application associated with this Service Principal.

property id

id: string;

The unique identifier of the appRole.

property isEnabled

isEnabled: boolean;

Determines if the app role is enabled.

property value

value: string;

Specifies the value of the roles claim that the application should expect in the authentication and access tokens.

interface GetServicePrincipalOauth2Permission

interface GetServicePrincipalOauth2Permission

property adminConsentDescription

adminConsentDescription: string;

The description of the admin consent

property adminConsentDisplayName

adminConsentDisplayName: string;

The display name of the admin consent

property id

id: string;

The unique identifier of the appRole.

property isEnabled

isEnabled: boolean;

Determines if the app role is enabled.

property type

type: string;

The type of the permission

property userConsentDescription

userConsentDescription: string;

The description of the user consent

property userConsentDisplayName

userConsentDisplayName: string;

The display name of the user consent

property value

value: string;

Specifies the value of the roles claim that the application should expect in the authentication and access tokens.

interface ServicePrincipalOauth2Permission

interface ServicePrincipalOauth2Permission

property adminConsentDescription

adminConsentDescription: string;

The description of the admin consent.

property adminConsentDisplayName

adminConsentDisplayName: string;

The display name of the admin consent.

property id

id: string;

The unique identifier for one of the OAuth2Permission.

property isEnabled

isEnabled: boolean;

Is this permission enabled?

property type

type: string;

The type of the permission.

property userConsentDescription

userConsentDescription: string;

The description of the user consent.

property userConsentDisplayName

userConsentDisplayName: string;

The display name of the user consent.

property value

value: string;

The name of this permission.