GraphQL Schema Reference
String ¶
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
GraphQL Schema definition ¶
- scalar String
Require by ¶
- AddAttackLogToTestCaseInput
- AddAttackLogToTestCaseOptions
- Assessment
- AttackAutomationInput
- AttackAutomationVariable
- AttackLog
- AttackLogEntry
- AttackLogProcedure
- AutomationArgument
- BlueTool
- Campaign
- ClDefenseTool
- CloneTestCaseTemplateInput
- CreateAssessmentDataInput
- CreateAssessmentInput
- CreateAssessmentTemplateDataInput
- CreateAttackLogEntryInput
- CreateAttackLogProcedureInput
- CreateCampaignDataInput
- CreateCampaignInput
- CreateCampaignTemplateDataInput
- CreateFavoriteTagInput
- CreateFavoriteTagPayload
- CreateOutcomeDataInput
- CreateSourceDataInput
- CreateSourceInput
- CreateTagInput
- CreateTargetDataInput
- CreateTargetInput
- CreateTestCaseAndTemplateMatchByNameInput
- CreateTestCaseDataInput
- CreateTestCaseDataWithTemplateNameInput
- CreateTestCaseTemplateDataInput
- CreateTestCaseWithoutTemplateInput
- Database
- DefenseToolInput
- DefenseToolProduct
- DefensiveLayer
- DeleteAssessmentInput
- DeleteAssessmentPayload
- DeleteAssessmentTemplateInput
- DeleteAssessmentTemplatePayload
- DeleteCampaignInput
- DeleteCampaignPayload
- DeleteCampaignTemplateInput
- DeleteCampaignTemplatePayload
- DeleteFavoriteTagInput
- DeleteFavoriteTagPayload
- DeleteTestCaseInput
- DeleteTestCasePayload
- DeleteTestCaseTemplateInput
- DeleteTestCaseTemplatePayload
- DeleteUploadedSSLConfigPayload
- ExecutionArtifact
- ExecutionArtifactIdInfo
- ExecutionArtifactIdInfoInput
- FavoriteTag
- FavoriteTagIds
- KillChain
- MetadataFilter
- MetadataKeyValuePair
- MetadataKeyValuePairInput
- MetadataSummaryItem
- MitreTactic
- Organization
- Outcome
- PageInfoInformation about pagination in a connection
- Phase
- PrimeDefaultFavoriteTagsForUserInput
- PrimeDefaultFavoriteTagsForUserPayload
- Query
- RedTool
- RedToolInput
- ReportingBucket
- Source
- StringOperator
- Tag
- TagType
- Target
- TemplateNamePrefixInput
- TestCase
- TimelineEvent
- UnstructuredLog
- UpdateAssessmentDataInput
- UpdateAssessmentTemplateDataInput
- UpdateOutcomeDataInputNote that this update method doesn't support nullability
- UpdateTestCaseDataInput
- UpdateTestCaseInput
- UpdateTestCaseTemplateDataInput
- VectrAppConfig
- VectrSSLConfig
- VectrSSLConfigInput
- VectrSSLConfigPayload
- Vendor
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.