CreateProjectInput

Input object for creating a project

input CreateProjectInput {
  connectivity: String
  endDate: ISO8601Date
  estimatedHours: String
  goal: String!
  label: String!
  scope: String!
  startDate: ISO8601Date!
  students: Int
  companyId: Int!
  typeId: Int!
  accessPortalUserEmails: [String!]
  assigneeEmails: [String!]
  assigneeTeamIds: [Int!]
  assetsIds: [Int!]
  attachments: [AttachmentInput!]
  credentialsIds: [Int!]
  playbooksIds: [Int!]
  projectScopeUrls: [String!]
  tags: [String!]
  teamsIds: [Int!]
  secretIds: [String!]
  attackChain: String
  penetrationTestingApproach: PenetrationTestingApproachEnum
  artifactId: ID
  clientMutationId: String
}

Fields

CreateProjectInput.connectivity ● String scalar

Optional connectivity details, e.g. network or integration requirements.

CreateProjectInput.endDate ● ISO8601Date scalar

Optional end date for the project.

CreateProjectInput.estimatedHours ● String scalar

Optional estimated hours required to complete the project.

CreateProjectInput.goal ● String! non-null scalar

The main objective or goal of the project.

CreateProjectInput.label ● String! non-null scalar

A short label or title for the project.

CreateProjectInput.scope ● String! non-null scalar

The scope of the project, defining its boundaries and focus.

CreateProjectInput.startDate ● ISO8601Date! non-null scalar

The start date of the project.

CreateProjectInput.students ● Int scalar

Optional number of students involved in the project.

CreateProjectInput.companyId ● Int! non-null scalar

The ID of the company associated with the project.

CreateProjectInput.typeId ● Int! non-null scalar

The ID representing the type of the project.

CreateProjectInput.accessPortalUserEmails ● [String!] list scalar

List of portal user emails that have access to the project. Each must be someone of its company the caller can list, as with the assignee emails, and never a service account: any other email is refused. Someone with no profile of their own in the company is refused (DIRECT_ACCESS_WITHOUT_PROFILE): only that profile judges a direct access.

CreateProjectInput.assigneeEmails ● [String!] list scalar

List of portal user emails assigned to work on the project.

CreateProjectInput.assigneeTeamIds ● [Int!] list scalar

List of team IDs assigned to work on the project.

CreateProjectInput.assetsIds ● [Int!] list scalar

Array of asset IDs associated with the project.

CreateProjectInput.attachments ● [AttachmentInput!] list input

List of attachments for the project.

CreateProjectInput.credentialsIds ● [Int!] list scalar

Array of credential IDs used for accessing project resources.

CreateProjectInput.playbooksIds ● [Int!] list scalar

List of playbook IDs that provide guidelines for the project.

CreateProjectInput.projectScopeUrls ● [String!] list scalar

List of URLs that detail the project scope.

CreateProjectInput.tags ● [String!] list scalar

Array of tags for categorizing or filtering the project.

CreateProjectInput.teamsIds ● [Int!] list scalar

List of team IDs associated with the project.

CreateProjectInput.secretIds ● [String!] list scalar

List of secrets associated with the project.

CreateProjectInput.attackChain ● String scalar

Mermaid diagram syntax for attack chain visualization.

CreateProjectInput.penetrationTestingApproach ● PenetrationTestingApproachEnum enum

Testing approach for penetration testing projects.

CreateProjectInput.artifactId ● ID scalar

Optional threat model artifact this project is created from; its source file is copied onto the project as an attachment.

CreateProjectInput.clientMutationId ● String scalar

A unique identifier for the client performing the mutation.

Member Of

createAnalysis mutation ● createProject mutation