Class IsAuthorizedResponse

    • Method Detail

      • decision

        public final Decision decision()

        An authorization decision that indicates if the authorization request should be allowed or denied.

        If the service returns an enum value that is not available in the current SDK version, decision will return Decision.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from decisionAsString().

        Returns:
        An authorization decision that indicates if the authorization request should be allowed or denied.
        See Also:
        Decision
      • decisionAsString

        public final String decisionAsString()

        An authorization decision that indicates if the authorization request should be allowed or denied.

        If the service returns an enum value that is not available in the current SDK version, decision will return Decision.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from decisionAsString().

        Returns:
        An authorization decision that indicates if the authorization request should be allowed or denied.
        See Also:
        Decision
      • hasDeterminingPolicies

        public final boolean hasDeterminingPolicies()
        For responses, this returns true if the service returned a value for the DeterminingPolicies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • determiningPolicies

        public final List<DeterminingPolicyItem> determiningPolicies()

        The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDeterminingPolicies() method.

        Returns:
        The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.
      • hasErrors

        public final boolean hasErrors()
        For responses, this returns true if the service returned a value for the Errors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • errors

        public final List<EvaluationErrorItem> errors()

        Errors that occurred while making an authorization decision, for example, a policy references an Entity or entity Attribute that does not exist in the slice.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrors() method.

        Returns:
        Errors that occurred while making an authorization decision, for example, a policy references an Entity or entity Attribute that does not exist in the slice.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object