Class MicrosoftGraphServicePrincipalInner
- 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
Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types.
-
-
Constructor Summary
Constructors Constructor Description MicrosoftGraphServicePrincipalInner()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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).String
applicationTemplateId()
Get the applicationTemplateId property: Unique identifier of the applicationTemplate that the servicePrincipal was created from.UUID
appOwnerOrganizationId()
Get the appOwnerOrganizationId property: Contains the tenant id where the application is registered.List<MicrosoftGraphAppRoleAssignmentInner>
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<MicrosoftGraphAppRoleAssignmentInner>
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.List<MicrosoftGraphClaimsMappingPolicyInner>
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<MicrosoftGraphDelegatedPermissionClassificationInner>
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<MicrosoftGraphEndpointInner>
endpoints()
Get the endpoints property: Endpoints available for discovery.String
homepage()
Get the homepage property: Home page or landing page of the application.List<MicrosoftGraphHomeRealmDiscoveryPolicyInner>
homeRealmDiscoveryPolicies()
Get the homeRealmDiscoveryPolicies property: The homeRealmDiscoveryPolicies assigned to this service principal.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<MicrosoftGraphOAuth2PermissionGrantInner>
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.UUID
tokenEncryptionKeyId()
Get the tokenEncryptionKeyId property: Specifies the keyId of a public key from the keyCredentials collection.List<MicrosoftGraphTokenIssuancePolicyInner>
tokenIssuancePolicies()
Get the tokenIssuancePolicies property: The tokenIssuancePolicies assigned to this service principal.List<MicrosoftGraphTokenLifetimePolicyInner>
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
withApplicationTemplateId(String applicationTemplateId)
Set the applicationTemplateId property: Unique identifier of the applicationTemplate that the servicePrincipal was created from.MicrosoftGraphServicePrincipalInner
withAppOwnerOrganizationId(UUID appOwnerOrganizationId)
Set the appOwnerOrganizationId property: Contains the tenant id where the application is registered.MicrosoftGraphServicePrincipalInner
withAppRoleAssignedTo(List<MicrosoftGraphAppRoleAssignmentInner> 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<MicrosoftGraphAppRoleAssignmentInner> 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
withClaimsMappingPolicies(List<MicrosoftGraphClaimsMappingPolicyInner> 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<MicrosoftGraphDelegatedPermissionClassificationInner> 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<MicrosoftGraphEndpointInner> endpoints)
Set the endpoints property: Endpoints available for discovery.MicrosoftGraphServicePrincipalInner
withHomepage(String homepage)
Set the homepage property: Home page or landing page of the application.MicrosoftGraphServicePrincipalInner
withHomeRealmDiscoveryPolicies(List<MicrosoftGraphHomeRealmDiscoveryPolicyInner> homeRealmDiscoveryPolicies)
Set the homeRealmDiscoveryPolicies property: The homeRealmDiscoveryPolicies assigned to this service principal.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<MicrosoftGraphOAuth2PermissionGrantInner> 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<MicrosoftGraphTokenIssuancePolicyInner> tokenIssuancePolicies)
Set the tokenIssuancePolicies property: The tokenIssuancePolicies assigned to this service principal.MicrosoftGraphServicePrincipalInner
withTokenLifetimePolicies(List<MicrosoftGraphTokenLifetimePolicyInner> 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 class com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphDirectoryObjectInner
deletedDateTime
-
Methods inherited from class com.azure.resourcemanager.authorization.fluent.models.MicrosoftGraphEntity
id
-
-
-
-
Method Detail
-
accountEnabled
public Boolean accountEnabled()
Get the accountEnabled property: true if the service principal account is enabled; otherwise, false.- Returns:
- the accountEnabled value.
-
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.
-
addIns
public List<MicrosoftGraphAddIn> 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.
-
withAddIns
public 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. 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.
-
alternativeNames
public List<String> 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.
-
withAlternativeNames
public 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.- Parameters:
alternativeNames
- the alternativeNames value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
appDescription
public String appDescription()
Get the appDescription property: The appDescription property.- Returns:
- the appDescription value.
-
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.
-
appDisplayName
public String appDisplayName()
Get the appDisplayName property: The display name exposed by the associated application.- Returns:
- the appDisplayName value.
-
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.
-
appId
public String appId()
Get the appId property: The unique identifier for the associated application (its appId property).- Returns:
- the appId value.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
appRoles
public List<MicrosoftGraphAppRole> 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.
-
withAppRoles
public MicrosoftGraphServicePrincipalInner withAppRoles(List<MicrosoftGraphAppRole> 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.
-
description
public String description()
Get the description property: The description property.- Returns:
- the description value.
-
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.
-
displayName
public String displayName()
Get the displayName property: The display name for the service principal.- Returns:
- the displayName value.
-
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.
-
homepage
public String homepage()
Get the homepage property: Home page or landing page of the application.- Returns:
- the homepage value.
-
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.
-
info
public MicrosoftGraphInformationalUrl info()
Get the info property: informationalUrl.- Returns:
- the info value.
-
withInfo
public MicrosoftGraphServicePrincipalInner withInfo(MicrosoftGraphInformationalUrl info)
Set the info property: informationalUrl.- Parameters:
info
- the info value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
keyCredentials
public List<MicrosoftGraphKeyCredentialInner> keyCredentials()
Get the keyCredentials property: The collection of key credentials associated with the service principal. Not nullable.- Returns:
- the keyCredentials value.
-
withKeyCredentials
public MicrosoftGraphServicePrincipalInner withKeyCredentials(List<MicrosoftGraphKeyCredentialInner> 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.
-
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.
-
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.
-
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.
-
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.
-
notes
public String notes()
Get the notes property: The notes property.- Returns:
- the notes value.
-
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.
-
notificationEmailAddresses
public 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. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.- Returns:
- the notificationEmailAddresses value.
-
withNotificationEmailAddresses
public 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. 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.
-
oauth2PermissionScopes
public List<MicrosoftGraphPermissionScope> 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.
-
withOauth2PermissionScopes
public MicrosoftGraphServicePrincipalInner withOauth2PermissionScopes(List<MicrosoftGraphPermissionScope> 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.
-
passwordCredentials
public List<MicrosoftGraphPasswordCredentialInner> passwordCredentials()
Get the passwordCredentials property: The collection of password credentials associated with the service principal. Not nullable.- Returns:
- the passwordCredentials value.
-
withPasswordCredentials
public MicrosoftGraphServicePrincipalInner withPasswordCredentials(List<MicrosoftGraphPasswordCredentialInner> 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.
-
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.
-
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.
-
preferredTokenSigningKeyThumbprint
public String preferredTokenSigningKeyThumbprint()
Get the preferredTokenSigningKeyThumbprint property: The preferredTokenSigningKeyThumbprint property.- Returns:
- the preferredTokenSigningKeyThumbprint value.
-
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.
-
replyUrls
public 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. Not nullable.- Returns:
- the replyUrls value.
-
withReplyUrls
public 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. Not nullable.- Parameters:
replyUrls
- the replyUrls value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
samlSingleSignOnSettings
public MicrosoftGraphSamlSingleSignOnSettings samlSingleSignOnSettings()
Get the samlSingleSignOnSettings property: samlSingleSignOnSettings.- Returns:
- the samlSingleSignOnSettings value.
-
withSamlSingleSignOnSettings
public MicrosoftGraphServicePrincipalInner withSamlSingleSignOnSettings(MicrosoftGraphSamlSingleSignOnSettings samlSingleSignOnSettings)
Set the samlSingleSignOnSettings property: samlSingleSignOnSettings.- Parameters:
samlSingleSignOnSettings
- the samlSingleSignOnSettings value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
servicePrincipalNames
public List<String> 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.
-
withServicePrincipalNames
public MicrosoftGraphServicePrincipalInner withServicePrincipalNames(List<String> 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.
-
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.
-
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.
-
signInAudience
public String signInAudience()
Get the signInAudience property: The signInAudience property.- Returns:
- the signInAudience value.
-
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.
-
tags
public List<String> tags()
Get the tags property: Custom strings that can be used to categorize and identify the service principal. Not nullable.- Returns:
- the tags value.
-
withTags
public MicrosoftGraphServicePrincipalInner withTags(List<String> 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.
-
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.
-
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.
-
appRoleAssignedTo
public List<MicrosoftGraphAppRoleAssignmentInner> appRoleAssignedTo()
Get the appRoleAssignedTo property: Principals (users, groups, and service principals) that are assigned to this service principal. Read-only.- Returns:
- the appRoleAssignedTo value.
-
withAppRoleAssignedTo
public MicrosoftGraphServicePrincipalInner withAppRoleAssignedTo(List<MicrosoftGraphAppRoleAssignmentInner> 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.
-
appRoleAssignments
public List<MicrosoftGraphAppRoleAssignmentInner> appRoleAssignments()
Get the appRoleAssignments property: Applications that this service principal is assigned to. Read-only. Nullable.- Returns:
- the appRoleAssignments value.
-
withAppRoleAssignments
public MicrosoftGraphServicePrincipalInner withAppRoleAssignments(List<MicrosoftGraphAppRoleAssignmentInner> 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.
-
claimsMappingPolicies
public List<MicrosoftGraphClaimsMappingPolicyInner> claimsMappingPolicies()
Get the claimsMappingPolicies property: The claimsMappingPolicies assigned to this service principal.- Returns:
- the claimsMappingPolicies value.
-
withClaimsMappingPolicies
public MicrosoftGraphServicePrincipalInner withClaimsMappingPolicies(List<MicrosoftGraphClaimsMappingPolicyInner> claimsMappingPolicies)
Set the claimsMappingPolicies property: The claimsMappingPolicies assigned to this service principal.- Parameters:
claimsMappingPolicies
- the claimsMappingPolicies value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
createdObjects
public List<MicrosoftGraphDirectoryObjectInner> createdObjects()
Get the createdObjects property: Directory objects created by this service principal. Read-only. Nullable.- Returns:
- the createdObjects value.
-
withCreatedObjects
public MicrosoftGraphServicePrincipalInner withCreatedObjects(List<MicrosoftGraphDirectoryObjectInner> 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.
-
delegatedPermissionClassifications
public List<MicrosoftGraphDelegatedPermissionClassificationInner> delegatedPermissionClassifications()
Get the delegatedPermissionClassifications property: The delegatedPermissionClassifications property.- Returns:
- the delegatedPermissionClassifications value.
-
withDelegatedPermissionClassifications
public MicrosoftGraphServicePrincipalInner withDelegatedPermissionClassifications(List<MicrosoftGraphDelegatedPermissionClassificationInner> delegatedPermissionClassifications)
Set the delegatedPermissionClassifications property: The delegatedPermissionClassifications property.- Parameters:
delegatedPermissionClassifications
- the delegatedPermissionClassifications value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
endpoints
public List<MicrosoftGraphEndpointInner> 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.
-
withEndpoints
public MicrosoftGraphServicePrincipalInner withEndpoints(List<MicrosoftGraphEndpointInner> 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.
-
homeRealmDiscoveryPolicies
public List<MicrosoftGraphHomeRealmDiscoveryPolicyInner> homeRealmDiscoveryPolicies()
Get the homeRealmDiscoveryPolicies property: The homeRealmDiscoveryPolicies assigned to this service principal.- Returns:
- the homeRealmDiscoveryPolicies value.
-
withHomeRealmDiscoveryPolicies
public MicrosoftGraphServicePrincipalInner withHomeRealmDiscoveryPolicies(List<MicrosoftGraphHomeRealmDiscoveryPolicyInner> homeRealmDiscoveryPolicies)
Set the homeRealmDiscoveryPolicies property: The homeRealmDiscoveryPolicies assigned to this service principal.- Parameters:
homeRealmDiscoveryPolicies
- the homeRealmDiscoveryPolicies value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
memberOf
public List<MicrosoftGraphDirectoryObjectInner> memberOf()
Get the memberOf property: Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable.- Returns:
- the memberOf value.
-
withMemberOf
public MicrosoftGraphServicePrincipalInner withMemberOf(List<MicrosoftGraphDirectoryObjectInner> 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.
-
oauth2PermissionGrants
public List<MicrosoftGraphOAuth2PermissionGrantInner> 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.
-
withOauth2PermissionGrants
public MicrosoftGraphServicePrincipalInner withOauth2PermissionGrants(List<MicrosoftGraphOAuth2PermissionGrantInner> 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.
-
ownedObjects
public List<MicrosoftGraphDirectoryObjectInner> ownedObjects()
Get the ownedObjects property: Directory objects that are owned by this service principal. Read-only. Nullable.- Returns:
- the ownedObjects value.
-
withOwnedObjects
public MicrosoftGraphServicePrincipalInner withOwnedObjects(List<MicrosoftGraphDirectoryObjectInner> 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.
-
owners
public List<MicrosoftGraphDirectoryObjectInner> 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.
-
withOwners
public MicrosoftGraphServicePrincipalInner withOwners(List<MicrosoftGraphDirectoryObjectInner> 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.
-
tokenIssuancePolicies
public List<MicrosoftGraphTokenIssuancePolicyInner> tokenIssuancePolicies()
Get the tokenIssuancePolicies property: The tokenIssuancePolicies assigned to this service principal.- Returns:
- the tokenIssuancePolicies value.
-
withTokenIssuancePolicies
public MicrosoftGraphServicePrincipalInner withTokenIssuancePolicies(List<MicrosoftGraphTokenIssuancePolicyInner> tokenIssuancePolicies)
Set the tokenIssuancePolicies property: The tokenIssuancePolicies assigned to this service principal.- Parameters:
tokenIssuancePolicies
- the tokenIssuancePolicies value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
tokenLifetimePolicies
public List<MicrosoftGraphTokenLifetimePolicyInner> tokenLifetimePolicies()
Get the tokenLifetimePolicies property: The tokenLifetimePolicies assigned to this service principal.- Returns:
- the tokenLifetimePolicies value.
-
withTokenLifetimePolicies
public MicrosoftGraphServicePrincipalInner withTokenLifetimePolicies(List<MicrosoftGraphTokenLifetimePolicyInner> tokenLifetimePolicies)
Set the tokenLifetimePolicies property: The tokenLifetimePolicies assigned to this service principal.- Parameters:
tokenLifetimePolicies
- the tokenLifetimePolicies value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
transitiveMemberOf
public List<MicrosoftGraphDirectoryObjectInner> transitiveMemberOf()
Get the transitiveMemberOf property: The transitiveMemberOf property.- Returns:
- the transitiveMemberOf value.
-
withTransitiveMemberOf
public MicrosoftGraphServicePrincipalInner withTransitiveMemberOf(List<MicrosoftGraphDirectoryObjectInner> transitiveMemberOf)
Set the transitiveMemberOf property: The transitiveMemberOf property.- Parameters:
transitiveMemberOf
- the transitiveMemberOf value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
additionalProperties
public Map<String,Object> 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:
additionalProperties
in classMicrosoftGraphDirectoryObjectInner
- Returns:
- the additionalProperties value.
-
withAdditionalProperties
public MicrosoftGraphServicePrincipalInner withAdditionalProperties(Map<String,Object> 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:
withAdditionalProperties
in classMicrosoftGraphDirectoryObjectInner
- Parameters:
additionalProperties
- the additionalProperties value to set.- Returns:
- the MicrosoftGraphServicePrincipalInner object itself.
-
withDeletedDateTime
public MicrosoftGraphServicePrincipalInner withDeletedDateTime(OffsetDateTime deletedDateTime)
Set the deletedDateTime property: The deletedDateTime property.- Overrides:
withDeletedDateTime
in classMicrosoftGraphDirectoryObjectInner
- Parameters:
deletedDateTime
- the deletedDateTime value to set.- Returns:
- the MicrosoftGraphDirectoryObjectInner object itself.
-
withId
public MicrosoftGraphServicePrincipalInner withId(String id)
Set the id property: Read-only.- Overrides:
withId
in classMicrosoftGraphDirectoryObjectInner
- Parameters:
id
- the id value to set.- Returns:
- the MicrosoftGraphEntity object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classMicrosoftGraphDirectoryObjectInner
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-