Add-MgApplicationPassword

Module:

Microsoft.Graph.Applications

Adds a strong password or secret to an application.

Note

To view the beta release of this cmdlet, view Add-MgBetaApplicationPassword

Syntax

Add-MgApplicationPassword
   -ApplicationId <String>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-PasswordCredential <IMicrosoftGraphPasswordCredential>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-MgApplicationPassword
   -ApplicationId <String>
   -BodyParameter <IPaths141Ryo0ApplicationsApplicationIdMicrosoftGraphAddpasswordPostRequestbodyContentApplicationJsonSchema>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-MgApplicationPassword
   -InputObject <IApplicationsIdentity>
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-PasswordCredential <IMicrosoftGraphPasswordCredential>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-MgApplicationPassword
   -InputObject <IApplicationsIdentity>
   -BodyParameter <IPaths141Ryo0ApplicationsApplicationIdMicrosoftGraphAddpasswordPostRequestbodyContentApplicationJsonSchema>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Adds a strong password or secret to an application.

Permissions

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

Examples

Example 1: Add a password credential to an application with a six month expiry

Connect-MgGraph -Scopes 'Application.ReadWrite.All'

$appObjectId = 'eaf1e531-0d58-4874-babe-b9a9f436e6c3'

$passwordCred = @{
   displayName = 'Created in PowerShell'
   endDateTime = (Get-Date).AddMonths(6)
}

$secret = Add-MgApplicationPassword -applicationId $appObjectId -PasswordCredential $passwordCred
$secret | Format-List

CustomKeyIdentifier  :
DisplayName          : Created in PowerShell
EndDateTime          : 26/11/2022 12:03:31 pm
Hint                 : Q_e
KeyId                : c82bb763-741b-4575-9d9d-df7e766f6999
SecretText           : Q_e8Q~ZDWJD.bkgajbREp-VFFUayCuEk8b1hDcr9
StartDateTime        : 26/5/2022 1:03:31 pm
AdditionalProperties : {[@odata.context,
                       https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.passwordCredential]}

Add a password to an application that expires in six months from the current date.

Example 2: Add a password credential to an application with a start date

Connect-MgGraph -Scopes 'Application.ReadWrite.All'

$appObjectId = 'eaf1e531-0d58-4874-babe-b9a9f436e6c3'

$startDate = (Get-Date).AddDays(1).Date
$endDate = $startDate.AddMonths(6)

$passwordCred = @{
   displayName = 'Created in PowerShell'
   startDateTime = $startDate
   endDateTime = $endDate
}

$secret = Add-MgApplicationPassword -applicationId $appObjectId -PasswordCredential $passwordCred
$secret | Format-List

CustomKeyIdentifier  :
DisplayName          : Created in PowerShell
EndDateTime          : 26/11/2022 1:00:00 pm
Hint                 : TiA
KeyId                : 082bf20f-63d6-4970-bb4e-55e504f50d8b
SecretText           : TiA8Q~Zs7ej1cGtlW0qnmuFi~JlxXTZew_tU1bGA
StartDateTime        : 26/5/2022 2:00:00 pm
AdditionalProperties : {[@odata.context,
                       https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.passwordCredential]}

Add a password to an application that becomes valid at 12:00 am the next day and is valid for six months.

Use $secret.StartDateTime.ToLocalTime() to convert the returned dates from UTC to the local timezone.

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

-BodyParameter

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

Type:	IPaths141Ryo0ApplicationsApplicationIdMicrosoftGraphAddpasswordPostRequestbodyContentApplicationJsonSchema
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

-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

-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

-PasswordCredential

passwordCredential To construct, see NOTES section for PASSWORDCREDENTIAL properties and create a hash table.

Type:	IMicrosoftGraphPasswordCredential
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

-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.PowerShell.Models.IApplicationsIdentity

Microsoft.Graph.PowerShell.Models.IPaths141Ryo0ApplicationsApplicationIdMicrosoftGraphAddpasswordPostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPasswordCredential

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 <IPaths141Ryo0ApplicationsApplicationIdMicrosoftGraphAddpasswordPostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [PasswordCredential <IMicrosoftGraphPasswordCredential>]: passwordCredential
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [CustomKeyIdentifier <Byte- []>]: Do not use.
  • [DisplayName <String>]: Friendly name for the password. Optional.
  • [EndDateTime <DateTime?>]: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.
  • [Hint <String>]: Contains the first three characters of the password. Read-only.
  • [KeyId <String>]: The unique identifier for the password.
  • [SecretText <String>]: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. The generated password value is only returned during the initial POST request to addPassword. There is no way to retrieve this password in the future.
  • [StartDateTime <DateTime?>]: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.

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
• [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
• [OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant
• [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

PASSWORDCREDENTIAL <IMicrosoftGraphPasswordCredential>: passwordCredential

• [(Any) <Object>]: This indicates any property can be added to this object.
• [CustomKeyIdentifier <Byte- []>]: Do not use.
• [DisplayName <String>]: Friendly name for the password. Optional.
• [EndDateTime <DateTime?>]: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.
• [Hint <String>]: Contains the first three characters of the password. Read-only.
• [KeyId <String>]: The unique identifier for the password.
• [SecretText <String>]: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. The generated password value is only returned during the initial POST request to addPassword. There is no way to retrieve this password in the future.
• [StartDateTime <DateTime?>]: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.

Related Links

• Add-MgBetaApplicationPassword
• https://learn.microsoft.com/powershell/module/microsoft.graph.applications/add-mgapplicationpassword