public final class ServicePrincipalInner extends DirectoryObjectInner
Constructor and Description |
---|
ServicePrincipalInner() |
Modifier and Type | Method and Description |
---|---|
Boolean |
accountEnabled()
Get the accountEnabled property: whether or not the service principal account is enabled.
|
List<String> |
alternativeNames()
Get the alternativeNames property: alternative names.
|
String |
appDisplayName()
Get the appDisplayName property: The display name exposed by the associated application.
|
String |
appId()
Get the appId property: The application ID.
|
String |
appOwnerTenantId()
Get the appOwnerTenantId property: The appOwnerTenantId property.
|
Boolean |
appRoleAssignmentRequired()
Get the appRoleAssignmentRequired property: Specifies whether an AppRoleAssignment to a user or group is required
before Azure AD will issue a user or access token to the application.
|
List<AppRole> |
appRoles()
Get the appRoles property: The collection of application roles that an application may declare.
|
String |
displayName()
Get the displayName property: The display name of the service principal.
|
String |
errorUrl()
Get the errorUrl property: A URL provided by the author of the associated application to report errors when using
the application.
|
String |
homepage()
Get the homepage property: The URL to the homepage of the associated application.
|
List<KeyCredentialInner> |
keyCredentials()
Get the keyCredentials property: The collection of key credentials associated with the service principal.
|
String |
logoutUrl()
Get the logoutUrl property: A URL provided by the author of the associated application to logout.
|
List<OAuth2Permission> |
oauth2Permissions()
Get the oauth2Permissions property: The OAuth 2.0 permissions exposed by the associated application.
|
List<PasswordCredentialInner> |
passwordCredentials()
Get the passwordCredentials property: The collection of password credentials associated with the service
principal.
|
String |
preferredTokenSigningKeyThumbprint()
Get the preferredTokenSigningKeyThumbprint property: The thumbprint of preferred certificate to sign the token.
|
String |
publisherName()
Get the publisherName property: The publisher's name of the associated application.
|
List<String> |
replyUrls()
Get the replyUrls property: The URLs that user tokens are sent to for sign in with the associated application.
|
String |
samlMetadataUrl()
Get the samlMetadataUrl property: The URL to the SAML metadata of the associated application.
|
List<String> |
servicePrincipalNames()
Get the servicePrincipalNames property: A collection of service principal names.
|
String |
servicePrincipalType()
Get the servicePrincipalType property: the type of the service principal.
|
List<String> |
tags()
Get the tags property: Optional list of tags that you can apply to your service principals.
|
void |
validate()
Validates the instance.
|
ServicePrincipalInner |
withAccountEnabled(Boolean accountEnabled)
Set the accountEnabled property: whether or not the service principal account is enabled.
|
ServicePrincipalInner |
withAlternativeNames(List<String> alternativeNames)
Set the alternativeNames property: alternative names.
|
ServicePrincipalInner |
withAppId(String appId)
Set the appId property: The application ID.
|
ServicePrincipalInner |
withAppRoleAssignmentRequired(Boolean appRoleAssignmentRequired)
Set the appRoleAssignmentRequired property: Specifies whether an AppRoleAssignment to a user or group is required
before Azure AD will issue a user or access token to the application.
|
ServicePrincipalInner |
withAppRoles(List<AppRole> appRoles)
Set the appRoles property: The collection of application roles that an application may declare.
|
ServicePrincipalInner |
withDisplayName(String displayName)
Set the displayName property: The display name of the service principal.
|
ServicePrincipalInner |
withErrorUrl(String errorUrl)
Set the errorUrl property: A URL provided by the author of the associated application to report errors when using
the application.
|
ServicePrincipalInner |
withHomepage(String homepage)
Set the homepage property: The URL to the homepage of the associated application.
|
ServicePrincipalInner |
withKeyCredentials(List<KeyCredentialInner> keyCredentials)
Set the keyCredentials property: The collection of key credentials associated with the service principal.
|
ServicePrincipalInner |
withLogoutUrl(String logoutUrl)
Set the logoutUrl property: A URL provided by the author of the associated application to logout.
|
ServicePrincipalInner |
withPasswordCredentials(List<PasswordCredentialInner> passwordCredentials)
Set the passwordCredentials property: The collection of password credentials associated with the service
principal.
|
ServicePrincipalInner |
withPreferredTokenSigningKeyThumbprint(String preferredTokenSigningKeyThumbprint)
Set the preferredTokenSigningKeyThumbprint property: The thumbprint of preferred certificate to sign the token.
|
ServicePrincipalInner |
withPublisherName(String publisherName)
Set the publisherName property: The publisher's name of the associated application.
|
ServicePrincipalInner |
withReplyUrls(List<String> replyUrls)
Set the replyUrls property: The URLs that user tokens are sent to for sign in with the associated application.
|
ServicePrincipalInner |
withSamlMetadataUrl(String samlMetadataUrl)
Set the samlMetadataUrl property: The URL to the SAML metadata of the associated application.
|
ServicePrincipalInner |
withServicePrincipalNames(List<String> servicePrincipalNames)
Set the servicePrincipalNames property: A collection of service principal names.
|
ServicePrincipalInner |
withServicePrincipalType(String servicePrincipalType)
Set the servicePrincipalType property: the type of the service principal.
|
ServicePrincipalInner |
withTags(List<String> tags)
Set the tags property: Optional list of tags that you can apply to your service principals.
|
additionalProperties, deletionTimestamp, objectId, withAdditionalProperties
public Boolean accountEnabled()
public ServicePrincipalInner withAccountEnabled(Boolean accountEnabled)
accountEnabled
- the accountEnabled value to set.public List<String> alternativeNames()
public ServicePrincipalInner withAlternativeNames(List<String> alternativeNames)
alternativeNames
- the alternativeNames value to set.public String appDisplayName()
public String appId()
public ServicePrincipalInner withAppId(String appId)
appId
- the appId value to set.public String appOwnerTenantId()
public Boolean appRoleAssignmentRequired()
public ServicePrincipalInner withAppRoleAssignmentRequired(Boolean appRoleAssignmentRequired)
appRoleAssignmentRequired
- the appRoleAssignmentRequired value to set.public List<AppRole> appRoles()
public ServicePrincipalInner withAppRoles(List<AppRole> appRoles)
appRoles
- the appRoles value to set.public String displayName()
public ServicePrincipalInner withDisplayName(String displayName)
displayName
- the displayName value to set.public String errorUrl()
public ServicePrincipalInner withErrorUrl(String errorUrl)
errorUrl
- the errorUrl value to set.public String homepage()
public ServicePrincipalInner withHomepage(String homepage)
homepage
- the homepage value to set.public List<KeyCredentialInner> keyCredentials()
public ServicePrincipalInner withKeyCredentials(List<KeyCredentialInner> keyCredentials)
keyCredentials
- the keyCredentials value to set.public String logoutUrl()
public ServicePrincipalInner withLogoutUrl(String logoutUrl)
logoutUrl
- the logoutUrl value to set.public List<OAuth2Permission> oauth2Permissions()
public List<PasswordCredentialInner> passwordCredentials()
public ServicePrincipalInner withPasswordCredentials(List<PasswordCredentialInner> passwordCredentials)
passwordCredentials
- the passwordCredentials value to set.public String preferredTokenSigningKeyThumbprint()
public ServicePrincipalInner withPreferredTokenSigningKeyThumbprint(String preferredTokenSigningKeyThumbprint)
preferredTokenSigningKeyThumbprint
- the preferredTokenSigningKeyThumbprint value to set.public String publisherName()
public ServicePrincipalInner withPublisherName(String publisherName)
publisherName
- the publisherName value to set.public List<String> replyUrls()
public ServicePrincipalInner withReplyUrls(List<String> replyUrls)
replyUrls
- the replyUrls value to set.public String samlMetadataUrl()
public ServicePrincipalInner withSamlMetadataUrl(String samlMetadataUrl)
samlMetadataUrl
- the samlMetadataUrl value to set.public List<String> servicePrincipalNames()
public ServicePrincipalInner withServicePrincipalNames(List<String> servicePrincipalNames)
servicePrincipalNames
- the servicePrincipalNames value to set.public String servicePrincipalType()
public ServicePrincipalInner withServicePrincipalType(String servicePrincipalType)
servicePrincipalType
- the servicePrincipalType value to set.public List<String> tags()
public ServicePrincipalInner withTags(List<String> tags)
tags
- the tags value to set.public void validate()
validate
in class DirectoryObjectInner
IllegalArgumentException
- thrown if the instance is not valid.Copyright © 2020 Microsoft Corporation. All rights reserved.