Record Key Types

• CreatePublicRecordKeyResult

  Defines an interface that represents the result of a "create public record key" operation.

  A CreatePublicRecordKeyResult can be one of the following values:

  • CreatePublicRecordKeySuccess
  • CreatePublicRecordKeyFailure

• CreatePublicRecordKeySuccess

  Defines an interface that represents a successful "create public record key" result.

  Members

  • recordKey string

    The key that was created.

  • recordName string

    The name of the record the key was created for.

  • success true

    Whether the operation was successful.

• CreatePublicRecordKeyFailure

  Defines an interface that represents a failed "create public record key" result.

  Members

  • errorCode ("server_error" | "not_supported" | "session_expired" | "user_is_banned" | "unacceptable_request" | "not_authorized" | "not_logged_in" | "subscription_limit_reached" | "invalid_key" | "unacceptable_session_key" | "unauthorized_to_create_record_key" | "record_already_exists" | "invalid_policy")

    The type of error that occurred.

  • errorMessage string

    The error message.

  • errorReason? ("server_error" | "not_supported" | "not_authorized" | "not_logged_in" | "invalid_policy" | "user_denied" | "record_owned_by_different_user")

    The unique reason as to why the error occurred.

  • success false

    Whether the operation was successful.

• PublicRecordKeyPolicy

  Defines a type that represents the different kinds of policies that a record key can have.

  • null and "subjectfull" indicate that actions performed with this key must require a subject to provide their access token in order for operations to succeed.
  • "subjectless" indicates that actions may be performed with key despite not having an access key from a subject.

  A PublicRecordKeyPolicy can be one of the following values:

  • null
  • "subjectfull"
  • "subjectless"