Class: MicrosoftGraph::Models::Application

Inherits:
DirectoryObject show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/application.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 application and sets the default values.



251
252
253
254
 
# File 'lib/models/application.rb', line 251

def initialize()
    super
    @odata_type = "#microsoft.graph.application"
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 application

Raises:

  • (StandardError) 


290
291
292
293
 
# File 'lib/models/application.rb', line 290

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

Instance Method Details

#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 Office 365 call the application in the context of a document the user is working on.

Returns:

  • a add_in



146
147
148
 
# File 'lib/models/application.rb', line 146

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 Office 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



154
155
156
 
# File 'lib/models/application.rb', line 154

def add_ins=(value)
    @add_ins = value
end

#api ⇒ Object

Gets the api property value. Specifies settings for an application that implements a web API.

Returns:

  • a api_application



161
162
163
 
# File 'lib/models/application.rb', line 161

def api
    return @api
end

#api=(value) ⇒ Object

Sets the api property value. Specifies settings for an application that implements a web API.

Parameters:

  • value —

    Value to set for the api property.

Returns:

  • a void



169
170
171
 
# File 'lib/models/application.rb', line 169

def api=(value)
    @api = value
end

#app_id ⇒ Object

Gets the appId property value. The unique identifier for the application that is assigned to an application by Azure AD. Not nullable. Read-only. Supports $filter (eq).

Returns:

  • a string



176
177
178
 
# File 'lib/models/application.rb', line 176

def app_id
    return @app_id
end

#app_id=(value) ⇒ Object

Sets the appId property value. The unique identifier for the application that is assigned to an application by Azure AD. Not nullable. Read-only. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the appId property.

Returns:

  • a void



184
185
186
 
# File 'lib/models/application.rb', line 184

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



191
192
193
 
# File 'lib/models/application.rb', line 191

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



199
200
201
 
# File 'lib/models/application.rb', line 199

def app_management_policies=(value)
    @app_management_policies = value
end

#app_roles ⇒ Object

Gets the appRoles property value. The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable.

Returns:

  • a app_role



206
207
208
 
# File 'lib/models/application.rb', line 206

def app_roles
    return @app_roles
end

#app_roles=(value) ⇒ Object

Sets the appRoles property value. The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable.

Parameters:

  • value —

    Value to set for the appRoles property.

Returns:

  • a void



214
215
216
 
# File 'lib/models/application.rb', line 214

def app_roles=(value)
    @app_roles = value
end

#application_template_id ⇒ Object

Gets the applicationTemplateId property value. Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne).

Returns:

  • a string



221
222
223
 
# File 'lib/models/application.rb', line 221

def application_template_id
    return @application_template_id
end

#application_template_id=(value) ⇒ Object

Sets the applicationTemplateId property value. Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne).

Parameters:

  • value —

    Value to set for the applicationTemplateId property.

Returns:

  • a void



229
230
231
 
# File 'lib/models/application.rb', line 229

def application_template_id=(value)
    @application_template_id = value
end

#certification ⇒ Object

Gets the certification property value. Specifies the certification status of the application.

Returns:

  • a certification



236
237
238
 
# File 'lib/models/application.rb', line 236

def certification
    return @certification
end

#certification=(value) ⇒ Object

Sets the certification property value. Specifies the certification status of the application.

Parameters:

  • value —

    Value to set for the certification property.

Returns:

  • a void



244
245
246
 
# File 'lib/models/application.rb', line 244

def certification=(value)
    @certification = value
end

#created_date_time ⇒ Object

Gets the createdDateTime property value. The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, in, and eq on null values) and $orderBy.

Returns:

  • a date_time



259
260
261
 
# File 'lib/models/application.rb', line 259

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, in, and eq on null values) and $orderBy.

Parameters:

  • value —

    Value to set for the createdDateTime property.

Returns:

  • a void



267
268
269
 
# File 'lib/models/application.rb', line 267

def created_date_time=(value)
    @created_date_time = value
end

#created_on_behalf_of ⇒ Object

Gets the createdOnBehalfOf property value. Supports $filter (/$count eq 0, /$count ne 0). Read-only.

Returns:

  • a directory_object



274
275
276
 
# File 'lib/models/application.rb', line 274

def created_on_behalf_of
    return @created_on_behalf_of
end

#created_on_behalf_of=(value) ⇒ Object

Sets the createdOnBehalfOf property value. Supports $filter (/$count eq 0, /$count ne 0). Read-only.

Parameters:

  • value —

    Value to set for the createdOnBehalfOf property.

Returns:

  • a void



282
283
284
 
# File 'lib/models/application.rb', line 282

def created_on_behalf_of=(value)
    @created_on_behalf_of = value
end

#default_redirect_uri ⇒ Object

Gets the defaultRedirectUri property value. The defaultRedirectUri property

Returns:

  • a string



298
299
300
 
# File 'lib/models/application.rb', line 298

def default_redirect_uri
    return @default_redirect_uri
end

#default_redirect_uri=(value) ⇒ Object

Sets the defaultRedirectUri property value. The defaultRedirectUri property

Parameters:

  • value —

    Value to set for the defaultRedirectUri property.

Returns:

  • a void



306
307
308
 
# File 'lib/models/application.rb', line 306

def default_redirect_uri=(value)
    @default_redirect_uri = value
end

#description ⇒ Object

Gets the description property value. Free text field to provide a description of the application object to end users. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.

Returns:

  • a string



313
314
315
 
# File 'lib/models/application.rb', line 313

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. Free text field to provide a description of the application object to end users. 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



321
322
323
 
# File 'lib/models/application.rb', line 321

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



328
329
330
 
# File 'lib/models/application.rb', line 328

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



336
337
338
 
# File 'lib/models/application.rb', line 336

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 application. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.

Returns:

  • a string



343
344
345
 
# File 'lib/models/application.rb', line 343

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. The display name for the application. 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



351
352
353
 
# File 'lib/models/application.rb', line 351

def display_name=(value)
    @display_name = value
end

#extension_properties ⇒ Object

Gets the extensionProperties property value. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0).

Returns:

  • a extension_property



358
359
360
 
# File 'lib/models/application.rb', line 358

def extension_properties
    return @extension_properties
end

#extension_properties=(value) ⇒ Object

Sets the extensionProperties property value. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0).

Parameters:

  • value —

    Value to set for the extensionProperties property.

Returns:

  • a void



366
367
368
 
# File 'lib/models/application.rb', line 366

def extension_properties=(value)
    @extension_properties = value
end

#federated_identity_credentials ⇒ Object

Gets the federatedIdentityCredentials property value. Federated identities for applications. Supports $expand and $filter (startsWith, /$count eq 0, /$count ne 0).

Returns:

  • a federated_identity_credential



373
374
375
 
# File 'lib/models/application.rb', line 373

def federated_identity_credentials
    return @federated_identity_credentials
end

#federated_identity_credentials=(value) ⇒ Object

Sets the federatedIdentityCredentials property value. Federated identities for applications. Supports $expand and $filter (startsWith, /$count eq 0, /$count ne 0).

Parameters:

  • value —

    Value to set for the federatedIdentityCredentials property.

Returns:

  • a void



381
382
383
 
# File 'lib/models/application.rb', line 381

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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/models/application.rb', line 388

def get_field_deserializers()
    return super.merge({
        "addIns" => lambda {|n| @add_ins = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AddIn.create_from_discriminator_value(pn) }) },
        "api" => lambda {|n| @api = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ApiApplication.create_from_discriminator_value(pn) }) },
        "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) }) },
        "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() },
        "certification" => lambda {|n| @certification = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Certification.create_from_discriminator_value(pn) }) },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "createdOnBehalfOf" => lambda {|n| @created_on_behalf_of = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "defaultRedirectUri" => lambda {|n| @default_redirect_uri = n.get_string_value() },
        "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() },
        "extensionProperties" => lambda {|n| @extension_properties = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ExtensionProperty.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) }) },
        "groupMembershipClaims" => lambda {|n| @group_membership_claims = n.get_string_value() },
        "homeRealmDiscoveryPolicies" => lambda {|n| @home_realm_discovery_policies = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::HomeRealmDiscoveryPolicy.create_from_discriminator_value(pn) }) },
        "identifierUris" => lambda {|n| @identifier_uris = n.get_collection_of_primitive_values(String) },
        "info" => lambda {|n| @info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::InformationalUrl.create_from_discriminator_value(pn) }) },
        "isDeviceOnlyAuthSupported" => lambda {|n| @is_device_only_auth_supported = n.get_boolean_value() },
        "isFallbackPublicClient" => lambda {|n| @is_fallback_public_client = n.get_boolean_value() },
        "keyCredentials" => lambda {|n| @key_credentials = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::KeyCredential.create_from_discriminator_value(pn) }) },
        "logo" => lambda {|n|  = n.get_object_value(lambda {|pn| Base64url.create_from_discriminator_value(pn) }) },
        "notes" => lambda {|n| @notes = n.get_string_value() },
        "oauth2RequirePostResponse" => lambda {|n| @oauth2_require_post_response = n.get_boolean_value() },
        "optionalClaims" => lambda {|n| @optional_claims = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::OptionalClaims.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) }) },
        "parentalControlSettings" => lambda {|n| @parental_control_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ParentalControlSettings.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) }) },
        "publicClient" => lambda {|n| @public_client = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PublicClientApplication.create_from_discriminator_value(pn) }) },
        "publisherDomain" => lambda {|n| @publisher_domain = n.get_string_value() },
        "requestSignatureVerification" => lambda {|n| @request_signature_verification = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::RequestSignatureVerification.create_from_discriminator_value(pn) }) },
        "requiredResourceAccess" => lambda {|n| @required_resource_access = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::RequiredResourceAccess.create_from_discriminator_value(pn) }) },
        "samlMetadataUrl" => lambda {|n| @saml_metadata_url = n.get_string_value() },
        "serviceManagementReference" => lambda {|n| @service_management_reference = n.get_string_value() },
        "signInAudience" => lambda {|n| @sign_in_audience = n.get_string_value() },
        "spa" => lambda {|n| @spa = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SpaApplication.create_from_discriminator_value(pn) }) },
        "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) }) },
        "verifiedPublisher" => lambda {|n| @verified_publisher = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::VerifiedPublisher.create_from_discriminator_value(pn) }) },
        "web" => lambda {|n| @web = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WebApplication.create_from_discriminator_value(pn) }) },
    })
end

#group_membership_claims ⇒ Object

Gets the groupMembershipClaims property value. Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all of the security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of).

Returns:

  • a string



440
441
442
 
# File 'lib/models/application.rb', line 440

def group_membership_claims
    return @group_membership_claims
end

#group_membership_claims=(value) ⇒ Object

Sets the groupMembershipClaims property value. Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all of the security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of).

Parameters:

  • value —

    Value to set for the groupMembershipClaims property.

Returns:

  • a void



448
449
450
 
# File 'lib/models/application.rb', line 448

def group_membership_claims=(value)
    @group_membership_claims = value
end

#home_realm_discovery_policies ⇒ Object

Gets the homeRealmDiscoveryPolicies property value. The homeRealmDiscoveryPolicies property

Returns:

  • a home_realm_discovery_policy



455
456
457
 
# File 'lib/models/application.rb', line 455

def home_realm_discovery_policies
    return @home_realm_discovery_policies
end

#home_realm_discovery_policies=(value) ⇒ Object

Sets the homeRealmDiscoveryPolicies property value. The homeRealmDiscoveryPolicies property

Parameters:

  • value —

    Value to set for the homeRealmDiscoveryPolicies property.

Returns:

  • a void



463
464
465
 
# File 'lib/models/application.rb', line 463

def home_realm_discovery_policies=(value)
    @home_realm_discovery_policies = value
end

#identifier_uris ⇒ Object

Gets the identifierUris property value. Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you’ll reference in your API’s code, and it must be globally unique. You can use the default value provided, which is in the form api://<application-client-id>, or specify a more readable URI like contoso.com/api. For more information on valid identifierUris patterns and best practices, see Azure AD application registration security best practices. Not nullable. Supports $filter (eq, ne, ge, le, startsWith).

Returns:

  • a string



470
471
472
 
# File 'lib/models/application.rb', line 470

def identifier_uris
    return @identifier_uris
end

#identifier_uris=(value) ⇒ Object

Sets the identifierUris property value. Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you’ll reference in your API’s code, and it must be globally unique. You can use the default value provided, which is in the form api://<application-client-id>, or specify a more readable URI like contoso.com/api. For more information on valid identifierUris patterns and best practices, see Azure AD application registration security best practices. Not nullable. Supports $filter (eq, ne, ge, le, startsWith).

Parameters:

  • value —

    Value to set for the identifierUris property.

Returns:

  • a void



478
479
480
 
# File 'lib/models/application.rb', line 478

def identifier_uris=(value)
    @identifier_uris = value
end

#info ⇒ Object

Gets the info property value. Basic profile information of the 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



485
486
487
 
# File 'lib/models/application.rb', line 485

def info
    return @info
end

#info=(value) ⇒ Object

Sets the info property value. Basic profile information of the 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



493
494
495
 
# File 'lib/models/application.rb', line 493

def info=(value)
    @info = value
end

#is_device_only_auth_supported ⇒ Object

Gets the isDeviceOnlyAuthSupported property value. Specifies whether this application supports device authentication without a user. The default is false.

Returns:

  • a boolean



500
501
502
 
# File 'lib/models/application.rb', line 500

def is_device_only_auth_supported
    return @is_device_only_auth_supported
end

#is_device_only_auth_supported=(value) ⇒ Object

Sets the isDeviceOnlyAuthSupported property value. Specifies whether this application supports device authentication without a user. The default is false.

Parameters:

  • value —

    Value to set for the isDeviceOnlyAuthSupported property.

Returns:

  • a void



508
509
510
 
# File 'lib/models/application.rb', line 508

def is_device_only_auth_supported=(value)
    @is_device_only_auth_supported = value
end

#is_fallback_public_client ⇒ Object

Gets the isFallbackPublicClient property value. Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where it is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property.

Returns:

  • a boolean



515
516
517
 
# File 'lib/models/application.rb', line 515

def is_fallback_public_client
    return @is_fallback_public_client
end

#is_fallback_public_client=(value) ⇒ Object

Sets the isFallbackPublicClient property value. Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where it is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property.

Parameters:

  • value —

    Value to set for the isFallbackPublicClient property.

Returns:

  • a void



523
524
525
 
# File 'lib/models/application.rb', line 523

def is_fallback_public_client=(value)
    @is_fallback_public_client = value
end

#key_credentials ⇒ Object

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

Returns:

  • a key_credential



530
531
532
 
# File 'lib/models/application.rb', line 530

def key_credentials
    return @key_credentials
end

#key_credentials=(value) ⇒ Object

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

Parameters:

  • value —

    Value to set for the keyCredentials property.

Returns:

  • a void



538
539
540
 
# File 'lib/models/application.rb', line 538

def key_credentials=(value)
    @key_credentials = value
end

#logo ⇒ Object

Gets the logo property value. The main logo for the application. Not nullable.

Returns:

  • a base64url



545
546
547
 
# File 'lib/models/application.rb', line 545

def 
    return 
end

#logo=(value) ⇒ Object

Sets the logo property value. The main logo for the application. Not nullable.

Parameters:

  • value —

    Value to set for the logo property.

Returns:

  • a void



553
554
555
 
# File 'lib/models/application.rb', line 553

def logo=(value)
     = value
end

#notes ⇒ Object

Gets the notes property value. Notes relevant for the management of the application.

Returns:

  • a string



560
561
562
 
# File 'lib/models/application.rb', line 560

def notes
    return @notes
end

#notes=(value) ⇒ Object

Sets the notes property value. Notes relevant for the management of the application.

Parameters:

  • value —

    Value to set for the notes property.

Returns:

  • a void



568
569
570
 
# File 'lib/models/application.rb', line 568

def notes=(value)
    @notes = value
end

#oauth2_require_post_response ⇒ Object

Gets the oauth2RequirePostResponse property value. The oauth2RequirePostResponse property

Returns:

  • a boolean



575
576
577
 
# File 'lib/models/application.rb', line 575

def oauth2_require_post_response
    return @oauth2_require_post_response
end

#oauth2_require_post_response=(value) ⇒ Object

Sets the oauth2RequirePostResponse property value. The oauth2RequirePostResponse property

Parameters:

  • value —

    Value to set for the oauth2RequirePostResponse property.

Returns:

  • a void



583
584
585
 
# File 'lib/models/application.rb', line 583

def oauth2_require_post_response=(value)
    @oauth2_require_post_response = value
end

#optional_claims ⇒ Object

Gets the optionalClaims property value. Application developers can configure optional claims in their Azure AD applications to specify the claims that are sent to their application by the Microsoft security token service. For more information, see How to: Provide optional claims to your app.

Returns:

  • a optional_claims



590
591
592
 
# File 'lib/models/application.rb', line 590

def optional_claims
    return @optional_claims
end

#optional_claims=(value) ⇒ Object

Sets the optionalClaims property value. Application developers can configure optional claims in their Azure AD applications to specify the claims that are sent to their application by the Microsoft security token service. For more information, see How to: Provide optional claims to your app.

Parameters:

  • value —

    Value to set for the optionalClaims property.

Returns:

  • a void



598
599
600
 
# File 'lib/models/application.rb', line 598

def optional_claims=(value)
    @optional_claims = value
end

#owners ⇒ Object

Gets the owners property value. Directory objects that are owners of the application. 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



605
606
607
 
# File 'lib/models/application.rb', line 605

def owners
    return @owners
end

#owners=(value) ⇒ Object

Sets the owners property value. Directory objects that are owners of the application. 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



613
614
615
 
# File 'lib/models/application.rb', line 613

def owners=(value)
    @owners = value
end

#parental_control_settings ⇒ Object

Gets the parentalControlSettings property value. Specifies parental control settings for an application.

Returns:

  • a parental_control_settings



620
621
622
 
# File 'lib/models/application.rb', line 620

def parental_control_settings
    return @parental_control_settings
end

#parental_control_settings=(value) ⇒ Object

Sets the parentalControlSettings property value. Specifies parental control settings for an application.

Parameters:

  • value —

    Value to set for the parentalControlSettings property.

Returns:

  • a void



628
629
630
 
# File 'lib/models/application.rb', line 628

def parental_control_settings=(value)
    @parental_control_settings = 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



635
636
637
 
# File 'lib/models/application.rb', line 635

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



643
644
645
 
# File 'lib/models/application.rb', line 643

def password_credentials=(value)
    @password_credentials = value
end

#public_client ⇒ Object

Gets the publicClient property value. Specifies settings for installed clients such as desktop or mobile devices.

Returns:

  • a public_client_application



650
651
652
 
# File 'lib/models/application.rb', line 650

def public_client
    return @public_client
end

#public_client=(value) ⇒ Object

Sets the publicClient property value. Specifies settings for installed clients such as desktop or mobile devices.

Parameters:

  • value —

    Value to set for the publicClient property.

Returns:

  • a void



658
659
660
 
# File 'lib/models/application.rb', line 658

def public_client=(value)
    @public_client = value
end

#publisher_domain ⇒ Object

Gets the publisherDomain property value. The verified publisher domain for the application. Read-only. For more information, see How to: Configure an application’s publisher domain. Supports $filter (eq, ne, ge, le, startsWith).

Returns:

  • a string



665
666
667
 
# File 'lib/models/application.rb', line 665

def publisher_domain
    return @publisher_domain
end

#publisher_domain=(value) ⇒ Object

Sets the publisherDomain property value. The verified publisher domain for the application. Read-only. For more information, see How to: Configure an application’s publisher domain. Supports $filter (eq, ne, ge, le, startsWith).

Parameters:

  • value —

    Value to set for the publisherDomain property.

Returns:

  • a void



673
674
675
 
# File 'lib/models/application.rb', line 673

def publisher_domain=(value)
    @publisher_domain = value
end

#request_signature_verification ⇒ Object

Gets the requestSignatureVerification property value. Specifies whether this application requires Azure AD to verify the signed authentication requests.

Returns:

  • a request_signature_verification



680
681
682
 
# File 'lib/models/application.rb', line 680

def request_signature_verification
    return @request_signature_verification
end

#request_signature_verification=(value) ⇒ Object

Sets the requestSignatureVerification property value. Specifies whether this application requires Azure AD to verify the signed authentication requests.

Parameters:

  • value —

    Value to set for the requestSignatureVerification property.

Returns:

  • a void



688
689
690
 
# File 'lib/models/application.rb', line 688

def request_signature_verification=(value)
    @request_signature_verification = value
end

#required_resource_access ⇒ Object

Gets the requiredResourceAccess property value. Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see Limits on requested permissions per app. Not nullable. Supports $filter (eq, not, ge, le).

Returns:

  • a required_resource_access



695
696
697
 
# File 'lib/models/application.rb', line 695

def required_resource_access
    return @required_resource_access
end

#required_resource_access=(value) ⇒ Object

Sets the requiredResourceAccess property value. Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see Limits on requested permissions per app. Not nullable. Supports $filter (eq, not, ge, le).

Parameters:

  • value —

    Value to set for the requiredResourceAccess property.

Returns:

  • a void



703
704
705
 
# File 'lib/models/application.rb', line 703

def required_resource_access=(value)
    @required_resource_access = value
end

#saml_metadata_url ⇒ Object

Gets the samlMetadataUrl property value. The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable.

Returns:

  • a string



710
711
712
 
# File 'lib/models/application.rb', line 710

def saml_metadata_url
    return @saml_metadata_url
end

#saml_metadata_url=(value) ⇒ Object

Sets the samlMetadataUrl property value. The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable.

Parameters:

  • value —

    Value to set for the samlMetadataUrl property.

Returns:

  • a void



718
719
720
 
# File 'lib/models/application.rb', line 718

def saml_metadata_url=(value)
    @saml_metadata_url = 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) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/models/application.rb', line 726

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("addIns", @add_ins)
    writer.write_object_value("api", @api)
    writer.write_string_value("appId", @app_id)
    writer.write_collection_of_object_values("appManagementPolicies", @app_management_policies)
    writer.write_collection_of_object_values("appRoles", @app_roles)
    writer.write_string_value("applicationTemplateId", @application_template_id)
    writer.write_object_value("certification", @certification)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_object_value("createdOnBehalfOf", @created_on_behalf_of)
    writer.write_string_value("defaultRedirectUri", @default_redirect_uri)
    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("extensionProperties", @extension_properties)
    writer.write_collection_of_object_values("federatedIdentityCredentials", @federated_identity_credentials)
    writer.write_string_value("groupMembershipClaims", @group_membership_claims)
    writer.write_collection_of_object_values("homeRealmDiscoveryPolicies", @home_realm_discovery_policies)
    writer.write_collection_of_primitive_values("identifierUris", @identifier_uris)
    writer.write_object_value("info", @info)
    writer.write_boolean_value("isDeviceOnlyAuthSupported", @is_device_only_auth_supported)
    writer.write_boolean_value("isFallbackPublicClient", @is_fallback_public_client)
    writer.write_collection_of_object_values("keyCredentials", @key_credentials)
    writer.write_object_value("logo", )
    writer.write_string_value("notes", @notes)
    writer.write_boolean_value("oauth2RequirePostResponse", @oauth2_require_post_response)
    writer.write_object_value("optionalClaims", @optional_claims)
    writer.write_collection_of_object_values("owners", @owners)
    writer.write_object_value("parentalControlSettings", @parental_control_settings)
    writer.write_collection_of_object_values("passwordCredentials", @password_credentials)
    writer.write_object_value("publicClient", @public_client)
    writer.write_string_value("publisherDomain", @publisher_domain)
    writer.write_object_value("requestSignatureVerification", @request_signature_verification)
    writer.write_collection_of_object_values("requiredResourceAccess", @required_resource_access)
    writer.write_string_value("samlMetadataUrl", @saml_metadata_url)
    writer.write_string_value("serviceManagementReference", @service_management_reference)
    writer.write_string_value("signInAudience", @sign_in_audience)
    writer.write_object_value("spa", @spa)
    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_object_value("verifiedPublisher", @verified_publisher)
    writer.write_object_value("web", @web)
end

#service_management_reference ⇒ Object

Gets the serviceManagementReference property value. References application or service contact information from a Service or Asset Management database. Nullable.

Returns:

  • a string



778
779
780
 
# File 'lib/models/application.rb', line 778

def service_management_reference
    return @service_management_reference
end

#service_management_reference=(value) ⇒ Object

Sets the serviceManagementReference property value. References application or service contact information from a Service or Asset Management database. Nullable.

Parameters:

  • value —

    Value to set for the serviceManagementReference property.

Returns:

  • a void



786
787
788
 
# File 'lib/models/application.rb', line 786

def service_management_reference=(value)
    @service_management_reference = value
end

#sign_in_audience ⇒ Object

Gets the signInAudience property value. Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount. See more in the table. The value of this object also limits the number of permissions an app can request. For more information, see Limits on requested permissions per app. The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see Validation differences for signInAudience.Supports $filter (eq, ne, not).

Returns:

  • a string



793
794
795
 
# File 'lib/models/application.rb', line 793

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. The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount. See more in the table. The value of this object also limits the number of permissions an app can request. For more information, see Limits on requested permissions per app. The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see Validation differences for signInAudience.Supports $filter (eq, ne, not).

Parameters:

  • value —

    Value to set for the signInAudience property.

Returns:

  • a void



801
802
803
 
# File 'lib/models/application.rb', line 801

def (value)
    @sign_in_audience = value
end

#spa ⇒ Object

Gets the spa property value. Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens.

Returns:

  • a spa_application



808
809
810
 
# File 'lib/models/application.rb', line 808

def spa
    return @spa
end

#spa=(value) ⇒ Object

Sets the spa property value. Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens.

Parameters:

  • value —

    Value to set for the spa property.

Returns:

  • a void



816
817
818
 
# File 'lib/models/application.rb', line 816

def spa=(value)
    @spa = 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



823
824
825
 
# File 'lib/models/application.rb', line 823

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



831
832
833
 
# File 'lib/models/application.rb', line 831

def synchronization=(value)
    @synchronization = value
end

#tags ⇒ Object

Gets the tags property value. Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here will also appear in the tags property of any associated service principals.Supports $filter (eq, not, ge, le, startsWith) and $search.

Returns:

  • a string



838
839
840
 
# File 'lib/models/application.rb', line 838

def tags
    return @tags
end

#tags=(value) ⇒ Object

Sets the tags property value. Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here will also appear in the tags property of any associated service principals.Supports $filter (eq, not, ge, le, startsWith) and $search.

Parameters:

  • value —

    Value to set for the tags property.

Returns:

  • a void



846
847
848
 
# File 'lib/models/application.rb', line 846

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 encrypts all the tokens it emits by using the key this property points to. 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



853
854
855
 
# File 'lib/models/application.rb', line 853

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 encrypts all the tokens it emits by using the key this property points to. 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



861
862
863
 
# File 'lib/models/application.rb', line 861

def token_encryption_key_id=(value)
    @token_encryption_key_id = value
end

#token_issuance_policies ⇒ Object

Gets the tokenIssuancePolicies property value. The tokenIssuancePolicies property

Returns:

  • a token_issuance_policy



868
869
870
 
# File 'lib/models/application.rb', line 868

def token_issuance_policies
    return @token_issuance_policies
end

#token_issuance_policies=(value) ⇒ Object

Sets the tokenIssuancePolicies property value. The tokenIssuancePolicies property

Parameters:

  • value —

    Value to set for the tokenIssuancePolicies property.

Returns:

  • a void



876
877
878
 
# File 'lib/models/application.rb', line 876

def token_issuance_policies=(value)
    @token_issuance_policies = value
end

#token_lifetime_policies ⇒ Object

Gets the tokenLifetimePolicies property value. The tokenLifetimePolicies property

Returns:

  • a token_lifetime_policy



883
884
885
 
# File 'lib/models/application.rb', line 883

def token_lifetime_policies
    return @token_lifetime_policies
end

#token_lifetime_policies=(value) ⇒ Object

Sets the tokenLifetimePolicies property value. The tokenLifetimePolicies property

Parameters:

  • value —

    Value to set for the tokenLifetimePolicies property.

Returns:

  • a void



891
892
893
 
# File 'lib/models/application.rb', line 891

def token_lifetime_policies=(value)
    @token_lifetime_policies = value
end

#verified_publisher ⇒ Object

Gets the verifiedPublisher property value. Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see Publisher verification.

Returns:

  • a verified_publisher



898
899
900
 
# File 'lib/models/application.rb', line 898

def verified_publisher
    return @verified_publisher
end

#verified_publisher=(value) ⇒ Object

Sets the verifiedPublisher property value. Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see Publisher verification.

Parameters:

  • value —

    Value to set for the verifiedPublisher property.

Returns:

  • a void



906
907
908
 
# File 'lib/models/application.rb', line 906

def verified_publisher=(value)
    @verified_publisher = value
end

#web ⇒ Object

Gets the web property value. Specifies settings for a web application.

Returns:

  • a web_application



913
914
915
 
# File 'lib/models/application.rb', line 913

def web
    return @web
end

#web=(value) ⇒ Object

Sets the web property value. Specifies settings for a web application.

Parameters:

  • value —

    Value to set for the web property.

Returns:

  • a void



921
922
923
 
# File 'lib/models/application.rb', line 921

def web=(value)
    @web = value
end