Role Types

• GrantRoleResult

  Defines the possible results of granting a role.

  A GrantRoleResult can be one of the following values:

  • GrantRoleSuccess
  • GrantRoleFailure

• GrantRoleSuccess

  Defines an interface that represents a successful request to grant a role.

  Members

  • success true

• GrantRoleFailure

  Defines an interface that represents a failed request to grant a role.

  Members

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

    The error code that indicates why the request failed.

  • errorMessage string

    The error message that indicates why the request failed.

  • success false

• RevokeRoleResult

  Defines the possible results of revoking a role.

  A RevokeRoleResult can be one of the following values:

  • RevokeRoleSuccess
  • RevokeRoleFailure

• RevokeRoleSuccess

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

  Members

  • success true

• RevokeRoleFailure

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

  Members

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

    The error code that indicates why the request failed.

  • errorMessage string

    The error message that indicates why the request failed.

  • success false