MicrosoftGraphServicePrincipalInner Class

Package:

com.azure.resourcemanager.authorization.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-authorization:2.44.0

• java.lang.Object
• • com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphEntity
  • • com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphDirectoryObjectInner
    • • com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphServicePrincipalInner

public final class MicrosoftGraphServicePrincipalInner
extends MicrosoftGraphDirectoryObjectInner

servicePrincipal Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types.

Constructor Summary

Constructor	Description
MicrosoftGraphServicePrincipalInner()	Creates an instance of MicrosoftGraphServicePrincipalInner class.

Method Summary

Modifier and Type	Method and Description
Boolean	accountEnabled() Get the accountEnabled property: true if the service principal account is enabled; otherwise, false.
List<MicrosoftGraphAddIn>	addIns() Get the addIns property: Defines custom behavior that a consuming service can use to call an app in specific contexts.
Map<String,Object>	additionalProperties() Get the additionalProperties property: Represents an Azure Active Directory object.
List<String>	alternativeNames() Get the alternativeNames property: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
String	appDescription() Get the appDescription property: The appDescription property.
String	appDisplayName() Get the appDisplayName property: The display name exposed by the associated application.
String	appId() Get the appId property: The unique identifier for the associated application (its appId property).
UUID	appOwnerOrganizationId() Get the appOwnerOrganizationId property: Contains the tenant id where the application is registered.
List<MicrosoftGraphAppRoleAssignment>	appRoleAssignedTo() Get the appRoleAssignedTo property: Principals (users, groups, and service principals) that are assigned to this service principal.
Boolean	appRoleAssignmentRequired() Get the appRoleAssignmentRequired property: 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.
List<MicrosoftGraphAppRoleAssignment>	appRoleAssignments() Get the appRoleAssignments property: Applications that this service principal is assigned to.
List<MicrosoftGraphAppRole>	appRoles() Get the appRoles property: The roles exposed by the application which this service principal represents.
String	applicationTemplateId() Get the applicationTemplateId property: Unique identifier of the applicationTemplate that the servicePrincipal was created from.
List<MicrosoftGraphClaimsMappingPolicy>	claimsMappingPolicies() Get the claimsMappingPolicies property: The claimsMappingPolicies assigned to this service principal.
List<MicrosoftGraphDirectoryObjectInner>	createdObjects() Get the createdObjects property: Directory objects created by this service principal.
List<MicrosoftGraphDelegatedPermissionClassification>	delegatedPermissionClassifications() Get the delegatedPermissionClassifications property: The delegatedPermissionClassifications property.
String	description() Get the description property: The description property.
String	displayName() Get the displayName property: The display name for the service principal.
List<MicrosoftGraphEndpoint>	endpoints() Get the endpoints property: Endpoints available for discovery.
static MicrosoftGraphServicePrincipalInner	fromJson(JsonReader jsonReader) Reads an instance of MicrosoftGraphServicePrincipalInner from the JsonReader.
List<MicrosoftGraphHomeRealmDiscoveryPolicyInner>	homeRealmDiscoveryPolicies() Get the homeRealmDiscoveryPolicies property: The homeRealmDiscoveryPolicies assigned to this service principal.
String	homepage() Get the homepage property: Home page or landing page of the application.
MicrosoftGraphInformationalUrl	info() Get the info property: informationalUrl.
List<MicrosoftGraphKeyCredentialInner>	keyCredentials() Get the keyCredentials property: The collection of key credentials associated with the service principal.
String	loginUrl() Get the loginUrl property: Specifies the URL where the service provider redirects the user to Azure AD to authenticate.
String	logoutUrl() Get the logoutUrl property: 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.
List<MicrosoftGraphDirectoryObjectInner>	memberOf() Get the memberOf property: Roles that this service principal is a member of.
String	notes() Get the notes property: The notes property.
List<String>	notificationEmailAddresses() Get the notificationEmailAddresses property: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date.
List<MicrosoftGraphOAuth2PermissionGrant>	oauth2PermissionGrants() Get the oauth2PermissionGrants property: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
List<MicrosoftGraphPermissionScope>	oauth2PermissionScopes() Get the oauth2PermissionScopes property: The delegated permissions exposed by the application.
List<MicrosoftGraphDirectoryObjectInner>	ownedObjects() Get the ownedObjects property: Directory objects that are owned by this service principal.
List<MicrosoftGraphDirectoryObjectInner>	owners() Get the owners property: Directory objects that are owners of this servicePrincipal.
List<MicrosoftGraphPasswordCredentialInner>	passwordCredentials() Get the passwordCredentials property: The collection of password credentials associated with the service principal.
String	preferredSingleSignOnMode() Get the preferredSingleSignOnMode property: Specifies the single sign-on mode configured for this application.
String	preferredTokenSigningKeyThumbprint() Get the preferredTokenSigningKeyThumbprint property: The preferredTokenSigningKeyThumbprint property.
List<String>	replyUrls() Get the replyUrls property: 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.
MicrosoftGraphSamlSingleSignOnSettings	samlSingleSignOnSettings() Get the samlSingleSignOnSettings property: samlSingleSignOnSettings.
List<String>	servicePrincipalNames() Get the servicePrincipalNames property: Contains the list of identifiersUris, copied over from the associated application.
String	servicePrincipalType() Get the servicePrincipalType property: Identifies if the service principal represents an application or a managed identity.
String	signInAudience() Get the signInAudience property: The signInAudience property.
List<String>	tags() Get the tags property: Custom strings that can be used to categorize and identify the service principal.
JsonWriter	toJson(JsonWriter jsonWriter)
UUID	tokenEncryptionKeyId() Get the tokenEncryptionKeyId property: Specifies the keyId of a public key from the keyCredentials collection.
List<MicrosoftGraphTokenIssuancePolicy>	tokenIssuancePolicies() Get the tokenIssuancePolicies property: The tokenIssuancePolicies assigned to this service principal.
List<MicrosoftGraphTokenLifetimePolicy>	tokenLifetimePolicies() Get the tokenLifetimePolicies property: The tokenLifetimePolicies assigned to this service principal.
List<MicrosoftGraphDirectoryObjectInner>	transitiveMemberOf() Get the transitiveMemberOf property: The transitiveMemberOf property.
void	validate() Validates the instance.
MicrosoftGraphServicePrincipalInner	withAccountEnabled(Boolean accountEnabled) Set the accountEnabled property: true if the service principal account is enabled; otherwise, false.
MicrosoftGraphServicePrincipalInner	withAddIns(List<MicrosoftGraphAddIn> addIns) Set the addIns property: Defines custom behavior that a consuming service can use to call an app in specific contexts.
MicrosoftGraphServicePrincipalInner	withAdditionalProperties(Map<String,Object> additionalProperties) Set the additionalProperties property: Represents an Azure Active Directory object.
MicrosoftGraphServicePrincipalInner	withAlternativeNames(List<String> alternativeNames) Set the alternativeNames property: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
MicrosoftGraphServicePrincipalInner	withAppDescription(String appDescription) Set the appDescription property: The appDescription property.
MicrosoftGraphServicePrincipalInner	withAppDisplayName(String appDisplayName) Set the appDisplayName property: The display name exposed by the associated application.
MicrosoftGraphServicePrincipalInner	withAppId(String appId) Set the appId property: The unique identifier for the associated application (its appId property).
MicrosoftGraphServicePrincipalInner	withAppOwnerOrganizationId(UUID appOwnerOrganizationId) Set the appOwnerOrganizationId property: Contains the tenant id where the application is registered.
MicrosoftGraphServicePrincipalInner	withAppRoleAssignedTo(List<MicrosoftGraphAppRoleAssignment> appRoleAssignedTo) Set the appRoleAssignedTo property: Principals (users, groups, and service principals) that are assigned to this service principal.
MicrosoftGraphServicePrincipalInner	withAppRoleAssignmentRequired(Boolean appRoleAssignmentRequired) Set the appRoleAssignmentRequired property: 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.
MicrosoftGraphServicePrincipalInner	withAppRoleAssignments(List<MicrosoftGraphAppRoleAssignment> appRoleAssignments) Set the appRoleAssignments property: Applications that this service principal is assigned to.
MicrosoftGraphServicePrincipalInner	withAppRoles(List<MicrosoftGraphAppRole> appRoles) Set the appRoles property: The roles exposed by the application which this service principal represents.
MicrosoftGraphServicePrincipalInner	withApplicationTemplateId(String applicationTemplateId) Set the applicationTemplateId property: Unique identifier of the applicationTemplate that the servicePrincipal was created from.
MicrosoftGraphServicePrincipalInner	withClaimsMappingPolicies(List<MicrosoftGraphClaimsMappingPolicy> claimsMappingPolicies) Set the claimsMappingPolicies property: The claimsMappingPolicies assigned to this service principal.
MicrosoftGraphServicePrincipalInner	withCreatedObjects(List<MicrosoftGraphDirectoryObjectInner> createdObjects) Set the createdObjects property: Directory objects created by this service principal.
MicrosoftGraphServicePrincipalInner	withDelegatedPermissionClassifications(List<MicrosoftGraphDelegatedPermissionClassification> delegatedPermissionClassifications) Set the delegatedPermissionClassifications property: The delegatedPermissionClassifications property.
MicrosoftGraphServicePrincipalInner	withDeletedDateTime(OffsetDateTime deletedDateTime) Set the deletedDateTime property: The deletedDateTime property.
MicrosoftGraphServicePrincipalInner	withDescription(String description) Set the description property: The description property.
MicrosoftGraphServicePrincipalInner	withDisplayName(String displayName) Set the displayName property: The display name for the service principal.
MicrosoftGraphServicePrincipalInner	withEndpoints(List<MicrosoftGraphEndpoint> endpoints) Set the endpoints property: Endpoints available for discovery.
MicrosoftGraphServicePrincipalInner	withHomeRealmDiscoveryPolicies(List<MicrosoftGraphHomeRealmDiscoveryPolicyInner> homeRealmDiscoveryPolicies) Set the homeRealmDiscoveryPolicies property: The homeRealmDiscoveryPolicies assigned to this service principal.
MicrosoftGraphServicePrincipalInner	withHomepage(String homepage) Set the homepage property: Home page or landing page of the application.
MicrosoftGraphServicePrincipalInner	withId(String id) Set the id property: Read-only.
MicrosoftGraphServicePrincipalInner	withInfo(MicrosoftGraphInformationalUrl info) Set the info property: informationalUrl.
MicrosoftGraphServicePrincipalInner	withKeyCredentials(List<MicrosoftGraphKeyCredentialInner> keyCredentials) Set the keyCredentials property: The collection of key credentials associated with the service principal.
MicrosoftGraphServicePrincipalInner	withLoginUrl(String loginUrl) Set the loginUrl property: Specifies the URL where the service provider redirects the user to Azure AD to authenticate.
MicrosoftGraphServicePrincipalInner	withLogoutUrl(String logoutUrl) Set the logoutUrl property: 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.
MicrosoftGraphServicePrincipalInner	withMemberOf(List<MicrosoftGraphDirectoryObjectInner> memberOf) Set the memberOf property: Roles that this service principal is a member of.
MicrosoftGraphServicePrincipalInner	withNotes(String notes) Set the notes property: The notes property.
MicrosoftGraphServicePrincipalInner	withNotificationEmailAddresses(List<String> notificationEmailAddresses) Set the notificationEmailAddresses property: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date.
MicrosoftGraphServicePrincipalInner	withOauth2PermissionGrants(List<MicrosoftGraphOAuth2PermissionGrant> oauth2PermissionGrants) Set the oauth2PermissionGrants property: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
MicrosoftGraphServicePrincipalInner	withOauth2PermissionScopes(List<MicrosoftGraphPermissionScope> oauth2PermissionScopes) Set the oauth2PermissionScopes property: The delegated permissions exposed by the application.
MicrosoftGraphServicePrincipalInner	withOwnedObjects(List<MicrosoftGraphDirectoryObjectInner> ownedObjects) Set the ownedObjects property: Directory objects that are owned by this service principal.
MicrosoftGraphServicePrincipalInner	withOwners(List<MicrosoftGraphDirectoryObjectInner> owners) Set the owners property: Directory objects that are owners of this servicePrincipal.
MicrosoftGraphServicePrincipalInner	withPasswordCredentials(List<MicrosoftGraphPasswordCredentialInner> passwordCredentials) Set the passwordCredentials property: The collection of password credentials associated with the service principal.
MicrosoftGraphServicePrincipalInner	withPreferredSingleSignOnMode(String preferredSingleSignOnMode) Set the preferredSingleSignOnMode property: Specifies the single sign-on mode configured for this application.
MicrosoftGraphServicePrincipalInner	withPreferredTokenSigningKeyThumbprint(String preferredTokenSigningKeyThumbprint) Set the preferredTokenSigningKeyThumbprint property: The preferredTokenSigningKeyThumbprint property.
MicrosoftGraphServicePrincipalInner	withReplyUrls(List<String> replyUrls) Set the replyUrls property: 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.
MicrosoftGraphServicePrincipalInner	withSamlSingleSignOnSettings(MicrosoftGraphSamlSingleSignOnSettings samlSingleSignOnSettings) Set the samlSingleSignOnSettings property: samlSingleSignOnSettings.
MicrosoftGraphServicePrincipalInner	withServicePrincipalNames(List<String> servicePrincipalNames) Set the servicePrincipalNames property: Contains the list of identifiersUris, copied over from the associated application.
MicrosoftGraphServicePrincipalInner	withServicePrincipalType(String servicePrincipalType) Set the servicePrincipalType property: Identifies if the service principal represents an application or a managed identity.
MicrosoftGraphServicePrincipalInner	withSignInAudience(String signInAudience) Set the signInAudience property: The signInAudience property.
MicrosoftGraphServicePrincipalInner	withTags(List<String> tags) Set the tags property: Custom strings that can be used to categorize and identify the service principal.
MicrosoftGraphServicePrincipalInner	withTokenEncryptionKeyId(UUID tokenEncryptionKeyId) Set the tokenEncryptionKeyId property: Specifies the keyId of a public key from the keyCredentials collection.
MicrosoftGraphServicePrincipalInner	withTokenIssuancePolicies(List<MicrosoftGraphTokenIssuancePolicy> tokenIssuancePolicies) Set the tokenIssuancePolicies property: The tokenIssuancePolicies assigned to this service principal.
MicrosoftGraphServicePrincipalInner	withTokenLifetimePolicies(List<MicrosoftGraphTokenLifetimePolicy> tokenLifetimePolicies) Set the tokenLifetimePolicies property: The tokenLifetimePolicies assigned to this service principal.
MicrosoftGraphServicePrincipalInner	withTransitiveMemberOf(List<MicrosoftGraphDirectoryObjectInner> transitiveMemberOf) Set the transitiveMemberOf property: The transitiveMemberOf property.

Methods inherited from MicrosoftGraphDirectoryObjectInner

additionalProperties deletedDateTime fromJson toJson validate withAdditionalProperties withDeletedDateTime withId

Methods inherited from MicrosoftGraphEntity

id

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MicrosoftGraphServicePrincipalInner

public MicrosoftGraphServicePrincipalInner()

Creates an instance of MicrosoftGraphServicePrincipalInner class.

Method Details

accountEnabled

public Boolean accountEnabled()

Get the accountEnabled property: true if the service principal account is enabled; otherwise, false.

Returns:

the accountEnabled value.

addIns

public List addIns()

Get the addIns property: 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.

Returns:

the addIns value.

additionalProperties

public Map additionalProperties()

Get the additionalProperties property: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types.

Overrides:

MicrosoftGraphServicePrincipalInner.additionalProperties()

Returns:

the additionalProperties value.

alternativeNames

public List alternativeNames()

Get the alternativeNames property: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.

Returns:

the alternativeNames value.

appDescription

public String appDescription()

Get the appDescription property: The appDescription property.

Returns:

the appDescription value.

appDisplayName

public String appDisplayName()

Get the appDisplayName property: The display name exposed by the associated application.

Returns:

the appDisplayName value.

appId

public String appId()

Get the appId property: The unique identifier for the associated application (its appId property).

Returns:

the appId value.

appOwnerOrganizationId

public UUID appOwnerOrganizationId()

Get the appOwnerOrganizationId property: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.

Returns:

the appOwnerOrganizationId value.

appRoleAssignedTo

public List appRoleAssignedTo()

Get the appRoleAssignedTo property: Principals (users, groups, and service principals) that are assigned to this service principal. Read-only.

Returns:

the appRoleAssignedTo value.

appRoleAssignmentRequired

public Boolean appRoleAssignmentRequired()

Get the appRoleAssignmentRequired property: 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.

Returns:

the appRoleAssignmentRequired value.

appRoleAssignments

public List appRoleAssignments()

Get the appRoleAssignments property: Applications that this service principal is assigned to. Read-only. Nullable.

Returns:

the appRoleAssignments value.

appRoles

public List appRoles()

Get the appRoles property: 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.

Returns:

the appRoles value.

applicationTemplateId

public String applicationTemplateId()

Get the applicationTemplateId property: Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only.

Returns:

the applicationTemplateId value.

claimsMappingPolicies

public List claimsMappingPolicies()

Get the claimsMappingPolicies property: The claimsMappingPolicies assigned to this service principal.

Returns:

the claimsMappingPolicies value.

createdObjects

public List createdObjects()

Get the createdObjects property: Directory objects created by this service principal. Read-only. Nullable.

Returns:

the createdObjects value.

delegatedPermissionClassifications

public List delegatedPermissionClassifications()

Get the delegatedPermissionClassifications property: The delegatedPermissionClassifications property.

Returns:

the delegatedPermissionClassifications value.

description

public String description()

Get the description property: The description property.

Returns:

the description value.

displayName

public String displayName()

Get the displayName property: The display name for the service principal.

Returns:

the displayName value.

endpoints

public List endpoints()

Get the endpoints property: 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.

Returns:

the endpoints value.

fromJson

public static MicrosoftGraphServicePrincipalInner fromJson(JsonReader jsonReader)

Reads an instance of MicrosoftGraphServicePrincipalInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MicrosoftGraphServicePrincipalInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the MicrosoftGraphServicePrincipalInner.

homeRealmDiscoveryPolicies

public List homeRealmDiscoveryPolicies()

Get the homeRealmDiscoveryPolicies property: The homeRealmDiscoveryPolicies assigned to this service principal.

Returns:

the homeRealmDiscoveryPolicies value.

homepage

public String homepage()

Get the homepage property: Home page or landing page of the application.

Returns:

the homepage value.

info

public MicrosoftGraphInformationalUrl info()

Get the info property: informationalUrl.

Returns:

the info value.

keyCredentials

public List keyCredentials()

Get the keyCredentials property: The collection of key credentials associated with the service principal. Not nullable.

Returns:

the keyCredentials value.

loginUrl

public String loginUrl()

Get the loginUrl property: 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.

Returns:

the loginUrl value.

logoutUrl

public String logoutUrl()

Get the logoutUrl property: 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.

Returns:

the logoutUrl value.

memberOf

public List memberOf()

Get the memberOf property: Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable.

Returns:

the memberOf value.

notes

public String notes()

Get the notes property: The notes property.

Returns:

the notes value.

notificationEmailAddresses

public List notificationEmailAddresses()

Get the notificationEmailAddresses property: 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.

Returns:

the notificationEmailAddresses value.

oauth2PermissionGrants

public List oauth2PermissionGrants()

Get the oauth2PermissionGrants property: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Read-only. Nullable.

Returns:

the oauth2PermissionGrants value.

oauth2PermissionScopes

public List oauth2PermissionScopes()

Get the oauth2PermissionScopes property: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable.

Returns:

the oauth2PermissionScopes value.

ownedObjects

public List ownedObjects()

Get the ownedObjects property: Directory objects that are owned by this service principal. Read-only. Nullable.

Returns:

the ownedObjects value.

owners

public List owners()

Get the owners property: 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.

Returns:

the owners value.

passwordCredentials

public List passwordCredentials()

Get the passwordCredentials property: The collection of password credentials associated with the service principal. Not nullable.

Returns:

the passwordCredentials value.

preferredSingleSignOnMode

public String preferredSingleSignOnMode()

Get the preferredSingleSignOnMode property: 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, external, and oidc.

Returns:

the preferredSingleSignOnMode value.

preferredTokenSigningKeyThumbprint

public String preferredTokenSigningKeyThumbprint()

Get the preferredTokenSigningKeyThumbprint property: The preferredTokenSigningKeyThumbprint property.

Returns:

the preferredTokenSigningKeyThumbprint value.

replyUrls

public List replyUrls()

Get the replyUrls property: 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.

Returns:

the replyUrls value.

samlSingleSignOnSettings

public MicrosoftGraphSamlSingleSignOnSettings samlSingleSignOnSettings()

Get the samlSingleSignOnSettings property: samlSingleSignOnSettings.

Returns:

the samlSingleSignOnSettings value.

servicePrincipalNames

public List servicePrincipalNames()

Get the servicePrincipalNames property: 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.

Returns:

the servicePrincipalNames value.

servicePrincipalType

public String servicePrincipalType()

Get the servicePrincipalType property: 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.

Returns:

the servicePrincipalType value.

signInAudience

public String signInAudience()

Get the signInAudience property: The signInAudience property.

Returns:

the signInAudience value.

tags

public List tags()

Get the tags property: Custom strings that can be used to categorize and identify the service principal. Not nullable.

Returns:

the tags value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

MicrosoftGraphServicePrincipalInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

tokenEncryptionKeyId

public UUID tokenEncryptionKeyId()

Get the tokenEncryptionKeyId property: 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.

Returns:

the tokenEncryptionKeyId value.

tokenIssuancePolicies

public List tokenIssuancePolicies()

Get the tokenIssuancePolicies property: The tokenIssuancePolicies assigned to this service principal.

Returns:

the tokenIssuancePolicies value.

tokenLifetimePolicies

public List tokenLifetimePolicies()

Get the tokenLifetimePolicies property: The tokenLifetimePolicies assigned to this service principal.

Returns:

the tokenLifetimePolicies value.

transitiveMemberOf

public List transitiveMemberOf()

Get the transitiveMemberOf property: The transitiveMemberOf property.

Returns:

the transitiveMemberOf value.

validate

public void validate()

Validates the instance.

Overrides:

MicrosoftGraphServicePrincipalInner.validate()

withAccountEnabled

public MicrosoftGraphServicePrincipalInner withAccountEnabled(Boolean accountEnabled)

Set the accountEnabled property: true if the service principal account is enabled; otherwise, false.

Parameters:

accountEnabled - the accountEnabled value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAddIns

public MicrosoftGraphServicePrincipalInner withAddIns(List addIns)

Set the addIns property: 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.

Parameters:

addIns - the addIns value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAdditionalProperties

public MicrosoftGraphServicePrincipalInner withAdditionalProperties(Map additionalProperties)

Set the additionalProperties property: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types.

Overrides:

MicrosoftGraphServicePrincipalInner.withAdditionalProperties(Map<String,Object> additionalProperties)

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAlternativeNames

public MicrosoftGraphServicePrincipalInner withAlternativeNames(List alternativeNames)

Set the alternativeNames property: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.

Parameters:

alternativeNames - the alternativeNames value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAppDescription

public MicrosoftGraphServicePrincipalInner withAppDescription(String appDescription)

Set the appDescription property: The appDescription property.

Parameters:

appDescription - the appDescription value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAppDisplayName

public MicrosoftGraphServicePrincipalInner withAppDisplayName(String appDisplayName)

Set the appDisplayName property: The display name exposed by the associated application.

Parameters:

appDisplayName - the appDisplayName value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAppId

public MicrosoftGraphServicePrincipalInner withAppId(String appId)

Set the appId property: The unique identifier for the associated application (its appId property).

Parameters:

appId - the appId value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAppOwnerOrganizationId

public MicrosoftGraphServicePrincipalInner withAppOwnerOrganizationId(UUID appOwnerOrganizationId)

Set the appOwnerOrganizationId property: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.

Parameters:

appOwnerOrganizationId - the appOwnerOrganizationId value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAppRoleAssignedTo

public MicrosoftGraphServicePrincipalInner withAppRoleAssignedTo(List appRoleAssignedTo)

Set the appRoleAssignedTo property: Principals (users, groups, and service principals) that are assigned to this service principal. Read-only.

Parameters:

appRoleAssignedTo - the appRoleAssignedTo value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAppRoleAssignmentRequired

public MicrosoftGraphServicePrincipalInner withAppRoleAssignmentRequired(Boolean appRoleAssignmentRequired)

Set the appRoleAssignmentRequired property: 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.

Parameters:

appRoleAssignmentRequired - the appRoleAssignmentRequired value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAppRoleAssignments

public MicrosoftGraphServicePrincipalInner withAppRoleAssignments(List appRoleAssignments)

Set the appRoleAssignments property: Applications that this service principal is assigned to. Read-only. Nullable.

Parameters:

appRoleAssignments - the appRoleAssignments value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withAppRoles

public MicrosoftGraphServicePrincipalInner withAppRoles(List appRoles)

Set the appRoles property: 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.

Parameters:

appRoles - the appRoles value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withApplicationTemplateId

public MicrosoftGraphServicePrincipalInner withApplicationTemplateId(String applicationTemplateId)

Set the applicationTemplateId property: Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only.

Parameters:

applicationTemplateId - the applicationTemplateId value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withClaimsMappingPolicies

public MicrosoftGraphServicePrincipalInner withClaimsMappingPolicies(List claimsMappingPolicies)

Set the claimsMappingPolicies property: The claimsMappingPolicies assigned to this service principal.

Parameters:

claimsMappingPolicies - the claimsMappingPolicies value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withCreatedObjects

public MicrosoftGraphServicePrincipalInner withCreatedObjects(List createdObjects)

Set the createdObjects property: Directory objects created by this service principal. Read-only. Nullable.

Parameters:

createdObjects - the createdObjects value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withDelegatedPermissionClassifications

public MicrosoftGraphServicePrincipalInner withDelegatedPermissionClassifications(List delegatedPermissionClassifications)

Set the delegatedPermissionClassifications property: The delegatedPermissionClassifications property.

Parameters:

delegatedPermissionClassifications - the delegatedPermissionClassifications value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withDeletedDateTime

public MicrosoftGraphServicePrincipalInner withDeletedDateTime(OffsetDateTime deletedDateTime)

Set the deletedDateTime property: The deletedDateTime property.

Overrides:

MicrosoftGraphServicePrincipalInner.withDeletedDateTime(OffsetDateTime deletedDateTime)

Parameters:

deletedDateTime

withDescription

public MicrosoftGraphServicePrincipalInner withDescription(String description)

Set the description property: The description property.

Parameters:

description - the description value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withDisplayName

public MicrosoftGraphServicePrincipalInner withDisplayName(String displayName)

Set the displayName property: The display name for the service principal.

Parameters:

displayName - the displayName value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withEndpoints

public MicrosoftGraphServicePrincipalInner withEndpoints(List endpoints)

Set the endpoints property: 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.

Parameters:

endpoints - the endpoints value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withHomeRealmDiscoveryPolicies

public MicrosoftGraphServicePrincipalInner withHomeRealmDiscoveryPolicies(List homeRealmDiscoveryPolicies)

Set the homeRealmDiscoveryPolicies property: The homeRealmDiscoveryPolicies assigned to this service principal.

Parameters:

homeRealmDiscoveryPolicies - the homeRealmDiscoveryPolicies value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withHomepage

public MicrosoftGraphServicePrincipalInner withHomepage(String homepage)

Set the homepage property: Home page or landing page of the application.

Parameters:

homepage - the homepage value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withId

public MicrosoftGraphServicePrincipalInner withId(String id)

Set the id property: Read-only.

Overrides:

MicrosoftGraphServicePrincipalInner.withId(String id)

Parameters:

id

withInfo

public MicrosoftGraphServicePrincipalInner withInfo(MicrosoftGraphInformationalUrl info)

Set the info property: informationalUrl.

Parameters:

info - the info value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withKeyCredentials

public MicrosoftGraphServicePrincipalInner withKeyCredentials(List keyCredentials)

Set the keyCredentials property: The collection of key credentials associated with the service principal. Not nullable.

Parameters:

keyCredentials - the keyCredentials value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withLoginUrl

public MicrosoftGraphServicePrincipalInner withLoginUrl(String loginUrl)

Set the loginUrl property: 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.

Parameters:

loginUrl - the loginUrl value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withLogoutUrl

public MicrosoftGraphServicePrincipalInner withLogoutUrl(String logoutUrl)

Set the logoutUrl property: 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.

Parameters:

logoutUrl - the logoutUrl value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withMemberOf

public MicrosoftGraphServicePrincipalInner withMemberOf(List memberOf)

Set the memberOf property: Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable.

Parameters:

memberOf - the memberOf value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withNotes

public MicrosoftGraphServicePrincipalInner withNotes(String notes)

Set the notes property: The notes property.

Parameters:

notes - the notes value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withNotificationEmailAddresses

public MicrosoftGraphServicePrincipalInner withNotificationEmailAddresses(List notificationEmailAddresses)

Set the notificationEmailAddresses property: 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.

Parameters:

notificationEmailAddresses - the notificationEmailAddresses value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withOauth2PermissionGrants

public MicrosoftGraphServicePrincipalInner withOauth2PermissionGrants(List oauth2PermissionGrants)

Set the oauth2PermissionGrants property: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Read-only. Nullable.

Parameters:

oauth2PermissionGrants - the oauth2PermissionGrants value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withOauth2PermissionScopes

public MicrosoftGraphServicePrincipalInner withOauth2PermissionScopes(List oauth2PermissionScopes)

Set the oauth2PermissionScopes property: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable.

Parameters:

oauth2PermissionScopes - the oauth2PermissionScopes value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withOwnedObjects

public MicrosoftGraphServicePrincipalInner withOwnedObjects(List ownedObjects)

Set the ownedObjects property: Directory objects that are owned by this service principal. Read-only. Nullable.

Parameters:

ownedObjects - the ownedObjects value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withOwners

public MicrosoftGraphServicePrincipalInner withOwners(List owners)

Set the owners property: 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.

Parameters:

owners - the owners value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withPasswordCredentials

public MicrosoftGraphServicePrincipalInner withPasswordCredentials(List passwordCredentials)

Set the passwordCredentials property: The collection of password credentials associated with the service principal. Not nullable.

Parameters:

passwordCredentials - the passwordCredentials value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withPreferredSingleSignOnMode

public MicrosoftGraphServicePrincipalInner withPreferredSingleSignOnMode(String preferredSingleSignOnMode)

Set the preferredSingleSignOnMode property: 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, external, and oidc.

Parameters:

preferredSingleSignOnMode - the preferredSingleSignOnMode value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withPreferredTokenSigningKeyThumbprint

public MicrosoftGraphServicePrincipalInner withPreferredTokenSigningKeyThumbprint(String preferredTokenSigningKeyThumbprint)

Set the preferredTokenSigningKeyThumbprint property: The preferredTokenSigningKeyThumbprint property.

Parameters:

preferredTokenSigningKeyThumbprint - the preferredTokenSigningKeyThumbprint value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withReplyUrls

public MicrosoftGraphServicePrincipalInner withReplyUrls(List replyUrls)

Set the replyUrls property: 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.

Parameters:

replyUrls - the replyUrls value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withSamlSingleSignOnSettings

public MicrosoftGraphServicePrincipalInner withSamlSingleSignOnSettings(MicrosoftGraphSamlSingleSignOnSettings samlSingleSignOnSettings)

Set the samlSingleSignOnSettings property: samlSingleSignOnSettings.

Parameters:

samlSingleSignOnSettings - the samlSingleSignOnSettings value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withServicePrincipalNames

public MicrosoftGraphServicePrincipalInner withServicePrincipalNames(List servicePrincipalNames)

Set the servicePrincipalNames property: 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.

Parameters:

servicePrincipalNames - the servicePrincipalNames value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withServicePrincipalType

public MicrosoftGraphServicePrincipalInner withServicePrincipalType(String servicePrincipalType)

Set the servicePrincipalType property: 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.

Parameters:

servicePrincipalType - the servicePrincipalType value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withSignInAudience

public MicrosoftGraphServicePrincipalInner withSignInAudience(String signInAudience)

Set the signInAudience property: The signInAudience property.

Parameters:

signInAudience - the signInAudience value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withTags

public MicrosoftGraphServicePrincipalInner withTags(List tags)

Set the tags property: Custom strings that can be used to categorize and identify the service principal. Not nullable.

Parameters:

tags - the tags value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withTokenEncryptionKeyId

public MicrosoftGraphServicePrincipalInner withTokenEncryptionKeyId(UUID tokenEncryptionKeyId)

Set the tokenEncryptionKeyId property: 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.

Parameters:

tokenEncryptionKeyId - the tokenEncryptionKeyId value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withTokenIssuancePolicies

public MicrosoftGraphServicePrincipalInner withTokenIssuancePolicies(List tokenIssuancePolicies)

Set the tokenIssuancePolicies property: The tokenIssuancePolicies assigned to this service principal.

Parameters:

tokenIssuancePolicies - the tokenIssuancePolicies value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withTokenLifetimePolicies

public MicrosoftGraphServicePrincipalInner withTokenLifetimePolicies(List tokenLifetimePolicies)

Set the tokenLifetimePolicies property: The tokenLifetimePolicies assigned to this service principal.

Parameters:

tokenLifetimePolicies - the tokenLifetimePolicies value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.

withTransitiveMemberOf

public MicrosoftGraphServicePrincipalInner withTransitiveMemberOf(List transitiveMemberOf)

Set the transitiveMemberOf property: The transitiveMemberOf property.

Parameters:

transitiveMemberOf - the transitiveMemberOf value to set.

Returns:

the MicrosoftGraphServicePrincipalInner object itself.