ServicePrincipal

Represents an instance of an application in a directory. A service principal is the local representation or application instance of a global application object in a single tenant. It defines what the app can do in the tenant, who can access it, and what resources the app can access.

AuthenticationAuthorizationIdentityMicrosoftMicrosoft EntraOAuthOpenID ConnectSAMLSCIMSingle Sign-OnZero Trust

Properties

Name Type Description
accountEnabled boolean True if the service principal account is enabled.
appDescription ['string', 'null'] Description copied from the associated application.
appDisplayName ['string', 'null'] The display name exposed by the associated application.
appId string The unique identifier for the associated application (its appId property). Required on creation.
appOwnerOrganizationId ['string', 'null'] Contains the tenant ID where the application is registered.
appRoleAssignmentRequired boolean Specifies whether users or other service principals need to be granted an app role assignment before accessing.
appRoles array Roles exposed by the associated application.
displayName string The display name for the service principal.
homepage ['string', 'null'] Home page or landing page of the application.
keyCredentials array
loginUrl ['string', 'null'] URL for the authentication provider to redirect users to for sign-in.
logoutUrl ['string', 'null']
notificationEmailAddresses array Email addresses where Azure AD sends notifications when the active certificate is near expiration.
oauth2PermissionScopes array The delegated permissions exposed by the application.
passwordCredentials array
replyUrls array The URLs that user tokens are sent to for sign-in, or the redirect URIs for authorization code and access token responses.
servicePrincipalNames array Contains the list of identifierUris and the appId from the associated application.
servicePrincipalType string Identifies whether the service principal represents an Application, ManagedIdentity, Legacy, or SocialIdp.
signInAudience string The audience that can sign in.
tags array Custom strings used to categorize the service principal. The WindowsAzureActiveDirectoryIntegratedApp tag is used by the portal.
tokenEncryptionKeyId ['string', 'null']
View JSON Schema on GitHub