ServicePrincipal Class

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: bool = None, alternative_names=None, app_id: str = None, app_role_assignment_required: bool = None, app_roles=None, display_name: str = None, error_url: str = None, homepage: str = None, key_credentials=None, logout_url: str = None, password_credentials=None, preferred_token_signing_key_thumbprint: str = None, publisher_name: str = None, reply_urls=None, saml_metadata_url: str = None, service_principal_names=None, service_principal_type: str = None, tags=None, **kwargs)

Parameters

Name	Description
additional_properties Required	dict[str, object] Unmatched properties from the message are deserialized this collection
object_type Required	str Required. Constant filled by server.
account_enabled Required	bool whether or not the service principal account is enabled
alternative_names Required	list[str] alternative names
app_id Required	str The application ID.
app_role_assignment_required Required	bool 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 Required	list[AppRole] The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
display_name Required	str The display name of the service principal.
error_url Required	str A URL provided by the author of the associated application to report errors when using the application.
homepage Required	str The URL to the homepage of the associated application.
key_credentials Required	list[KeyCredential] The collection of key credentials associated with the service principal.
logout_url Required	str A URL provided by the author of the associated application to logout
password_credentials Required	list[PasswordCredential] The collection of password credentials associated with the service principal.
preferred_token_signing_key_thumbprint Required	str The thumbprint of preferred certificate to sign the token
publisher_name Required	str The publisher's name of the associated application
reply_urls Required	list[str] 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 Required	str The URL to the SAML metadata of the associated application
service_principal_names Required	list[str] A collection of service principal names.
service_principal_type Required	str the type of the service principal
tags Required	list[str] Optional list of tags that you can apply to your service principals. Not nullable.

Keyword-Only Parameters

Name	Description
additional_properties Required
account_enabled Required
alternative_names Required
app_id Required
app_role_assignment_required Required
app_roles Required
display_name Required
error_url Required
homepage Required
key_credentials Required
logout_url Required
password_credentials Required
preferred_token_signing_key_thumbprint Required
publisher_name Required
reply_urls Required
saml_metadata_url Required
service_principal_names Required
service_principal_type Required
tags Required

Variables

Name	Description
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.

Methods

as_dict	Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True.
validate	Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. default value: None
key_extractors	default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes default value: False

Returns

Type	Description
dict	A dict JSON compatible object

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type	Description
list	A list of validation error