OpenFga::CheckRequest

February 16, 2026 ยท View on GitHub

Properties

NameTypeDescriptionNotes
tuple_keyCheckRequestTupleKey
contextual_tuplesContextualTupleKeys[optional]
authorization_model_idString[optional]
traceBooleanDefaults to false. Making it true has performance implications.[optional][readonly]
contextObjectAdditional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation.[optional]
consistencyConsistencyPreference[optional][default to 'UNSPECIFIED']

Example

require 'openfga'

instance = OpenFga::CheckRequest.new(
  tuple_key: null,
  contextual_tuples: null,
  authorization_model_id: 01G5JAVJ41T49E9TT3SKVS7X1J,
  trace: false,
  context: null,
  consistency: null
)