Update servicePrincipal

Namespace: microsoft.graph

Update the properties of servicePrincipal object.

Important

Using PATCH to set passwordCredential is not supported. Use the addPassword and removePassword methods to update the password or secret for a servicePrincipal.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

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

Note

  • To update the customSecurityAttributes property:
    • In delegated scenarios, the admin must be assigned the Attribute Assignment Administrator role and the app granted the CustomSecAttributeAssignment.ReadWrite.All delegated permission.
    • In app-only scenarios using Microsoft Graph permissions, the app must be granted the CustomSecAttributeAssignment.ReadWrite.All application permission.

HTTP request

You can address the service principal using either its id or appId. id and appId are referred to as the Object ID and Application (Client) ID, respectively, in app registrations in the Microsoft Entra admin center.

PATCH /servicePrincipals/{id}
PATCH /servicePrincipals(appId='{appId}')

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

Property Type Description
accountEnabled Boolean true if the service principal account is enabled; otherwise, false.
addIns addIn Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.
alternativeNames String collection Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities.
appRoleAssignmentRequired Boolean Specifies whether an appRoleAssignment to a user or group is required before Microsoft Entra ID will issue a user or access token to the application. Not nullable.
appRoles appRole collection The application roles exposed by the associated application. For more information, see the appRoles property definition on the application resource. Not nullable.
customSecurityAttributes customSecurityAttributeValue An open complex type that holds the value of a custom security attribute that is assigned to a directory object.
  • To update this property in delegated scenarios, the calling principal must be assigned the Attribute Assignment Administrator role and the app granted the CustomSecAttributeAssignment.ReadWrite.All delegated permission.
  • To update this property in app-only scenarios with Microsoft Graph permissions, the app must be granted the CustomSecAttributeAssignment.ReadWrite.All application permission.
  • displayName String The display name for the service principal.
    homepage String Home page or landing page of the application.
    keyCredentials keyCredential collection The collection of key credentials associated with the service principal. Not nullable.
    logoutUrl String Specifies the URL that will be used by Microsoft's authorization service to log out a user using front-channel, back-channel or SAML logout protocols.
    oauth2PermissionScopes permissionScope collection The OAuth 2.0 permission scopes exposed by the associated application. For more information, see the oauth2PermissionScopes property definition on the application resource. Not nullable.
    preferredSingleSignOnMode string Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are password, saml, external, and oidc.
    replyUrls String collection The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable.
    servicePrincipalNames String collection Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,
    • Client apps requesting permissions to this resource can use these URIs to specify needed permissions in the requiredResourceAccess property of their application manifest, or in the "API permissions" blade on the App registrations experience.
    • Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the "aud" claim.

    The any operator is required for filter expressions on multi-valued properties. Not nullable.
    tags String collection Custom strings that can be used to categorize and identify the application. Not nullable.
    tokenEncryptionKeyId String Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.

    Response

    If successful, this method returns a 204 No Content response code and updated servicePrincipal object in the response body.

    Example

    Example 1: Update properties of the specified service principal

    Request

    The following example shows a request.

    PATCH https://graph.microsoft.com/v1.0/servicePrincipals/{id}
    Content-type: application/json
    
    {
      "appRoleAssignmentRequired": true
    }
    

    Response

    The following example shows the response. Note: The response object shown here might be shortened for readability.

    HTTP/1.1 204 No Content
    

    Example 2: Assign a custom security attribute with a string value to a service principal

    The following example shows how to assign a custom security attribute with a string value to a service principal.

    • Attribute set: Engineering
    • Attribute: ProjectDate
    • Attribute data type: String
    • Attribute value: "2022-10-01"

    To assign custom security attributes, the calling principal must be assigned the Attribute Assignment Administrator role and must be granted the CustomSecAttributeAssignment.ReadWrite.All permission.

    For other similar examples for users, see Examples: Assign, update, list, or remove custom security attribute assignments using the Microsoft Graph API.

    Request

    The following example shows a request.

    PATCH https://graph.microsoft.com/v1.0/servicePrincipals/{id}
    Content-type: application/json
    
    {
        "customSecurityAttributes":
        {
            "Engineering":
            {
                "@odata.type":"#Microsoft.DirectoryServices.CustomSecurityAttributeValue",
                "ProjectDate":"2022-10-01"
            }
        }
    }
    

    Response

    The following example shows the response.

    HTTP/1.1 204 No Content