Feedback Edit

ServicePrincipal Class

  • Reference

Active Directory service principal information.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
DirectoryObject
ServicePrincipal

Constructor

ServicePrincipal(*, additional_properties=None, account_enabled: Optional[bool] = None, alternative_names=None, app_id: Optional[str] = None, app_role_assignment_required: Optional[bool] = None, app_roles=None, display_name: Optional[str] = None, error_url: Optional[str] = None, homepage: Optional[str] = None, key_credentials=None, logout_url: Optional[str] = None, password_credentials=None, preferred_token_signing_key_thumbprint: Optional[str] = None, publisher_name: Optional[str] = None, reply_urls=None, saml_metadata_url: Optional[str] = None, service_principal_names=None, service_principal_type: Optional[str] = None, tags=None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized this collection

object_type
str
Required

Required. Constant filled by server.

account_enabled
bool
Required

whether or not the service principal account is enabled

alternative_names
list[str]
Required

alternative names

app_id
str
Required

The application ID.

app_role_assignment_required
bool
Required

Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.

app_roles
list[AppRole]
Required

The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.

display_name
str
Required

The display name of the service principal.

error_url
str
Required

A URL provided by the author of the associated application to report errors when using the application.

homepage
str
Required

The URL to the homepage of the associated application.

key_credentials
list[KeyCredential]
Required

The collection of key credentials associated with the service principal.

logout_url
str
Required

A URL provided by the author of the associated application to logout

password_credentials
list[PasswordCredential]
Required

The collection of password credentials associated with the service principal.

preferred_token_signing_key_thumbprint
str
Required

The thumbprint of preferred certificate to sign the token

publisher_name
str
Required

The publisher's name of the associated application

reply_urls
list[str]
Required

The URLs that user tokens are sent to for sign in with the associated application. The redirect URIs that the oAuth 2.0 authorization code and access tokens are sent to for the associated application.

saml_metadata_url
str
Required

The URL to the SAML metadata of the associated application

service_principal_names
list[str]
Required

A collection of service principal names.

service_principal_type
str
Required

the type of the service principal

tags
list[str]
Required

Optional list of tags that you can apply to your service principals. Not nullable.

Variables

object_id
str

The object ID.

deletion_timestamp
datetime

The time at which the directory object was deleted.

app_display_name
str

The display name exposed by the associated application.

app_owner_tenant_id
str
oauth2_permissions
list[OAuth2Permission]

The OAuth 2.0 permissions exposed by the associated application.