Edit

Share via

Remove-EntraServicePrincipalPasswordCredential

  • Reference
Module:
Microsoft.Entra

Removes a password credential from a service principal.

Syntax

Remove-EntraServicePrincipalPasswordCredential
      -ServicePrincipalId <String>
      -KeyId <String>
      [<CommonParameters>]

Description

The Remove-EntraServicePrincipalPasswordCredential cmdlet removes a password credential from a service principal in Microsoft Entra ID.

Examples

Example 1: Remove a password credential from a service principal in Microsoft Entra ID

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
$key = Get-EntraServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id
$key = $key | Where-Object {$_.DisplayName -eq 'Helpdesk secret'}
Remove-EntraServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id -KeyId $key.KeyId

This example demonstrates how to remove a password credential from a service principal in Microsoft Entra ID.

  • -ServicePrincipalId parameter specifies the ServicePrincipalId of a specified Service Principal Password Credential.
  • -KeyId parameter specifies the unique identifier of a Password Credential.

Parameters

-KeyId

Specifies the unique identifier of password credential.

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

-ServicePrincipalId

Specifies the ID of an application in Microsoft Entra ID.

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