Class: MicrosoftGraph::Models::ServicePrincipal

Inherits:
DirectoryObject show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/service_principal.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DirectoryObject

#deleted_date_time, #deleted_date_time=

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new servicePrincipal and sets the default values.



376
377
378
379
 
# File 'lib/models/service_principal.rb', line 376

def initialize()
    super
    @odata_type = "#microsoft.graph.servicePrincipal"
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a service_principal

Raises:

  • (StandardError) 


400
401
402
403
 
# File 'lib/models/service_principal.rb', line 400

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return ServicePrincipal.new
end

Instance Method Details

#account_enabled ⇒ Object

Gets the accountEnabled property value. true if the service principal account is enabled; otherwise, false. If set to false, then no users will be able to sign in to this app, even if they are assigned to it. Supports $filter (eq, ne, not, in).

Returns:

  • a boolean



166
167
168
 
# File 'lib/models/service_principal.rb', line 166

def 
    return @account_enabled
end

#account_enabled=(value) ⇒ Object

Sets the accountEnabled property value. true if the service principal account is enabled; otherwise, false. If set to false, then no users will be able to sign in to this app, even if they are assigned to it. Supports $filter (eq, ne, not, in).

Parameters:

  • value —

    Value to set for the accountEnabled property.

Returns:

  • a void



174
175
176
 
# File 'lib/models/service_principal.rb', line 174

def (value)
    @account_enabled = value
end

#add_ins ⇒ Object

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

  • a add_in



181
182
183
 
# File 'lib/models/service_principal.rb', line 181

def add_ins
    return @add_ins
end

#add_ins=(value) ⇒ Object

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

  • value —

    Value to set for the addIns property.

Returns:

  • a void



189
190
191
 
# File 'lib/models/service_principal.rb', line 189

def add_ins=(value)
    @add_ins = value
end

#alternative_names ⇒ Object

Gets the alternativeNames property value. Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, not, ge, le, startsWith).

Returns:

  • a string



196
197
198
 
# File 'lib/models/service_principal.rb', line 196

def alternative_names
    return @alternative_names
end

#alternative_names=(value) ⇒ Object

Sets the alternativeNames property value. Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, not, ge, le, startsWith).

Parameters:

  • value —

    Value to set for the alternativeNames property.

Returns:

  • a void



204
205
206
 
# File 'lib/models/service_principal.rb', line 204

def alternative_names=(value)
    @alternative_names = value
end

#app_description ⇒ Object

Gets the appDescription property value. The description exposed by the associated application.

Returns:

  • a string



211
212
213
 
# File 'lib/models/service_principal.rb', line 211

def app_description
    return @app_description
end

#app_description=(value) ⇒ Object

Sets the appDescription property value. The description exposed by the associated application.

Parameters:

  • value —

    Value to set for the appDescription property.

Returns:

  • a void



219
220
221
 
# File 'lib/models/service_principal.rb', line 219

def app_description=(value)
    @app_description = value
end

#app_display_name ⇒ Object

Gets the appDisplayName property value. The display name exposed by the associated application.

Returns:

  • a string



226
227
228
 
# File 'lib/models/service_principal.rb', line 226

def app_display_name
    return @app_display_name
end

#app_display_name=(value) ⇒ Object

Sets the appDisplayName property value. The display name exposed by the associated application.

Parameters:

  • value —

    Value to set for the appDisplayName property.

Returns:

  • a void



234
235
236
 
# File 'lib/models/service_principal.rb', line 234

def app_display_name=(value)
    @app_display_name = value
end

#app_id ⇒ Object

Gets the appId property value. The unique identifier for the associated application (its appId property). Supports $filter (eq, ne, not, in, startsWith).

Returns:

  • a string



241
242
243
 
# File 'lib/models/service_principal.rb', line 241

def app_id
    return @app_id
end

#app_id=(value) ⇒ Object

Sets the appId property value. The unique identifier for the associated application (its appId property). Supports $filter (eq, ne, not, in, startsWith).

Parameters:

  • value —

    Value to set for the appId property.

Returns:

  • a void



249
250
251
 
# File 'lib/models/service_principal.rb', line 249

def app_id=(value)
    @app_id = value
end

#app_management_policies ⇒ Object

Gets the appManagementPolicies property value. The appManagementPolicy applied to this application.

Returns:

  • a app_management_policy



256
257
258
 
# File 'lib/models/service_principal.rb', line 256

def app_management_policies
    return @app_management_policies
end

#app_management_policies=(value) ⇒ Object

Sets the appManagementPolicies property value. The appManagementPolicy applied to this application.

Parameters:

  • value —

    Value to set for the appManagementPolicies property.

Returns:

  • a void



264
265
266
 
# File 'lib/models/service_principal.rb', line 264

def app_management_policies=(value)
    @app_management_policies = value
end

#app_owner_organization_id ⇒ Object

Gets the appOwnerOrganizationId property value. Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).

Returns:

  • a guid



271
272
273
 
# File 'lib/models/service_principal.rb', line 271

def app_owner_organization_id
    return @app_owner_organization_id
end

#app_owner_organization_id=(value) ⇒ Object

Sets the appOwnerOrganizationId property value. Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).

Parameters:

  • value —

    Value to set for the appOwnerOrganizationId property.

Returns:

  • a void



279
280
281
 
# File 'lib/models/service_principal.rb', line 279

def app_owner_organization_id=(value)
    @app_owner_organization_id = value
end

#app_role_assigned_to ⇒ Object

Gets the appRoleAssignedTo property value. App role assignments for this app or service, granted to users, groups, and other service principals. Supports $expand.

Returns:

  • a app_role_assignment



286
287
288
 
# File 'lib/models/service_principal.rb', line 286

def app_role_assigned_to
    return @app_role_assigned_to
end

#app_role_assigned_to=(value) ⇒ Object

Sets the appRoleAssignedTo property value. App role assignments for this app or service, granted to users, groups, and other service principals. Supports $expand.

Parameters:

  • value —

    Value to set for the appRoleAssignedTo property.

Returns:

  • a void



294
295
296
 
# File 'lib/models/service_principal.rb', line 294

def app_role_assigned_to=(value)
    @app_role_assigned_to = value
end

#app_role_assignment_required ⇒ Object

Gets the appRoleAssignmentRequired property value. 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. Supports $filter (eq, ne, NOT).

Returns:

  • a boolean



301
302
303
 
# File 'lib/models/service_principal.rb', line 301

def app_role_assignment_required
    return @app_role_assignment_required
end

#app_role_assignment_required=(value) ⇒ Object

Sets the appRoleAssignmentRequired property value. 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. Supports $filter (eq, ne, NOT).

Parameters:

  • value —

    Value to set for the appRoleAssignmentRequired property.

Returns:

  • a void



309
310
311
 
# File 'lib/models/service_principal.rb', line 309

def app_role_assignment_required=(value)
    @app_role_assignment_required = value
end

#app_role_assignments ⇒ Object

Gets the appRoleAssignments property value. App role assignment for another app or service, granted to this service principal. Supports $expand.

Returns:

  • a app_role_assignment



316
317
318
 
# File 'lib/models/service_principal.rb', line 316

def app_role_assignments
    return @app_role_assignments
end

#app_role_assignments=(value) ⇒ Object

Sets the appRoleAssignments property value. App role assignment for another app or service, granted to this service principal. Supports $expand.

Parameters:

  • value —

    Value to set for the appRoleAssignments property.

Returns:

  • a void



324
325
326
 
# File 'lib/models/service_principal.rb', line 324

def app_role_assignments=(value)
    @app_role_assignments = value
end

#app_roles ⇒ Object

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

  • a app_role



331
332
333
 
# File 'lib/models/service_principal.rb', line 331

def app_roles
    return @app_roles
end

#app_roles=(value) ⇒ Object

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

  • value —

    Value to set for the appRoles property.

Returns:

  • a void



339
340
341
 
# File 'lib/models/service_principal.rb', line 339

def app_roles=(value)
    @app_roles = value
end

#application_template_id ⇒ Object

Gets the applicationTemplateId property value. Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter (eq, ne, NOT, startsWith).

Returns:

  • a string



346
347
348
 
# File 'lib/models/service_principal.rb', line 346

def application_template_id
    return @application_template_id
end

#application_template_id=(value) ⇒ Object

Sets the applicationTemplateId property value. Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter (eq, ne, NOT, startsWith).

Parameters:

  • value —

    Value to set for the applicationTemplateId property.

Returns:

  • a void



354
355
356
 
# File 'lib/models/service_principal.rb', line 354

def application_template_id=(value)
    @application_template_id = value
end

#claims_mapping_policies ⇒ Object

Gets the claimsMappingPolicies property value. The claimsMappingPolicies assigned to this service principal. Supports $expand.

Returns:

  • a claims_mapping_policy



361
362
363
 
# File 'lib/models/service_principal.rb', line 361

def claims_mapping_policies
    return @claims_mapping_policies
end

#claims_mapping_policies=(value) ⇒ Object

Sets the claimsMappingPolicies property value. The claimsMappingPolicies assigned to this service principal. Supports $expand.

Parameters:

  • value —

    Value to set for the claimsMappingPolicies property.

Returns:

  • a void



369
370
371
 
# File 'lib/models/service_principal.rb', line 369

def claims_mapping_policies=(value)
    @claims_mapping_policies = value
end

#created_objects ⇒ Object

Gets the createdObjects property value. Directory objects created by this service principal. Read-only. Nullable.

Returns:

  • a directory_object



384
385
386
 
# File 'lib/models/service_principal.rb', line 384

def created_objects
    return @created_objects
end

#created_objects=(value) ⇒ Object

Sets the createdObjects property value. Directory objects created by this service principal. Read-only. Nullable.

Parameters:

  • value —

    Value to set for the createdObjects property.

Returns:

  • a void



392
393
394
 
# File 'lib/models/service_principal.rb', line 392

def created_objects=(value)
    @created_objects = value
end

#custom_security_attributes ⇒ Object

Gets the customSecurityAttributes property value. The customSecurityAttributes property

Returns:

  • a custom_security_attribute_value



408
409
410
 
# File 'lib/models/service_principal.rb', line 408

def custom_security_attributes
    return @custom_security_attributes
end

#custom_security_attributes=(value) ⇒ Object

Sets the customSecurityAttributes property value. The customSecurityAttributes property

Parameters:

  • value —

    Value to set for the customSecurityAttributes property.

Returns:

  • a void



416
417
418
 
# File 'lib/models/service_principal.rb', line 416

def custom_security_attributes=(value)
    @custom_security_attributes = value
end

#delegated_permission_classifications ⇒ Object

Gets the delegatedPermissionClassifications property value. The delegatedPermissionClassifications property

Returns:

  • a delegated_permission_classification



423
424
425
 
# File 'lib/models/service_principal.rb', line 423

def delegated_permission_classifications
    return @delegated_permission_classifications
end

#delegated_permission_classifications=(value) ⇒ Object

Sets the delegatedPermissionClassifications property value. The delegatedPermissionClassifications property

Parameters:

  • value —

    Value to set for the delegatedPermissionClassifications property.

Returns:

  • a void



431
432
433
 
# File 'lib/models/service_principal.rb', line 431

def delegated_permission_classifications=(value)
    @delegated_permission_classifications = value
end

#description ⇒ Object

Gets the description property value. Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.

Returns:

  • a string



438
439
440
 
# File 'lib/models/service_principal.rb', line 438

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



446
447
448
 
# File 'lib/models/service_principal.rb', line 446

def description=(value)
    @description = value
end

#disabled_by_microsoft_status ⇒ Object

Gets the disabledByMicrosoftStatus property value. Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not).

Returns:

  • a string



453
454
455
 
# File 'lib/models/service_principal.rb', line 453

def disabled_by_microsoft_status
    return @disabled_by_microsoft_status
end

#disabled_by_microsoft_status=(value) ⇒ Object

Sets the disabledByMicrosoftStatus property value. Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not).

Parameters:

  • value —

    Value to set for the disabledByMicrosoftStatus property.

Returns:

  • a void



461
462
463
 
# File 'lib/models/service_principal.rb', line 461

def disabled_by_microsoft_status=(value)
    @disabled_by_microsoft_status = value
end

#display_name ⇒ Object

Gets the displayName property value. The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.

Returns:

  • a string



468
469
470
 
# File 'lib/models/service_principal.rb', line 468

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



476
477
478
 
# File 'lib/models/service_principal.rb', line 476

def display_name=(value)
    @display_name = value
end

#endpoints ⇒ Object

Gets the endpoints property value. The endpoints property

Returns:

  • a endpoint



483
484
485
 
# File 'lib/models/service_principal.rb', line 483

def endpoints
    return @endpoints
end

#endpoints=(value) ⇒ Object

Sets the endpoints property value. The endpoints property

Parameters:

  • value —

    Value to set for the endpoints property.

Returns:

  • a void



491
492
493
 
# File 'lib/models/service_principal.rb', line 491

def endpoints=(value)
    @endpoints = value
end

#federated_identity_credentials ⇒ Object

Gets the federatedIdentityCredentials property value. Federated identities for a specific type of service principal - managed identity. Supports $expand and $filter (/$count eq 0, /$count ne 0).

Returns:

  • a federated_identity_credential



498
499
500
 
# File 'lib/models/service_principal.rb', line 498

def federated_identity_credentials
    return @federated_identity_credentials
end

#federated_identity_credentials=(value) ⇒ Object

Sets the federatedIdentityCredentials property value. Federated identities for a specific type of service principal - managed identity. Supports $expand and $filter (/$count eq 0, /$count ne 0).

Parameters:

  • value —

    Value to set for the federatedIdentityCredentials property.

Returns:

  • a void



506
507
508
 
# File 'lib/models/service_principal.rb', line 506

def federated_identity_credentials=(value)
    @federated_identity_credentials = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/models/service_principal.rb', line 513

def get_field_deserializers()
    return super.merge({
        "accountEnabled" => lambda {|n| @account_enabled = n.get_boolean_value() },
        "addIns" => lambda {|n| @add_ins = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AddIn.create_from_discriminator_value(pn) }) },
        "alternativeNames" => lambda {|n| @alternative_names = n.get_collection_of_primitive_values(String) },
        "appDescription" => lambda {|n| @app_description = n.get_string_value() },
        "appDisplayName" => lambda {|n| @app_display_name = n.get_string_value() },
        "appId" => lambda {|n| @app_id = n.get_string_value() },
        "appManagementPolicies" => lambda {|n| @app_management_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AppManagementPolicy.create_from_discriminator_value(pn) }) },
        "appOwnerOrganizationId" => lambda {|n| @app_owner_organization_id = n.get_guid_value() },
        "appRoleAssignedTo" => lambda {|n| @app_role_assigned_to = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AppRoleAssignment.create_from_discriminator_value(pn) }) },
        "appRoleAssignmentRequired" => lambda {|n| @app_role_assignment_required = n.get_boolean_value() },
        "appRoleAssignments" => lambda {|n| @app_role_assignments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AppRoleAssignment.create_from_discriminator_value(pn) }) },
        "appRoles" => lambda {|n| @app_roles = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AppRole.create_from_discriminator_value(pn) }) },
        "applicationTemplateId" => lambda {|n| @application_template_id = n.get_string_value() },
        "claimsMappingPolicies" => lambda {|n| @claims_mapping_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ClaimsMappingPolicy.create_from_discriminator_value(pn) }) },
        "createdObjects" => lambda {|n| @created_objects = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "customSecurityAttributes" => lambda {|n| @custom_security_attributes = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::CustomSecurityAttributeValue.create_from_discriminator_value(pn) }) },
        "delegatedPermissionClassifications" => lambda {|n| @delegated_permission_classifications = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DelegatedPermissionClassification.create_from_discriminator_value(pn) }) },
        "description" => lambda {|n| @description = n.get_string_value() },
        "disabledByMicrosoftStatus" => lambda {|n| @disabled_by_microsoft_status = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "endpoints" => lambda {|n| @endpoints = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Endpoint.create_from_discriminator_value(pn) }) },
        "federatedIdentityCredentials" => lambda {|n| @federated_identity_credentials = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::FederatedIdentityCredential.create_from_discriminator_value(pn) }) },
        "homeRealmDiscoveryPolicies" => lambda {|n| @home_realm_discovery_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::HomeRealmDiscoveryPolicy.create_from_discriminator_value(pn) }) },
        "homepage" => lambda {|n| @homepage = n.get_string_value() },
        "info" => lambda {|n| @info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::InformationalUrl.create_from_discriminator_value(pn) }) },
        "keyCredentials" => lambda {|n| @key_credentials = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::KeyCredential.create_from_discriminator_value(pn) }) },
        "loginUrl" => lambda {|n| @login_url = n.get_string_value() },
        "logoutUrl" => lambda {|n| @logout_url = n.get_string_value() },
        "memberOf" => lambda {|n| @member_of = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "notes" => lambda {|n| @notes = n.get_string_value() },
        "notificationEmailAddresses" => lambda {|n| @notification_email_addresses = n.get_collection_of_primitive_values(String) },
        "oauth2PermissionGrants" => lambda {|n| @oauth2_permission_grants = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::OAuth2PermissionGrant.create_from_discriminator_value(pn) }) },
        "oauth2PermissionScopes" => lambda {|n| @oauth2_permission_scopes = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::PermissionScope.create_from_discriminator_value(pn) }) },
        "ownedObjects" => lambda {|n| @owned_objects = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "owners" => lambda {|n| @owners = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "passwordCredentials" => lambda {|n| @password_credentials = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::PasswordCredential.create_from_discriminator_value(pn) }) },
        "preferredSingleSignOnMode" => lambda {|n| @preferred_single_sign_on_mode = n.get_string_value() },
        "preferredTokenSigningKeyThumbprint" => lambda {|n| @preferred_token_signing_key_thumbprint = n.get_string_value() },
        "replyUrls" => lambda {|n| @reply_urls = n.get_collection_of_primitive_values(String) },
        "resourceSpecificApplicationPermissions" => lambda {|n| @resource_specific_application_permissions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ResourceSpecificPermission.create_from_discriminator_value(pn) }) },
        "samlSingleSignOnSettings" => lambda {|n| @saml_single_sign_on_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SamlSingleSignOnSettings.create_from_discriminator_value(pn) }) },
        "servicePrincipalNames" => lambda {|n| @service_principal_names = n.get_collection_of_primitive_values(String) },
        "servicePrincipalType" => lambda {|n| @service_principal_type = n.get_string_value() },
        "signInAudience" => lambda {|n| @sign_in_audience = n.get_string_value() },
        "synchronization" => lambda {|n| @synchronization = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Synchronization.create_from_discriminator_value(pn) }) },
        "tags" => lambda {|n| @tags = n.get_collection_of_primitive_values(String) },
        "tokenEncryptionKeyId" => lambda {|n| @token_encryption_key_id = n.get_guid_value() },
        "tokenIssuancePolicies" => lambda {|n| @token_issuance_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::TokenIssuancePolicy.create_from_discriminator_value(pn) }) },
        "tokenLifetimePolicies" => lambda {|n| @token_lifetime_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::TokenLifetimePolicy.create_from_discriminator_value(pn) }) },
        "transitiveMemberOf" => lambda {|n| @transitive_member_of = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "verifiedPublisher" => lambda {|n| @verified_publisher = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::VerifiedPublisher.create_from_discriminator_value(pn) }) },
    })
end

#home_realm_discovery_policies ⇒ Object

Gets the homeRealmDiscoveryPolicies property value. The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand.

Returns:

  • a home_realm_discovery_policy



572
573
574
 
# File 'lib/models/service_principal.rb', line 572

def home_realm_discovery_policies
    return @home_realm_discovery_policies
end

#home_realm_discovery_policies=(value) ⇒ Object

Sets the homeRealmDiscoveryPolicies property value. The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand.

Parameters:

  • value —

    Value to set for the homeRealmDiscoveryPolicies property.

Returns:

  • a void



580
581
582
 
# File 'lib/models/service_principal.rb', line 580

def home_realm_discovery_policies=(value)
    @home_realm_discovery_policies = value
end

#homepage ⇒ Object

Gets the homepage property value. Home page or landing page of the application.

Returns:

  • a string



587
588
589
 
# File 'lib/models/service_principal.rb', line 587

def homepage
    return @homepage
end

#homepage=(value) ⇒ Object

Sets the homepage property value. Home page or landing page of the application.

Parameters:

  • value —

    Value to set for the homepage property.

Returns:

  • a void



595
596
597
 
# File 'lib/models/service_principal.rb', line 595

def homepage=(value)
    @homepage = value
end

#info ⇒ Object

Gets the info property value. Basic profile information of the acquired application such as app’s marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps. Supports $filter (eq, ne, not, ge, le, and eq on null values).

Returns:

  • a informational_url



602
603
604
 
# File 'lib/models/service_principal.rb', line 602

def info
    return @info
end

#info=(value) ⇒ Object

Sets the info property value. Basic profile information of the acquired application such as app’s marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps. Supports $filter (eq, ne, not, ge, le, and eq on null values).

Parameters:

  • value —

    Value to set for the info property.

Returns:

  • a void



610
611
612
 
# File 'lib/models/service_principal.rb', line 610

def info=(value)
    @info = value
end

#key_credentials ⇒ Object

Gets the keyCredentials property value. The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le).

Returns:

  • a key_credential



617
618
619
 
# File 'lib/models/service_principal.rb', line 617

def key_credentials
    return @key_credentials
end

#key_credentials=(value) ⇒ Object

Sets the keyCredentials property value. The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le).

Parameters:

  • value —

    Value to set for the keyCredentials property.

Returns:

  • a void



625
626
627
 
# File 'lib/models/service_principal.rb', line 625

def key_credentials=(value)
    @key_credentials = value
end

#login_url ⇒ Object

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

  • a string



632
633
634
 
# File 'lib/models/service_principal.rb', line 632

def 
    return @login_url
end

#login_url=(value) ⇒ Object

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

  • value —

    Value to set for the loginUrl property.

Returns:

  • a void



640
641
642
 
# File 'lib/models/service_principal.rb', line 640

def (value)
    @login_url = value
end

#logout_url ⇒ Object

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

  • a string



647
648
649
 
# File 'lib/models/service_principal.rb', line 647

def logout_url
    return @logout_url
end

#logout_url=(value) ⇒ Object

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

  • value —

    Value to set for the logoutUrl property.

Returns:

  • a void



655
656
657
 
# File 'lib/models/service_principal.rb', line 655

def logout_url=(value)
    @logout_url = value
end

#member_of ⇒ Object

Gets the memberOf property value. Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable. Supports $expand.

Returns:

  • a directory_object



662
663
664
 
# File 'lib/models/service_principal.rb', line 662

def member_of
    return @member_of
end

#member_of=(value) ⇒ Object

Sets the memberOf property value. Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable. Supports $expand.

Parameters:

  • value —

    Value to set for the memberOf property.

Returns:

  • a void



670
671
672
 
# File 'lib/models/service_principal.rb', line 670

def member_of=(value)
    @member_of = value
end

#notes ⇒ Object

Gets the notes property value. Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.

Returns:

  • a string



677
678
679
 
# File 'lib/models/service_principal.rb', line 677

def notes
    return @notes
end

#notes=(value) ⇒ Object

Sets the notes property value. Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.

Parameters:

  • value —

    Value to set for the notes property.

Returns:

  • a void



685
686
687
 
# File 'lib/models/service_principal.rb', line 685

def notes=(value)
    @notes = value
end

#notification_email_addresses ⇒ Object

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

  • a string



692
693
694
 
# File 'lib/models/service_principal.rb', line 692

def notification_email_addresses
    return @notification_email_addresses
end

#notification_email_addresses=(value) ⇒ Object

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

  • value —

    Value to set for the notificationEmailAddresses property.

Returns:

  • a void



700
701
702
 
# File 'lib/models/service_principal.rb', line 700

def notification_email_addresses=(value)
    @notification_email_addresses = value
end

#oauth2_permission_grants ⇒ Object

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

Returns:

  • a o_auth2_permission_grant



707
708
709
 
# File 'lib/models/service_principal.rb', line 707

def oauth2_permission_grants
    return @oauth2_permission_grants
end

#oauth2_permission_grants=(value) ⇒ Object

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

Parameters:

  • value —

    Value to set for the oauth2PermissionGrants property.

Returns:

  • a void



715
716
717
 
# File 'lib/models/service_principal.rb', line 715

def oauth2_permission_grants=(value)
    @oauth2_permission_grants = value
end

#oauth2_permission_scopes ⇒ Object

Gets the oauth2PermissionScopes property value. The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity’s api property. Not nullable.

Returns:

  • a permission_scope



722
723
724
 
# File 'lib/models/service_principal.rb', line 722

def oauth2_permission_scopes
    return @oauth2_permission_scopes
end

#oauth2_permission_scopes=(value) ⇒ Object

Sets the oauth2PermissionScopes property value. The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity’s api property. Not nullable.

Parameters:

  • value —

    Value to set for the oauth2PermissionScopes property.

Returns:

  • a void



730
731
732
 
# File 'lib/models/service_principal.rb', line 730

def oauth2_permission_scopes=(value)
    @oauth2_permission_scopes = value
end

#owned_objects ⇒ Object

Gets the ownedObjects property value. Directory objects that are owned by this service principal. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).

Returns:

  • a directory_object



737
738
739
 
# File 'lib/models/service_principal.rb', line 737

def owned_objects
    return @owned_objects
end

#owned_objects=(value) ⇒ Object

Sets the ownedObjects property value. Directory objects that are owned by this service principal. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).

Parameters:

  • value —

    Value to set for the ownedObjects property.

Returns:

  • a void



745
746
747
 
# File 'lib/models/service_principal.rb', line 745

def owned_objects=(value)
    @owned_objects = value
end

#owners ⇒ Object

Gets the owners property value. 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. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand.

Returns:

  • a directory_object



752
753
754
 
# File 'lib/models/service_principal.rb', line 752

def owners
    return @owners
end

#owners=(value) ⇒ Object

Sets the owners property value. 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. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand.

Parameters:

  • value —

    Value to set for the owners property.

Returns:

  • a void



760
761
762
 
# File 'lib/models/service_principal.rb', line 760

def owners=(value)
    @owners = value
end

#password_credentials ⇒ Object

Gets the passwordCredentials property value. The collection of password credentials associated with the application. Not nullable.

Returns:

  • a password_credential



767
768
769
 
# File 'lib/models/service_principal.rb', line 767

def password_credentials
    return @password_credentials
end

#password_credentials=(value) ⇒ Object

Sets the passwordCredentials property value. The collection of password credentials associated with the application. Not nullable.

Parameters:

  • value —

    Value to set for the passwordCredentials property.

Returns:

  • a void



775
776
777
 
# File 'lib/models/service_principal.rb', line 775

def password_credentials=(value)
    @password_credentials = value
end

#preferred_single_sign_on_mode ⇒ Object

Gets the preferredSingleSignOnMode property value. 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, notSupported, and oidc.

Returns:

  • a string



782
783
784
 
# File 'lib/models/service_principal.rb', line 782

def preferred_single_sign_on_mode
    return @preferred_single_sign_on_mode
end

#preferred_single_sign_on_mode=(value) ⇒ Object

Sets the preferredSingleSignOnMode property value. 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, notSupported, and oidc.

Parameters:

  • value —

    Value to set for the preferredSingleSignOnMode property.

Returns:

  • a void



790
791
792
 
# File 'lib/models/service_principal.rb', line 790

def preferred_single_sign_on_mode=(value)
    @preferred_single_sign_on_mode = value
end

#preferred_token_signing_key_thumbprint ⇒ Object

Gets the preferredTokenSigningKeyThumbprint property value. This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses. For applications that are not SAML, do not write or otherwise rely on this property.

Returns:

  • a string



797
798
799
 
# File 'lib/models/service_principal.rb', line 797

def preferred_token_signing_key_thumbprint
    return @preferred_token_signing_key_thumbprint
end

#preferred_token_signing_key_thumbprint=(value) ⇒ Object

Sets the preferredTokenSigningKeyThumbprint property value. This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses. For applications that are not SAML, do not write or otherwise rely on this property.

Parameters:

  • value —

    Value to set for the preferredTokenSigningKeyThumbprint property.

Returns:

  • a void



805
806
807
 
# File 'lib/models/service_principal.rb', line 805

def preferred_token_signing_key_thumbprint=(value)
    @preferred_token_signing_key_thumbprint = value
end

#reply_urls ⇒ Object

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

  • a string



812
813
814
 
# File 'lib/models/service_principal.rb', line 812

def reply_urls
    return @reply_urls
end

#reply_urls=(value) ⇒ Object

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

  • value —

    Value to set for the replyUrls property.

Returns:

  • a void



820
821
822
 
# File 'lib/models/service_principal.rb', line 820

def reply_urls=(value)
    @reply_urls = value
end

#resource_specific_application_permissions ⇒ Object

Gets the resourceSpecificApplicationPermissions property value. The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only.

Returns:

  • a resource_specific_permission



827
828
829
 
# File 'lib/models/service_principal.rb', line 827

def resource_specific_application_permissions
    return @resource_specific_application_permissions
end

#resource_specific_application_permissions=(value) ⇒ Object

Sets the resourceSpecificApplicationPermissions property value. The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only.

Parameters:

  • value —

    Value to set for the resourceSpecificApplicationPermissions property.

Returns:

  • a void



835
836
837
 
# File 'lib/models/service_principal.rb', line 835

def resource_specific_application_permissions=(value)
    @resource_specific_application_permissions = value
end

#saml_single_sign_on_settings ⇒ Object

Gets the samlSingleSignOnSettings property value. The collection for settings related to saml single sign-on.

Returns:

  • a saml_single_sign_on_settings



842
843
844
 
# File 'lib/models/service_principal.rb', line 842

def saml_single_sign_on_settings
    return @saml_single_sign_on_settings
end

#saml_single_sign_on_settings=(value) ⇒ Object

Sets the samlSingleSignOnSettings property value. The collection for settings related to saml single sign-on.

Parameters:

  • value —

    Value to set for the samlSingleSignOnSettings property.

Returns:

  • a void



850
851
852
 
# File 'lib/models/service_principal.rb', line 850

def saml_single_sign_on_settings=(value)
    @saml_single_sign_on_settings = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/models/service_principal.rb', line 858

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_boolean_value("accountEnabled", @account_enabled)
    writer.write_collection_of_object_values("addIns", @add_ins)
    writer.write_collection_of_primitive_values("alternativeNames", @alternative_names)
    writer.write_string_value("appDescription", @app_description)
    writer.write_string_value("appDisplayName", @app_display_name)
    writer.write_string_value("appId", @app_id)
    writer.write_collection_of_object_values("appManagementPolicies", @app_management_policies)
    writer.write_guid_value("appOwnerOrganizationId", @app_owner_organization_id)
    writer.write_collection_of_object_values("appRoleAssignedTo", @app_role_assigned_to)
    writer.write_boolean_value("appRoleAssignmentRequired", @app_role_assignment_required)
    writer.write_collection_of_object_values("appRoleAssignments", @app_role_assignments)
    writer.write_collection_of_object_values("appRoles", @app_roles)
    writer.write_string_value("applicationTemplateId", @application_template_id)
    writer.write_collection_of_object_values("claimsMappingPolicies", @claims_mapping_policies)
    writer.write_collection_of_object_values("createdObjects", @created_objects)
    writer.write_object_value("customSecurityAttributes", @custom_security_attributes)
    writer.write_collection_of_object_values("delegatedPermissionClassifications", @delegated_permission_classifications)
    writer.write_string_value("description", @description)
    writer.write_string_value("disabledByMicrosoftStatus", @disabled_by_microsoft_status)
    writer.write_string_value("displayName", @display_name)
    writer.write_collection_of_object_values("endpoints", @endpoints)
    writer.write_collection_of_object_values("federatedIdentityCredentials", @federated_identity_credentials)
    writer.write_collection_of_object_values("homeRealmDiscoveryPolicies", @home_realm_discovery_policies)
    writer.write_string_value("homepage", @homepage)
    writer.write_object_value("info", @info)
    writer.write_collection_of_object_values("keyCredentials", @key_credentials)
    writer.write_string_value("loginUrl", @login_url)
    writer.write_string_value("logoutUrl", @logout_url)
    writer.write_collection_of_object_values("memberOf", @member_of)
    writer.write_string_value("notes", @notes)
    writer.write_collection_of_primitive_values("notificationEmailAddresses", @notification_email_addresses)
    writer.write_collection_of_object_values("oauth2PermissionGrants", @oauth2_permission_grants)
    writer.write_collection_of_object_values("oauth2PermissionScopes", @oauth2_permission_scopes)
    writer.write_collection_of_object_values("ownedObjects", @owned_objects)
    writer.write_collection_of_object_values("owners", @owners)
    writer.write_collection_of_object_values("passwordCredentials", @password_credentials)
    writer.write_string_value("preferredSingleSignOnMode", @preferred_single_sign_on_mode)
    writer.write_string_value("preferredTokenSigningKeyThumbprint", @preferred_token_signing_key_thumbprint)
    writer.write_collection_of_primitive_values("replyUrls", @reply_urls)
    writer.write_collection_of_object_values("resourceSpecificApplicationPermissions", @resource_specific_application_permissions)
    writer.write_object_value("samlSingleSignOnSettings", @saml_single_sign_on_settings)
    writer.write_collection_of_primitive_values("servicePrincipalNames", @service_principal_names)
    writer.write_string_value("servicePrincipalType", @service_principal_type)
    writer.write_string_value("signInAudience", @sign_in_audience)
    writer.write_object_value("synchronization", @synchronization)
    writer.write_collection_of_primitive_values("tags", @tags)
    writer.write_guid_value("tokenEncryptionKeyId", @token_encryption_key_id)
    writer.write_collection_of_object_values("tokenIssuancePolicies", @token_issuance_policies)
    writer.write_collection_of_object_values("tokenLifetimePolicies", @token_lifetime_policies)
    writer.write_collection_of_object_values("transitiveMemberOf", @transitive_member_of)
    writer.write_object_value("verifiedPublisher", @verified_publisher)
end

#service_principal_names ⇒ Object

Gets the servicePrincipalNames property value. 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. Supports $filter (eq, not, ge, le, startsWith).

Returns:

  • a string



917
918
919
 
# File 'lib/models/service_principal.rb', line 917

def service_principal_names
    return @service_principal_names
end

#service_principal_names=(value) ⇒ Object

Sets the servicePrincipalNames property value. 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. Supports $filter (eq, not, ge, le, startsWith).

Parameters:

  • value —

    Value to set for the servicePrincipalNames property.

Returns:

  • a void



925
926
927
 
# File 'lib/models/service_principal.rb', line 925

def service_principal_names=(value)
    @service_principal_names = value
end

#service_principal_type ⇒ Object

Gets the servicePrincipalType property value. Identifies whether the service principal represents an application, a managed identity, or a legacy application. This is set by Azure AD internally. The servicePrincipalType property can be set to three different values: Application - A service principal that represents an application or service. The appId property identifies the associated app registration, and matches the appId of an application, possibly from a different tenant. If the associated app registration is missing, tokens are not issued for the service principal.ManagedIdentity - A service principal that represents a managed identity. Service principals representing managed identities can be granted access and permissions, but cannot be updated or modified directly.Legacy - A service principal that represents an app created before app registrations, or through legacy experiences. Legacy service principal can have credentials, service principal names, reply URLs, and other properties which are editable by an authorized user, but does not have an associated app registration. The appId value does not associate the service principal with an app registration. The service principal can only be used in the tenant where it was created.SocialIdp - For internal use.

Returns:

  • a string



932
933
934
 
# File 'lib/models/service_principal.rb', line 932

def service_principal_type
    return @service_principal_type
end

#service_principal_type=(value) ⇒ Object

Sets the servicePrincipalType property value. Identifies whether the service principal represents an application, a managed identity, or a legacy application. This is set by Azure AD internally. The servicePrincipalType property can be set to three different values: Application - A service principal that represents an application or service. The appId property identifies the associated app registration, and matches the appId of an application, possibly from a different tenant. If the associated app registration is missing, tokens are not issued for the service principal.ManagedIdentity - A service principal that represents a managed identity. Service principals representing managed identities can be granted access and permissions, but cannot be updated or modified directly.Legacy - A service principal that represents an app created before app registrations, or through legacy experiences. Legacy service principal can have credentials, service principal names, reply URLs, and other properties which are editable by an authorized user, but does not have an associated app registration. The appId value does not associate the service principal with an app registration. The service principal can only be used in the tenant where it was created.SocialIdp - For internal use.

Parameters:

  • value —

    Value to set for the servicePrincipalType property.

Returns:

  • a void



940
941
942
 
# File 'lib/models/service_principal.rb', line 940

def service_principal_type=(value)
    @service_principal_type = value
end

#sign_in_audience ⇒ Object

Gets the signInAudience property value. Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization’s Azure AD tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization’s Azure AD tenant (multi-tenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.

Returns:

  • a string



947
948
949
 
# File 'lib/models/service_principal.rb', line 947

def 
    return @sign_in_audience
end

#sign_in_audience=(value) ⇒ Object

Sets the signInAudience property value. Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization’s Azure AD tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization’s Azure AD tenant (multi-tenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.

Parameters:

  • value —

    Value to set for the signInAudience property.

Returns:

  • a void



955
956
957
 
# File 'lib/models/service_principal.rb', line 955

def (value)
    @sign_in_audience = value
end

#synchronization ⇒ Object

Gets the synchronization property value. Represents the capability for Azure Active Directory (Azure AD) identity synchronization through the Microsoft Graph API.

Returns:

  • a synchronization



962
963
964
 
# File 'lib/models/service_principal.rb', line 962

def synchronization
    return @synchronization
end

#synchronization=(value) ⇒ Object

Sets the synchronization property value. Represents the capability for Azure Active Directory (Azure AD) identity synchronization through the Microsoft Graph API.

Parameters:

  • value —

    Value to set for the synchronization property.

Returns:

  • a void



970
971
972
 
# File 'lib/models/service_principal.rb', line 970

def synchronization=(value)
    @synchronization = value
end

#tags ⇒ Object

Gets the tags property value. Custom strings that can be used to categorize and identify the service principal. Not nullable. The value is the union of strings set here and on the associated application entity’s tags property.Supports $filter (eq, not, ge, le, startsWith).

Returns:

  • a string



977
978
979
 
# File 'lib/models/service_principal.rb', line 977

def tags
    return @tags
end

#tags=(value) ⇒ Object

Sets the tags property value. Custom strings that can be used to categorize and identify the service principal. Not nullable. The value is the union of strings set here and on the associated application entity’s tags property.Supports $filter (eq, not, ge, le, startsWith).

Parameters:

  • value —

    Value to set for the tags property.

Returns:

  • a void



985
986
987
 
# File 'lib/models/service_principal.rb', line 985

def tags=(value)
    @tags = value
end

#token_encryption_key_id ⇒ Object

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

  • a guid



992
993
994
 
# File 'lib/models/service_principal.rb', line 992

def token_encryption_key_id
    return @token_encryption_key_id
end

#token_encryption_key_id=(value) ⇒ Object

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

  • value —

    Value to set for the tokenEncryptionKeyId property.

Returns:

  • a void



1000
1001
1002
 
# File 'lib/models/service_principal.rb', line 1000

def token_encryption_key_id=(value)
    @token_encryption_key_id = value
end

#token_issuance_policies ⇒ Object

Gets the tokenIssuancePolicies property value. The tokenIssuancePolicies assigned to this service principal.

Returns:

  • a token_issuance_policy



1007
1008
1009
 
# File 'lib/models/service_principal.rb', line 1007

def token_issuance_policies
    return @token_issuance_policies
end

#token_issuance_policies=(value) ⇒ Object

Sets the tokenIssuancePolicies property value. The tokenIssuancePolicies assigned to this service principal.

Parameters:

  • value —

    Value to set for the tokenIssuancePolicies property.

Returns:

  • a void



1015
1016
1017
 
# File 'lib/models/service_principal.rb', line 1015

def token_issuance_policies=(value)
    @token_issuance_policies = value
end

#token_lifetime_policies ⇒ Object

Gets the tokenLifetimePolicies property value. The tokenLifetimePolicies assigned to this service principal.

Returns:

  • a token_lifetime_policy



1022
1023
1024
 
# File 'lib/models/service_principal.rb', line 1022

def token_lifetime_policies
    return @token_lifetime_policies
end

#token_lifetime_policies=(value) ⇒ Object

Sets the tokenLifetimePolicies property value. The tokenLifetimePolicies assigned to this service principal.

Parameters:

  • value —

    Value to set for the tokenLifetimePolicies property.

Returns:

  • a void



1030
1031
1032
 
# File 'lib/models/service_principal.rb', line 1030

def token_lifetime_policies=(value)
    @token_lifetime_policies = value
end

#transitive_member_of ⇒ Object

Gets the transitiveMemberOf property value. The transitiveMemberOf property

Returns:

  • a directory_object



1037
1038
1039
 
# File 'lib/models/service_principal.rb', line 1037

def transitive_member_of
    return @transitive_member_of
end

#transitive_member_of=(value) ⇒ Object

Sets the transitiveMemberOf property value. The transitiveMemberOf property

Parameters:

  • value —

    Value to set for the transitiveMemberOf property.

Returns:

  • a void



1045
1046
1047
 
# File 'lib/models/service_principal.rb', line 1045

def transitive_member_of=(value)
    @transitive_member_of = value
end

#verified_publisher ⇒ Object

Gets the verifiedPublisher property value. Specifies the verified publisher of the application which this service principal represents.

Returns:

  • a verified_publisher



1052
1053
1054
 
# File 'lib/models/service_principal.rb', line 1052

def verified_publisher
    return @verified_publisher
end

#verified_publisher=(value) ⇒ Object

Sets the verifiedPublisher property value. Specifies the verified publisher of the application which this service principal represents.

Parameters:

  • value —

    Value to set for the verifiedPublisher property.

Returns:

  • a void



1060
1061
1062
 
# File 'lib/models/service_principal.rb', line 1060

def verified_publisher=(value)
    @verified_publisher = value
end