Package com.microsoft.graph.models

Class ServicePrincipal

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.DirectoryObject
com.microsoft.graph.models.ServicePrincipal
All Implemented Interfaces:
com.microsoft.graph.serializer.IJsonBackedObject
public class ServicePrincipal extends DirectoryObject implements com.microsoft.graph.serializer.IJsonBackedObject
The class for the Service Principal.

  • Field Details

    • accountEnabled

      @SerializedName(value="accountEnabled", alternate="AccountEnabled") @Expose @Nullable public Boolean accountEnabled
      The Account Enabled. true if the service principal account is enabled; otherwise, false. If set to false, then no users will be able to sign in to this app, even if they are assigned to it. Supports $filter (eq, ne, not, in).

    • addIns

      @SerializedName(value="addIns", alternate="AddIns") @Expose @Nullable public List<AddIn> addIns
      The Add Ins. 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 will let services like Microsoft 365 call the application in the context of a document the user is working on.

    • alternativeNames

      @SerializedName(value="alternativeNames", alternate="AlternativeNames") @Expose @Nullable public List<String> alternativeNames
      The Alternative Names. Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, not, ge, le, startsWith).

    • appDescription

      @SerializedName(value="appDescription", alternate="AppDescription") @Expose @Nullable public String appDescription
      The App Description. The description exposed by the associated application.

    • appDisplayName

      @SerializedName(value="appDisplayName", alternate="AppDisplayName") @Expose @Nullable public String appDisplayName
      The App Display Name. The display name exposed by the associated application.

    • appId

      @SerializedName(value="appId", alternate="AppId") @Expose @Nullable public String appId
      The App Id. The unique identifier for the associated application (its appId property). Supports $filter (eq, ne, not, in, startsWith).

    • applicationTemplateId

      @SerializedName(value="applicationTemplateId", alternate="ApplicationTemplateId") @Expose @Nullable public String applicationTemplateId
      The Application Template Id. Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter (eq, ne, NOT, startsWith).

    • appOwnerOrganizationId

      @SerializedName(value="appOwnerOrganizationId", alternate="AppOwnerOrganizationId") @Expose @Nullable public UUID appOwnerOrganizationId
      The App Owner Organization Id. Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).

    • appRoleAssignmentRequired

      @SerializedName(value="appRoleAssignmentRequired", alternate="AppRoleAssignmentRequired") @Expose @Nullable public Boolean appRoleAssignmentRequired
      The App Role Assignment Required. 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. Supports $filter (eq, ne, NOT).

    • appRoles

      @SerializedName(value="appRoles", alternate="AppRoles") @Expose @Nullable public List<AppRole> appRoles
      The App Roles. 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.

    • description

      @SerializedName(value="description", alternate="Description") @Expose @Nullable public String description
      The Description. Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.

    • disabledByMicrosoftStatus

      @SerializedName(value="disabledByMicrosoftStatus", alternate="DisabledByMicrosoftStatus") @Expose @Nullable public String disabledByMicrosoftStatus
      The Disabled By Microsoft Status. 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). Supports $filter (eq, ne, not).

    • displayName

      @SerializedName(value="displayName", alternate="DisplayName") @Expose @Nullable public String displayName
      The Display Name. The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.

    • homepage

      @SerializedName(value="homepage", alternate="Homepage") @Expose @Nullable public String homepage
      The Homepage. Home page or landing page of the application.

    • info

      @SerializedName(value="info", alternate="Info") @Expose @Nullable public InformationalUrl info
      The 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 Azure AD apps. Supports $filter (eq, ne, not, ge, le, and eq on null values).

    • keyCredentials

      @SerializedName(value="keyCredentials", alternate="KeyCredentials") @Expose @Nullable public List<KeyCredential> keyCredentials
      The Key Credentials. The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le).

    • loginUrl

      @SerializedName(value="loginUrl", alternate="LoginUrl") @Expose @Nullable public String loginUrl
      The Login Url. Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.

    • logoutUrl

      @SerializedName(value="logoutUrl", alternate="LogoutUrl") @Expose @Nullable public String logoutUrl
      The Logout Url. Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols.

    • notes

      @SerializedName(value="notes", alternate="Notes") @Expose @Nullable public String notes
      The Notes. Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.

    • notificationEmailAddresses

      @SerializedName(value="notificationEmailAddresses", alternate="NotificationEmailAddresses") @Expose @Nullable public List<String> notificationEmailAddresses
      The Notification Email Addresses. Specifies the list of email addresses where Azure AD 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 Azure AD Gallery applications.

    • oauth2PermissionScopes

      @SerializedName(value="oauth2PermissionScopes", alternate="Oauth2PermissionScopes") @Expose @Nullable public List<PermissionScope> oauth2PermissionScopes
      The Oauth2Permission Scopes. The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable.

    • passwordCredentials

      @SerializedName(value="passwordCredentials", alternate="PasswordCredentials") @Expose @Nullable public List<PasswordCredential> passwordCredentials
      The Password Credentials. The collection of password credentials associated with the application. Not nullable.

    • preferredSingleSignOnMode

      @SerializedName(value="preferredSingleSignOnMode", alternate="PreferredSingleSignOnMode") @Expose @Nullable public String preferredSingleSignOnMode
      The Preferred Single Sign On Mode. Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc.

    • preferredTokenSigningKeyThumbprint

      @SerializedName(value="preferredTokenSigningKeyThumbprint", alternate="PreferredTokenSigningKeyThumbprint") @Expose @Nullable public String preferredTokenSigningKeyThumbprint
      The Preferred Token Signing Key Thumbprint. Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions.

    • replyUrls

      @SerializedName(value="replyUrls", alternate="ReplyUrls") @Expose @Nullable public List<String> replyUrls
      The Reply Urls. 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.

    • resourceSpecificApplicationPermissions

      @SerializedName(value="resourceSpecificApplicationPermissions", alternate="ResourceSpecificApplicationPermissions") @Expose @Nullable public List<ResourceSpecificPermission> resourceSpecificApplicationPermissions
      The Resource Specific Application Permissions. The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only.

    • samlSingleSignOnSettings

      @SerializedName(value="samlSingleSignOnSettings", alternate="SamlSingleSignOnSettings") @Expose @Nullable public SamlSingleSignOnSettings samlSingleSignOnSettings
      The Saml Single Sign On Settings. The collection for settings related to saml single sign-on.

    • servicePrincipalNames

      @SerializedName(value="servicePrincipalNames", alternate="ServicePrincipalNames") @Expose @Nullable public List<String> servicePrincipalNames
      The Service Principal Names. 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 Azure AD. For example,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. Supports $filter (eq, not, ge, le, startsWith).

    • servicePrincipalType

      @SerializedName(value="servicePrincipalType", alternate="ServicePrincipalType") @Expose @Nullable public String servicePrincipalType
      The Service Principal Type. Identifies whether the service principal represents an application, a managed identity, or a legacy application. This is set by Azure AD internally. The servicePrincipalType property can be set to three different values: __Application - A service principal that represents an application or service. The appId property identifies the associated app registration, and matches the appId of an application, possibly from a different tenant. If the associated app registration is missing, tokens are not issued for the service principal.__ManagedIdentity - A service principal that represents a managed identity. Service principals representing managed identities can be granted access and permissions, but cannot be updated or modified directly.__Legacy - A service principal that represents an app created before app registrations, or through legacy experiences. Legacy service principal can have credentials, service principal names, reply URLs, and other properties which are editable by an authorized user, but does not have an associated app registration. The appId value does not associate the service principal with an app registration. The service principal can only be used in the tenant where it was created.__SocialIdp - For internal use.

    • signInAudience

      @SerializedName(value="signInAudience", alternate="SignInAudience") @Expose @Nullable public String signInAudience
      The Sign In Audience. 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 Azure AD tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization’s Azure AD tenant (multi-tenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.

    • tags

      @SerializedName(value="tags", alternate="Tags") @Expose @Nullable public List<String> tags
      The Tags. Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, not, ge, le, startsWith).

    • tokenEncryptionKeyId

      @SerializedName(value="tokenEncryptionKeyId", alternate="TokenEncryptionKeyId") @Expose @Nullable public UUID tokenEncryptionKeyId
      The Token Encryption Key Id. Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD 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.

    • verifiedPublisher

      @SerializedName(value="verifiedPublisher", alternate="VerifiedPublisher") @Expose @Nullable public VerifiedPublisher verifiedPublisher
      The Verified Publisher. Specifies the verified publisher of the application which this service principal represents.

    • appRoleAssignedTo

      @SerializedName(value="appRoleAssignedTo", alternate="AppRoleAssignedTo") @Expose @Nullable public AppRoleAssignmentCollectionPage appRoleAssignedTo
      The App Role Assigned To. App role assignments for this app or service, granted to users, groups, and other service principals. Supports $expand.

    • appRoleAssignments

      @SerializedName(value="appRoleAssignments", alternate="AppRoleAssignments") @Expose @Nullable public AppRoleAssignmentCollectionPage appRoleAssignments
      The App Role Assignments. App role assignment for another app or service, granted to this service principal. Supports $expand.

    • claimsMappingPolicies

      @Nullable public ClaimsMappingPolicyCollectionPage claimsMappingPolicies
      The Claims Mapping Policies. The claimsMappingPolicies assigned to this service principal. Supports $expand.

    • createdObjects

      @Nullable public DirectoryObjectCollectionPage createdObjects
      The Created Objects. Directory objects created by this service principal. Read-only. Nullable.

    • delegatedPermissionClassifications

      @SerializedName(value="delegatedPermissionClassifications", alternate="DelegatedPermissionClassifications") @Expose @Nullable public DelegatedPermissionClassificationCollectionPage delegatedPermissionClassifications
      The Delegated Permission Classifications.

    • endpoints

      @SerializedName(value="endpoints", alternate="Endpoints") @Expose @Nullable public EndpointCollectionPage endpoints
      The Endpoints.

    • federatedIdentityCredentials

      @SerializedName(value="federatedIdentityCredentials", alternate="FederatedIdentityCredentials") @Expose @Nullable public FederatedIdentityCredentialCollectionPage federatedIdentityCredentials
      The Federated Identity Credentials. Federated identities for a specific type of service principal - managed identity. Supports $expand and $filter (/$count eq 0, /$count ne 0).

    • homeRealmDiscoveryPolicies

      @Nullable public HomeRealmDiscoveryPolicyCollectionPage homeRealmDiscoveryPolicies
      The Home Realm Discovery Policies. The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand.

    • memberOf

      @Nullable public DirectoryObjectCollectionPage memberOf
      The Member Of. Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable. Supports $expand.

    • oauth2PermissionGrants

      @Nullable public OAuth2PermissionGrantCollectionPage oauth2PermissionGrants
      The Oauth2Permission Grants. Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Read-only. Nullable.

    • ownedObjects

      @Nullable public DirectoryObjectCollectionPage ownedObjects
      The Owned Objects. Directory objects that are owned by this service principal. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).

    • owners

      @Nullable public DirectoryObjectCollectionPage owners
      The Owners. Directory objects that are owners of this servicePrincipal. The owners are a set of non-admin users or servicePrincipals who are allowed to modify this object. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).

    • tokenIssuancePolicies

      @Nullable public TokenIssuancePolicyCollectionPage tokenIssuancePolicies
      The Token Issuance Policies. The tokenIssuancePolicies assigned to this service principal.

    • tokenLifetimePolicies

      @Nullable public TokenLifetimePolicyCollectionPage tokenLifetimePolicies
      The Token Lifetime Policies. The tokenLifetimePolicies assigned to this service principal.

    • transitiveMemberOf

      @Nullable public DirectoryObjectCollectionPage transitiveMemberOf
      The Transitive Member Of.

  • Constructor Details

    • ServicePrincipal

      public ServicePrincipal()

  • Method Details

    • setRawObject

      public void setRawObject(@Nonnull com.microsoft.graph.serializer.ISerializer serializer, @Nonnull com.google.gson.JsonObject json)
      Sets the raw JSON object
      Specified by:
      setRawObject in interface com.microsoft.graph.serializer.IJsonBackedObject
      Overrides:
      setRawObject in class DirectoryObject
      Parameters:
      serializer - the serializer
      json - the JSON object to set this object to