Package com.microsoft.graph.models

Class SignIn

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.SignIn
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
@Generated("com.microsoft.kiota") public class SignIn extends Entity implements com.microsoft.kiota.serialization.Parsable

  • Constructor Details

    • SignIn

      public SignIn()
      Instantiates a new SignIn and sets the default values.

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static SignIn createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a SignIn

    • getAppDisplayName

      @Nullable public String getAppDisplayName()
      Gets the appDisplayName property value. App name displayed in the Microsoft Entra admin center. Supports $filter (eq, startsWith).
      Returns:
      a String

    • getAppId

      @Nullable public String getAppId()
      Gets the appId property value. Unique GUID that represents the app ID in the Microsoft Entra ID. Supports $filter (eq).
      Returns:
      a String

    • getAppliedConditionalAccessPolicies

      @Nullable public List<AppliedConditionalAccessPolicy> getAppliedConditionalAccessPolicies()
      Gets the appliedConditionalAccessPolicies property value. Provides a list of conditional access policies that the corresponding sign-in activity triggers. Apps need more Conditional Access-related privileges to read the details of this property. For more information, see Permissions for viewing applied conditional access (CA) policies in sign-ins.
      Returns:
      a List<AppliedConditionalAccessPolicy>

    • getClientAppUsed

      @Nullable public String getClientAppUsed()
      Gets the clientAppUsed property value. Identifies the client used for the sign-in activity. Modern authentication clients include Browser, modern clients. Legacy authentication clients include Exchange ActiveSync, IMAP, MAPI, SMTP, POP, and other clients. Supports $filter (eq).
      Returns:
      a String

    • getConditionalAccessStatus

      @Nullable public ConditionalAccessStatus getConditionalAccessStatus()
      Gets the conditionalAccessStatus property value. Reports status of an activated conditional access policy. Possible values are: success, failure, notApplied, and unknownFutureValue. Supports $filter (eq).
      Returns:
      a ConditionalAccessStatus

    • getCorrelationId

      @Nullable public String getCorrelationId()
      Gets the correlationId property value. The request ID sent from the client when the sign-in is initiated. Used to troubleshoot sign-in activity. Supports $filter (eq).
      Returns:
      a String

    • getCreatedDateTime

      @Nullable public OffsetDateTime getCreatedDateTime()
      Gets the createdDateTime property value. Date and time (UTC) the sign-in was initiated. Example: midnight on Jan 1, 2014 is reported as 2014-01-01T00:00:00Z. Supports $orderby, $filter (eq, le, and ge).
      Returns:
      a OffsetDateTime

    • getDeviceDetail

      @Nullable public DeviceDetail getDeviceDetail()
      Gets the deviceDetail property value. Device information from where the sign-in occurred; includes device ID, operating system, and browser. Supports $filter (eq, startsWith) on browser and operatingSytem properties.
      Returns:
      a DeviceDetail

    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      getFieldDeserializers in class Entity
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>

    • getIpAddress

      @Nullable public String getIpAddress()
      Gets the ipAddress property value. IP address of the client used to sign in. Supports $filter (eq, startsWith).
      Returns:
      a String

    • getIsInteractive

      @Nullable public Boolean getIsInteractive()
      Gets the isInteractive property value. Indicates whether a sign-in is interactive.
      Returns:
      a Boolean

    • getLocation

      @Nullable public SignInLocation getLocation()
      Gets the location property value. Provides the city, state, and country code where the sign-in originated. Supports $filter (eq, startsWith) on city, state, and countryOrRegion properties.
      Returns:
      a SignInLocation

    • getResourceDisplayName

      @Nullable public String getResourceDisplayName()
      Gets the resourceDisplayName property value. Name of the resource the user signed into. Supports $filter (eq).
      Returns:
      a String

    • getResourceId

      @Nullable public String getResourceId()
      Gets the resourceId property value. ID of the resource that the user signed into. Supports $filter (eq).
      Returns:
      a String

    • getRiskDetail

      @Nullable public RiskDetail getRiskDetail()
      Gets the riskDetail property value. The reason behind a specific state of a risky user, sign-in, or a risk event. The possible values are none, adminGeneratedTemporaryPassword, userPerformedSecuredPasswordChange, userPerformedSecuredPasswordReset, adminConfirmedSigninSafe, aiConfirmedSigninSafe, userPassedMFADrivenByRiskBasedPolicy, adminDismissedAllRiskForUser, adminConfirmedSigninCompromised, hidden, adminConfirmedUserCompromised, unknownFutureValue, adminConfirmedServicePrincipalCompromised, adminDismissedAllRiskForServicePrincipal, m365DAdminDismissedDetection, userChangedPasswordOnPremises, adminDismissedRiskForSignIn, adminConfirmedAccountSafe. Use the Prefer: include-unknown-enum-members request header to get the following value or values in this evolvable enum: adminConfirmedServicePrincipalCompromised, adminDismissedAllRiskForServicePrincipal, m365DAdminDismissedDetection, userChangedPasswordOnPremises, adminDismissedRiskForSignIn, adminConfirmedAccountSafe.The value none means that Microsoft Entra risk detection did not flag the user or the sign-in as a risky event so far. Supports $filter (eq). Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden.
      Returns:
      a RiskDetail

    • getRiskEventTypes

      @Nullable public List<RiskEventType> getRiskEventTypes()
      Gets the riskEventTypes property value. The riskEventTypes property
      Returns:
      a List<RiskEventType>

    • getRiskEventTypesV2

      @Nullable public List<String> getRiskEventTypesV2()
      Gets the riskEventTypes_v2 property value. The list of risk event types associated with the sign-in. Possible values: unlikelyTravel, anonymizedIPAddress, maliciousIPAddress, unfamiliarFeatures, malwareInfectedIPAddress, suspiciousIPAddress, leakedCredentials, investigationsThreatIntelligence, generic, or unknownFutureValue. Supports $filter (eq, startsWith).
      Returns:
      a List<String>

    • getRiskLevelAggregated

      @Nullable public RiskLevel getRiskLevelAggregated()
      Gets the riskLevelAggregated property value. Aggregated risk level. The possible values are: none, low, medium, high, hidden, and unknownFutureValue. The value hidden means the user or sign-in wasn't enabled for Microsoft Entra ID Protection. Supports $filter (eq). Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden.
      Returns:
      a RiskLevel

    • getRiskLevelDuringSignIn

      @Nullable public RiskLevel getRiskLevelDuringSignIn()
      Gets the riskLevelDuringSignIn property value. Risk level during sign-in. The possible values are: none, low, medium, high, hidden, and unknownFutureValue. The value hidden means the user or sign-in wasn't enabled for Microsoft Entra ID Protection. Supports $filter (eq). Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden.
      Returns:
      a RiskLevel

    • getRiskState

      @Nullable public RiskState getRiskState()
      Gets the riskState property value. Reports status of the risky user, sign-in, or a risk event. The possible values are: none, confirmedSafe, remediated, dismissed, atRisk, confirmedCompromised, unknownFutureValue. Supports $filter (eq).
      Returns:
      a RiskState

    • getStatus

      @Nullable public SignInStatus getStatus()
      Gets the status property value. Sign-in status. Includes the error code and description of the error (if a sign-in failure occurs). Supports $filter (eq) on errorCode property.
      Returns:
      a SignInStatus

    • getUserDisplayName

      @Nullable public String getUserDisplayName()
      Gets the userDisplayName property value. Display name of the user that initiated the sign-in. Supports $filter (eq, startsWith).
      Returns:
      a String

    • getUserId

      @Nullable public String getUserId()
      Gets the userId property value. ID of the user that initiated the sign-in. Supports $filter (eq).
      Returns:
      a String

    • getUserPrincipalName

      @Nullable public String getUserPrincipalName()
      Gets the userPrincipalName property value. User principal name of the user that initiated the sign-in. This value is always in lowercase. For guest users whose values in the user object typically contain #EXT# before the domain part, this property stores the value in both lowercase and the 'true' format. For example, while the user object stores AdeleVance_fabrikam.com#EXT#@contoso.com, the sign-in logs store adelevance@fabrikam.com. Supports $filter (eq, startsWith).
      Returns:
      a String

    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      serialize in class Entity
      Parameters:
      writer - Serialization writer to use to serialize this model

    • setAppDisplayName

      public void setAppDisplayName(@Nullable String value)
      Sets the appDisplayName property value. App name displayed in the Microsoft Entra admin center. Supports $filter (eq, startsWith).
      Parameters:
      value - Value to set for the appDisplayName property.

    • setAppId

      public void setAppId(@Nullable String value)
      Sets the appId property value. Unique GUID that represents the app ID in the Microsoft Entra ID. Supports $filter (eq).
      Parameters:
      value - Value to set for the appId property.

    • setAppliedConditionalAccessPolicies

      public void setAppliedConditionalAccessPolicies(@Nullable List<AppliedConditionalAccessPolicy> value)
      Sets the appliedConditionalAccessPolicies property value. Provides a list of conditional access policies that the corresponding sign-in activity triggers. Apps need more Conditional Access-related privileges to read the details of this property. For more information, see Permissions for viewing applied conditional access (CA) policies in sign-ins.
      Parameters:
      value - Value to set for the appliedConditionalAccessPolicies property.

    • setClientAppUsed

      public void setClientAppUsed(@Nullable String value)
      Sets the clientAppUsed property value. Identifies the client used for the sign-in activity. Modern authentication clients include Browser, modern clients. Legacy authentication clients include Exchange ActiveSync, IMAP, MAPI, SMTP, POP, and other clients. Supports $filter (eq).
      Parameters:
      value - Value to set for the clientAppUsed property.

    • setConditionalAccessStatus

      public void setConditionalAccessStatus(@Nullable ConditionalAccessStatus value)
      Sets the conditionalAccessStatus property value. Reports status of an activated conditional access policy. Possible values are: success, failure, notApplied, and unknownFutureValue. Supports $filter (eq).
      Parameters:
      value - Value to set for the conditionalAccessStatus property.

    • setCorrelationId

      public void setCorrelationId(@Nullable String value)
      Sets the correlationId property value. The request ID sent from the client when the sign-in is initiated. Used to troubleshoot sign-in activity. Supports $filter (eq).
      Parameters:
      value - Value to set for the correlationId property.

    • setCreatedDateTime

      public void setCreatedDateTime(@Nullable OffsetDateTime value)
      Sets the createdDateTime property value. Date and time (UTC) the sign-in was initiated. Example: midnight on Jan 1, 2014 is reported as 2014-01-01T00:00:00Z. Supports $orderby, $filter (eq, le, and ge).
      Parameters:
      value - Value to set for the createdDateTime property.

    • setDeviceDetail

      public void setDeviceDetail(@Nullable DeviceDetail value)
      Sets the deviceDetail property value. Device information from where the sign-in occurred; includes device ID, operating system, and browser. Supports $filter (eq, startsWith) on browser and operatingSytem properties.
      Parameters:
      value - Value to set for the deviceDetail property.

    • setIpAddress

      public void setIpAddress(@Nullable String value)
      Sets the ipAddress property value. IP address of the client used to sign in. Supports $filter (eq, startsWith).
      Parameters:
      value - Value to set for the ipAddress property.

    • setIsInteractive

      public void setIsInteractive(@Nullable Boolean value)
      Sets the isInteractive property value. Indicates whether a sign-in is interactive.
      Parameters:
      value - Value to set for the isInteractive property.

    • setLocation

      public void setLocation(@Nullable SignInLocation value)
      Sets the location property value. Provides the city, state, and country code where the sign-in originated. Supports $filter (eq, startsWith) on city, state, and countryOrRegion properties.
      Parameters:
      value - Value to set for the location property.

    • setResourceDisplayName

      public void setResourceDisplayName(@Nullable String value)
      Sets the resourceDisplayName property value. Name of the resource the user signed into. Supports $filter (eq).
      Parameters:
      value - Value to set for the resourceDisplayName property.

    • setResourceId

      public void setResourceId(@Nullable String value)
      Sets the resourceId property value. ID of the resource that the user signed into. Supports $filter (eq).
      Parameters:
      value - Value to set for the resourceId property.

    • setRiskDetail

      public void setRiskDetail(@Nullable RiskDetail value)
      Sets the riskDetail property value. The reason behind a specific state of a risky user, sign-in, or a risk event. The possible values are none, adminGeneratedTemporaryPassword, userPerformedSecuredPasswordChange, userPerformedSecuredPasswordReset, adminConfirmedSigninSafe, aiConfirmedSigninSafe, userPassedMFADrivenByRiskBasedPolicy, adminDismissedAllRiskForUser, adminConfirmedSigninCompromised, hidden, adminConfirmedUserCompromised, unknownFutureValue, adminConfirmedServicePrincipalCompromised, adminDismissedAllRiskForServicePrincipal, m365DAdminDismissedDetection, userChangedPasswordOnPremises, adminDismissedRiskForSignIn, adminConfirmedAccountSafe. Use the Prefer: include-unknown-enum-members request header to get the following value or values in this evolvable enum: adminConfirmedServicePrincipalCompromised, adminDismissedAllRiskForServicePrincipal, m365DAdminDismissedDetection, userChangedPasswordOnPremises, adminDismissedRiskForSignIn, adminConfirmedAccountSafe.The value none means that Microsoft Entra risk detection did not flag the user or the sign-in as a risky event so far. Supports $filter (eq). Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden.
      Parameters:
      value - Value to set for the riskDetail property.

    • setRiskEventTypes

      public void setRiskEventTypes(@Nullable List<RiskEventType> value)
      Sets the riskEventTypes property value. The riskEventTypes property
      Parameters:
      value - Value to set for the riskEventTypes property.

    • setRiskEventTypesV2

      public void setRiskEventTypesV2(@Nullable List<String> value)
      Sets the riskEventTypes_v2 property value. The list of risk event types associated with the sign-in. Possible values: unlikelyTravel, anonymizedIPAddress, maliciousIPAddress, unfamiliarFeatures, malwareInfectedIPAddress, suspiciousIPAddress, leakedCredentials, investigationsThreatIntelligence, generic, or unknownFutureValue. Supports $filter (eq, startsWith).
      Parameters:
      value - Value to set for the riskEventTypes_v2 property.

    • setRiskLevelAggregated

      public void setRiskLevelAggregated(@Nullable RiskLevel value)
      Sets the riskLevelAggregated property value. Aggregated risk level. The possible values are: none, low, medium, high, hidden, and unknownFutureValue. The value hidden means the user or sign-in wasn't enabled for Microsoft Entra ID Protection. Supports $filter (eq). Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden.
      Parameters:
      value - Value to set for the riskLevelAggregated property.

    • setRiskLevelDuringSignIn

      public void setRiskLevelDuringSignIn(@Nullable RiskLevel value)
      Sets the riskLevelDuringSignIn property value. Risk level during sign-in. The possible values are: none, low, medium, high, hidden, and unknownFutureValue. The value hidden means the user or sign-in wasn't enabled for Microsoft Entra ID Protection. Supports $filter (eq). Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden.
      Parameters:
      value - Value to set for the riskLevelDuringSignIn property.

    • setRiskState

      public void setRiskState(@Nullable RiskState value)
      Sets the riskState property value. Reports status of the risky user, sign-in, or a risk event. The possible values are: none, confirmedSafe, remediated, dismissed, atRisk, confirmedCompromised, unknownFutureValue. Supports $filter (eq).
      Parameters:
      value - Value to set for the riskState property.

    • setStatus

      public void setStatus(@Nullable SignInStatus value)
      Sets the status property value. Sign-in status. Includes the error code and description of the error (if a sign-in failure occurs). Supports $filter (eq) on errorCode property.
      Parameters:
      value - Value to set for the status property.

    • setUserDisplayName

      public void setUserDisplayName(@Nullable String value)
      Sets the userDisplayName property value. Display name of the user that initiated the sign-in. Supports $filter (eq, startsWith).
      Parameters:
      value - Value to set for the userDisplayName property.

    • setUserId

      public void setUserId(@Nullable String value)
      Sets the userId property value. ID of the user that initiated the sign-in. Supports $filter (eq).
      Parameters:
      value - Value to set for the userId property.

    • setUserPrincipalName

      public void setUserPrincipalName(@Nullable String value)
      Sets the userPrincipalName property value. User principal name of the user that initiated the sign-in. This value is always in lowercase. For guest users whose values in the user object typically contain #EXT# before the domain part, this property stores the value in both lowercase and the 'true' format. For example, while the user object stores AdeleVance_fabrikam.com#EXT#@contoso.com, the sign-in logs store adelevance@fabrikam.com. Supports $filter (eq, startsWith).
      Parameters:
      value - Value to set for the userPrincipalName property.