ServicePrincipal (msgraph-sdk-java API)

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 Summary

Fields
Modifier and Type	Field and Description
`java.lang.Boolean`	`accountEnabled` The Account Enabled.
`java.util.List<AddIn>`	`addIns` The Add Ins.
`java.util.List<java.lang.String>`	`alternativeNames` The Alternative Names.
`java.lang.String`	`appDescription` The App Description.
`java.lang.String`	`appDisplayName` The App Display Name.
`java.lang.String`	`appId` The App Id.
`java.lang.String`	`applicationTemplateId` The Application Template Id.
`java.util.UUID`	`appOwnerOrganizationId` The App Owner Organization Id.
`AppRoleAssignmentCollectionPage`	`appRoleAssignedTo` The App Role Assigned To.
`java.lang.Boolean`	`appRoleAssignmentRequired` The App Role Assignment Required.
`AppRoleAssignmentCollectionPage`	`appRoleAssignments` The App Role Assignments.
`java.util.List<AppRole>`	`appRoles` The App Roles.
`ClaimsMappingPolicyCollectionPage`	`claimsMappingPolicies` The Claims Mapping Policies.
`DirectoryObjectCollectionPage`	`createdObjects` The Created Objects.
`DelegatedPermissionClassificationCollectionPage`	`delegatedPermissionClassifications` The Delegated Permission Classifications.
`java.lang.String`	`description` The Description.
`java.lang.String`	`displayName` The Display Name.
`EndpointCollectionPage`	`endpoints` The Endpoints.
`java.lang.String`	`homepage` The Homepage.
`HomeRealmDiscoveryPolicyCollectionPage`	`homeRealmDiscoveryPolicies` The Home Realm Discovery Policies.
`InformationalUrl`	`info` The Info.
`java.util.List<KeyCredential>`	`keyCredentials` The Key Credentials.
`java.lang.String`	`loginUrl` The Login Url.
`java.lang.String`	`logoutUrl` The Logout Url.
`DirectoryObjectCollectionPage`	`memberOf` The Member Of.
`java.lang.String`	`notes` The Notes.
`java.util.List<java.lang.String>`	`notificationEmailAddresses` The Notification Email Addresses.
`OAuth2PermissionGrantCollectionPage`	`oauth2PermissionGrants` The Oauth2Permission Grants.
`java.util.List<PermissionScope>`	`oauth2PermissionScopes` The Oauth2Permission Scopes.
`DirectoryObjectCollectionPage`	`ownedObjects` The Owned Objects.
`DirectoryObjectCollectionPage`	`owners` The Owners.
`java.util.List<PasswordCredential>`	`passwordCredentials` The Password Credentials.
`java.lang.String`	`preferredSingleSignOnMode` The Preferred Single Sign On Mode.
`java.lang.String`	`preferredTokenSigningKeyThumbprint` The Preferred Token Signing Key Thumbprint.
`java.util.List<java.lang.String>`	`replyUrls` The Reply Urls.
`SamlSingleSignOnSettings`	`samlSingleSignOnSettings` The Saml Single Sign On Settings.
`java.util.List<java.lang.String>`	`servicePrincipalNames` The Service Principal Names.
`java.lang.String`	`servicePrincipalType` The Service Principal Type.
`java.lang.String`	`signInAudience` The Sign In Audience.
`java.util.List<java.lang.String>`	`tags` The Tags.
`java.util.UUID`	`tokenEncryptionKeyId` The Token Encryption Key Id.
`TokenIssuancePolicyCollectionPage`	`tokenIssuancePolicies` The Token Issuance Policies.
`TokenLifetimePolicyCollectionPage`	`tokenLifetimePolicies` The Token Lifetime Policies.
`DirectoryObjectCollectionPage`	`transitiveMemberOf` The Transitive Member Of.

Fields inherited from class com.microsoft.graph.models.DirectoryObject
deletedDateTime

Fields inherited from class com.microsoft.graph.models.Entity
id, oDataType

Constructor Summary

Constructors
Constructor and Description

ServicePrincipal()

Constructors
Constructor and Description
`ServicePrincipal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`setRawObject(com.microsoft.graph.serializer.ISerializer serializer, com.google.gson.JsonObject json)` Sets the raw JSON object

Methods inherited from class com.microsoft.graph.models.Entity
additionalDataManager

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microsoft.graph.serializer.IJsonBackedObject
additionalDataManager

- Field Detail
  - accountEnabled
```
@SerializedName(value="accountEnabled",
                alternate="AccountEnabled")
 @Expose
 @Nullable
public java.lang.Boolean accountEnabled
```
    The Account Enabled. true if the service principal account is enabled; otherwise, false.
  - addIns
```
@SerializedName(value="addIns",
                alternate="AddIns")
 @Expose
 @Nullable
public java.util.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 java.util.List<java.lang.String> alternativeNames
```
    The Alternative Names. Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
  - appDescription
```
@SerializedName(value="appDescription",
                alternate="AppDescription")
 @Expose
 @Nullable
public java.lang.String appDescription
```
    The App Description. The description exposed by the associated application.
  - appDisplayName
```
@SerializedName(value="appDisplayName",
                alternate="AppDisplayName")
 @Expose
 @Nullable
public java.lang.String appDisplayName
```
    The App Display Name. The display name exposed by the associated application.
  - appId
```
@SerializedName(value="appId",
                alternate="AppId")
 @Expose
 @Nullable
public java.lang.String appId
```
    The App Id. The unique identifier for the associated application (its appId property).
  - applicationTemplateId
```
@SerializedName(value="applicationTemplateId",
                alternate="ApplicationTemplateId")
 @Expose
 @Nullable
public java.lang.String applicationTemplateId
```
    The Application Template Id. Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only.
  - appOwnerOrganizationId
```
@SerializedName(value="appOwnerOrganizationId",
                alternate="AppOwnerOrganizationId")
 @Expose
 @Nullable
public java.util.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.
  - appRoleAssignmentRequired
```
@SerializedName(value="appRoleAssignmentRequired",
                alternate="AppRoleAssignmentRequired")
 @Expose
 @Nullable
public java.lang.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.
  - appRoles
```
@SerializedName(value="appRoles",
                alternate="AppRoles")
 @Expose
 @Nullable
public java.util.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 java.lang.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.
  - displayName
```
@SerializedName(value="displayName",
                alternate="DisplayName")
 @Expose
 @Nullable
public java.lang.String displayName
```
    The Display Name. The display name for the service principal.
  - homepage
```
@SerializedName(value="homepage",
                alternate="Homepage")
 @Expose
 @Nullable
public java.lang.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.
  - keyCredentials
```
@SerializedName(value="keyCredentials",
                alternate="KeyCredentials")
 @Expose
 @Nullable
public java.util.List<KeyCredential> keyCredentials
```
    The Key Credentials. The collection of key credentials associated with the service principal. Not nullable.
  - loginUrl
```
@SerializedName(value="loginUrl",
                alternate="LoginUrl")
 @Expose
 @Nullable
public java.lang.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 java.lang.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 java.lang.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 java.util.List<java.lang.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 java.util.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 java.util.List<PasswordCredential> passwordCredentials
```
    The Password Credentials. The collection of password credentials associated with the service principal. Not nullable.
  - preferredSingleSignOnMode
```
@SerializedName(value="preferredSingleSignOnMode",
                alternate="PreferredSingleSignOnMode")
 @Expose
 @Nullable
public java.lang.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 java.lang.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 java.util.List<java.lang.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.
  - 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 java.util.List<java.lang.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.
  - servicePrincipalType
```
@SerializedName(value="servicePrincipalType",
                alternate="ServicePrincipalType")
 @Expose
 @Nullable
public java.lang.String servicePrincipalType
```
    The Service Principal Type. Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity.
  - signInAudience
```
@SerializedName(value="signInAudience",
                alternate="SignInAudience")
 @Expose
 @Nullable
public java.lang.String signInAudience
```
    The Sign In Audience. Specifies what Microsoft accounts are supported for the associated application. Read-only.
  - tags
```
@SerializedName(value="tags",
                alternate="Tags")
 @Expose
 @Nullable
public java.util.List<java.lang.String> tags
```
    The Tags. Custom strings that can be used to categorize and identify the service principal. Not nullable.
  - tokenEncryptionKeyId
```
@SerializedName(value="tokenEncryptionKeyId",
                alternate="TokenEncryptionKeyId")
 @Expose
 @Nullable
public java.util.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.
  - 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.
  - 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.
  - claimsMappingPolicies
```
@Nullable
public ClaimsMappingPolicyCollectionPage claimsMappingPolicies
```
    The Claims Mapping Policies. The claimsMappingPolicies assigned to this service principal.
  - 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. The permission classifications for delegated permissions exposed by the app that this service principal represents.
  - endpoints
```
@SerializedName(value="endpoints",
                alternate="Endpoints")
 @Expose
 @Nullable
public EndpointCollectionPage endpoints
```
    The Endpoints. Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
  - homeRealmDiscoveryPolicies
```
@Nullable
public HomeRealmDiscoveryPolicyCollectionPage homeRealmDiscoveryPolicies
```
    The Home Realm Discovery Policies. The homeRealmDiscoveryPolicies assigned to this service principal.
  - memberOf
```
@Nullable
public DirectoryObjectCollectionPage memberOf
```
    The Member Of. Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable.
  - 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.
  - 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.
  - 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 Detail
  - ServicePrincipal
```
public ServicePrincipal()
```
- Method Detail
  - 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

Class ServicePrincipal

Field Summary

Fields inherited from class com.microsoft.graph.models.DirectoryObject

Fields inherited from class com.microsoft.graph.models.Entity

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.graph.models.Entity

Methods inherited from class java.lang.Object

Methods inherited from interface com.microsoft.graph.serializer.IJsonBackedObject

Field Detail

accountEnabled

addIns

alternativeNames

appDescription

appDisplayName

appId

applicationTemplateId

appOwnerOrganizationId

appRoleAssignmentRequired

appRoles

description

displayName

homepage

info

keyCredentials

loginUrl

logoutUrl

notes

notificationEmailAddresses

oauth2PermissionScopes

passwordCredentials

preferredSingleSignOnMode

preferredTokenSigningKeyThumbprint

replyUrls

samlSingleSignOnSettings

servicePrincipalNames

servicePrincipalType

signInAudience

tags

tokenEncryptionKeyId

appRoleAssignedTo

appRoleAssignments

claimsMappingPolicies

createdObjects

delegatedPermissionClassifications

endpoints

homeRealmDiscoveryPolicies

memberOf

oauth2PermissionGrants

ownedObjects

owners

tokenIssuancePolicies

tokenLifetimePolicies

transitiveMemberOf

Constructor Detail

ServicePrincipal

Method Detail

setRawObject