Skip to main content
Version: Current

Policy Types

  • GrantMarkerPermissionResult

    Defines the possible results of granting a permission to a marker.

    A GrantMarkerPermissionResult can be one of the following values:

  • GrantMarkerPermissionSuccess

    Defines an interface that represents a successful request to grant a marker permission to a policy.

    Members

    • success true

  • GrantResourcePermissionSuccess

    Defines an interface that represents a successful request to grant a permission to a resource.

    Members

    • success true

  • GrantMarkerPermissionFailure

    Defines an interface that represents a failed request to grant a marker permission to a policy.

    Members

    • errorCode ("server_error" | "invalid_record_key" | "unacceptable_request" | "record_not_found" | "not_authorized" | "action_not_supported" | "not_logged_in" | "subscription_limit_reached" | "permission_already_exists")

      The error code that indicates why the request failed.

    • errorMessage string

      The error message that indicates why the request failed.

    • success false

  • GrantResourcePermissionFailure

    Defines an interface that represents a failed request to grant a permission to a resource.

    Members

    • errorCode ("server_error" | "invalid_record_key" | "unacceptable_request" | "record_not_found" | "not_authorized" | "action_not_supported" | "not_logged_in" | "subscription_limit_reached" | "permission_already_exists")

      The error code that indicates why the request failed.

    • errorMessage string

      The error message that indicates why the request failed.

    • success false

  • RevokeMarkerPermissionResult

    Defines the possible results of revoking a permission from a marker.

    A RevokeMarkerPermissionResult can be one of the following values:

  • RevokeResourcePermissionResult

    Defines the possible results of revoking a resource permission.

    A RevokeResourcePermissionResult can be one of the following values:

  • RevokeMarkerPermissionSuccess

    Defines an interface that represents a successful request to revoke a permission from a marker.

    Members

    • success true

  • RevokePermissionSuccess

    Defines an interface that represents a successful request to revoke a permission.

    Members

    • success true

  • RevokeResourcePermissionSuccess

    Defines an interface that represents a successful request to revoke a permission from a resource.

    Members

    • success true

  • RevokeMarkerPermissionFailure

    Defines an interface that represents a failed request to revoke a permission from a marker.

    Members

    • errorCode ("server_error" | "invalid_record_key" | "unacceptable_request" | "record_not_found" | "not_authorized" | "action_not_supported" | "not_logged_in" | "subscription_limit_reached" | "permission_not_found")

      The error code that indicates why the request failed.

    • errorMessage string

      The error message that indicates why the request failed.

    • success false

  • RevokePermissionFailure

    Defines an interface that represents a failed request to revoke a permission.

    Members

    • errorCode ("server_error" | "invalid_record_key" | "unacceptable_request" | "record_not_found" | "not_authorized" | "action_not_supported" | "not_logged_in" | "subscription_limit_reached" | "permission_not_found")

      The error code that indicates why the request failed.

    • errorMessage string

      The error message that indicates why the request failed.

    • success false

  • RevokeResourcePermissionFailure

    Defines an interface that represents a failed request to revoke a permission from a resource.

    Members

    • errorCode ("server_error" | "invalid_record_key" | "unacceptable_request" | "record_not_found" | "not_authorized" | "action_not_supported" | "not_logged_in" | "subscription_limit_reached" | "permission_not_found")

      The error code that indicates why the request failed.

    • errorMessage string

      The error message that indicates why the request failed.

    • success false

  • GrantResourcePermissionResult

    Defines the possible results of granting a permission to a resource.

    A GrantResourcePermissionResult can be one of the following values: