Microsoft.Graph servicePrincipals
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
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.
Note
Permissions for personal Microsoft accounts cannot be used to deploy Microsoft Graph resources declared in Bicep files.
| 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 |
Resource format
To create a Microsoft.Graph/servicePrincipals resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Graph/servicePrincipals@beta' = {
accountEnabled: bool
addIns: [
{
id: 'string'
properties: [
{
key: 'string'
value: 'string'
}
]
type: 'string'
}
]
alternativeNames: [
'string'
]
appDescription: 'string'
appDisplayName: 'string'
appId: 'string'
appOwnerOrganizationId: 'string'
appRoleAssignmentRequired: bool
appRoles: [
{
allowedMemberTypes: [
'string'
]
description: 'string'
displayName: 'string'
id: 'string'
isEnabled: bool
value: 'string'
}
]
description: 'string'
disabledByMicrosoftStatus: 'string'
displayName: 'string'
homepage: 'string'
info: {
marketingUrl: 'string'
privacyStatementUrl: 'string'
supportUrl: 'string'
termsOfServiceUrl: 'string'
}
keyCredentials: [
{
customKeyIdentifier: 'string'
displayName: 'string'
endDateTime: 'string'
key: 'string'
keyId: 'string'
startDateTime: 'string'
type: 'string'
usage: 'string'
}
]
loginUrl: 'string'
logoutUrl: 'string'
notes: 'string'
notificationEmailAddresses: [
'string'
]
passwordCredentials: [
{
displayName: 'string'
endDateTime: 'string'
keyId: 'string'
startDateTime: 'string'
}
]
preferredSingleSignOnMode: 'string'
preferredTokenSigningKeyEndDateTime: 'string'
preferredTokenSigningKeyThumbprint: 'string'
publishedPermissionScopes: [
{
adminConsentDescription: 'string'
adminConsentDisplayName: 'string'
id: 'string'
isEnabled: bool
type: 'string'
userConsentDescription: 'string'
userConsentDisplayName: 'string'
value: 'string'
}
]
publisherName: 'string'
replyUrls: [
'string'
]
samlMetadataUrl: 'string'
samlSingleSignOnSettings: {
relayState: 'string'
}
servicePrincipalNames: [
'string'
]
servicePrincipalType: 'string'
tags: [
'string'
]
tokenEncryptionKeyId: 'string'
verifiedPublisher: {
addedDateTime: 'string'
displayName: 'string'
verifiedPublisherId: 'string'
}
}
Property values
servicePrincipals
| Name | Description | Value |
|---|---|---|
| accountEnabled | true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it | bool |
| addIns | 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. | MicrosoftGraphAddIn[] |
| alternativeNames | Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities | string[] |
| apiVersion | The resource api version | 'beta' (ReadOnly) |
| appDescription | The description exposed by the associated application. | string |
| appDisplayName | The display name exposed by the associated application. | string |
| appId | The unique identifier for the associated application (its appId property). Alternate key | string (Required) |
| applicationTemplateId | Unique identifier of the applicationTemplate. Read-only. null if the app wasn't created from an application template. | string (ReadOnly) |
| appOwnerOrganizationId | Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| appRoleAssignmentRequired | Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable | bool |
| appRoles | The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable. | MicrosoftGraphAppRole[] |
| deletedDateTime | Date and time when this object was deleted. Always null when the object hasn't been deleted. | string (ReadOnly) |
| description | Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps displays the application description in this field. The maximum allowed size is 1,024 characters | string |
| disabledByMicrosoftStatus | Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement) | string |
| displayName | The display name for the service principal | string |
| homepage | Home page or landing page of the application. | string |
| id | The unique identifier for an entity. Read-only. | string (ReadOnly) |
| info | Basic profile information of the acquired application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Microsoft Entra apps | MicrosoftGraphInformationalUrl |
| keyCredentials | The collection of key credentials associated with the service principal. Not nullable | MicrosoftGraphKeyCredential[] |
| loginUrl | Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate. Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps. When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL. | string |
| logoutUrl | Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols. | string |
| notes | Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1,024 characters. | string |
| notificationEmailAddresses | Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications. | string[] |
| passwordCredentials | The collection of password credentials associated with the service principal. Not nullable. | MicrosoftGraphPasswordCredential[] |
| preferredSingleSignOnMode | 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 Microsoft Entra My Apps. The supported values are password, saml, notSupported, and oidc. | string |
| preferredTokenSigningKeyEndDateTime | Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint. Updating this attribute isn't currently supported. For details, see ServicePrincipal property differences. | string |
| preferredTokenSigningKeyThumbprint | This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses. For applications that aren't SAML, don't write or otherwise rely on this property. | string |
| publishedPermissionScopes | The delegated permissions exposed by the application. For more information, see the oauth2PermissionScopes property on the application entity's api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0. | MicrosoftGraphPermissionScope[] |
| publisherName | The name of the Microsoft Entra tenant that published the application. | string |
| replyUrls | 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. | string[] |
| samlMetadataUrl | The url where the service exposes SAML metadata for federation. | string |
| samlSingleSignOnSettings | The collection for settings related to saml single sign-on. | MicrosoftGraphSamlSingleSignOnSettings |
| servicePrincipalNames | Contains the list of identifiersUris, copied over from the associated application. More 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 can specify a resource URI that 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 | string[] |
| servicePrincipalType | Identifies if the service principal represents an application or a managed identity. This is set by Microsoft Entra ID internally. For a service principal that represents an application this is set as Application. For a service principal that represents a managed identity this is set as ManagedIdentity. The SocialIdp type is for internal use. | string |
| signInAudience | Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only. | string (ReadOnly) |
| tags | Custom strings that can be used to categorize and identify the service principal. Not nullable | string[] |
| tokenEncryptionKeyId | 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. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| type | The resource type | 'Microsoft.Graph/servicePrincipals' (ReadOnly) |
| verifiedPublisher | Specifies the verified publisher of the application that's linked to this service principal. | MicrosoftGraphVerifiedPublisher |
MicrosoftGraphKeyValue
| Name | Description | Value |
|---|---|---|
| key | Key. | string |
| value | Value. | string |
MicrosoftGraphAddIn
| Name | Description | Value |
|---|---|---|
| id | The unique identifier for the addIn object. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| properties | The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required. | MicrosoftGraphKeyValue[] |
| type | The unique name for the functionality exposed by the app. | string |
MicrosoftGraphAppRole
| Name | Description | Value |
|---|---|---|
| allowedMemberTypes | Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. | string[] |
| description | The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. | string |
| displayName | Display name for the permission that appears in the app role assignment and consent experiences. | string |
| id | Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| isEnabled | When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. | bool |
| origin | Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only. | string (ReadOnly) |
| value | Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , -. / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, aren't allowed. May not begin with .. | string |
MicrosoftGraphInformationalUrl
| Name | Description | Value |
|---|---|---|
| logoUrl | CDN URL to the application's logo, Read-only. | string (ReadOnly) |
| marketingUrl | Link to the application's marketing page. For example, https://www.contoso.com/app/marketing | string |
| privacyStatementUrl | Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy | string |
| supportUrl | Link to the application's support page. For example, https://www.contoso.com/app/support | string |
| termsOfServiceUrl | Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice | string |
MicrosoftGraphKeyCredential
| Name | Description | Value |
|---|---|---|
| customKeyIdentifier | A 40-character binary type that can be used to identify the credential. Optional. When not provided in the payload, defaults to the thumbprint of the certificate. | string |
| displayName | Friendly name for the key. Optional. | string |
| endDateTime | The date and time at which the credential expires. The DateTimeOffset 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. | string |
| key | Value for the key credential. Should be a Base64 encoded value. From a .cer certificate, you can read the key using the Convert.ToBase64String() method. For more information, see Get the certificate key. | string |
| keyId | The unique identifier for the key. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| startDateTime | The date and time at which the credential 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. | string |
| type | The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword. | string |
| usage | A string that describes the purpose for which the key can be used; for example, None, Verify, PairwiseIdentifier, Delegation, Decrypt, Encrypt, HashedIdentifier, SelfSignedTls, or Sign. If usage is Sign, the type should be X509CertAndPassword, and the passwordCredentials for signing should be defined. | string |
MicrosoftGraphPasswordCredential
| Name | Description | Value |
|---|---|---|
| displayName | Friendly name for the password. Optional. | string |
| endDateTime | 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. | string |
| hint | Contains the first three characters of the password. Read-only. | string (ReadOnly) |
| keyId | The unique identifier for the password. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| secretText | 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. | string (ReadOnly) |
| startDateTime | 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. | string |
MicrosoftGraphPermissionScope
| Name | Description | Value |
|---|---|---|
| adminConsentDescription | A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. | string |
| adminConsentDisplayName | The permission's title, intended to be read by an administrator granting the permission on behalf of all users. | string |
| id | Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| isEnabled | When you create or update a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. | bool |
| type | The possible values are: User and Admin. Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required. While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission). For more information, see Configure how users consent to applications. | string |
| userConsentDescription | A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. | string |
| userConsentDisplayName | A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. | string |
| value | Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , -. / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, aren't allowed. May not begin with .. | string |
MicrosoftGraphSamlSingleSignOnSettings
| Name | Description | Value |
|---|---|---|
| relayState | The relative URI the service provider would redirect to after completion of the single sign-on flow. | string |
MicrosoftGraphVerifiedPublisher
| Name | Description | Value |
|---|---|---|
| addedDateTime | The timestamp when the verified publisher was first added or most recently updated. | string |
| displayName | The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account. | string |
| verifiedPublisherId | The ID of the verified publisher from the app publisher's Partner Center account. | string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for