object ServiceAccountsGetOrganizationAccountByIdResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "type": "string"
        },
        "links": {
          "type": "object",
          "properties": {
            "last": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "next": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "prev": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "self": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "first": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "related": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            }
          }
        },
        "attributes": {
          "type": "object",
          "required": [
            "name",
            "auth_type",
            "role_id"
          ],
          "properties": {
            "name": {
              "type": "string",
              "description": "A human-friendly name of the service account."
            },
            "level": {
              "enum": [
                "Group",
                "Org"
              ],
              "type": "string",
              "description": "The level of access for the service account:\n  * Group - the service account was created at the Group level.\n  * Org - the service account was created at the Org level."
            },
            "api_key": {
              "type": "string",
              "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
            },
            "role_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the role which the Service Account is associated with."
            },
            "jwks_url": {
              "type": "string",
              "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
            },
            "auth_type": {
              "enum": [
                "api_key",
                "oauth_client_secret",
                "oauth_private_key_jwt"
              ],
              "type": "string",
              "description": "The authentication strategy for the service account:\n  * api_key - Regular Snyk API Key.\n  * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n  * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
            },
            "client_id": {
              "type": "string",
              "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
            },
            "client_secret": {
              "type": "string",
              "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
            },
            "access_token_ttl_seconds": {
              "type": "number",
              "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object ServiceAccountsListGroupServiceAccountsResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id",
          "attributes"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string"
          },
          "links": {
            "type": "object",
            "properties": {
              "last": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "next": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "prev": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "self": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "first": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "related": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              }
            }
          },
          "attributes": {
            "type": "object",
            "required": [
              "name",
              "auth_type",
              "role_id"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "A human-friendly name of the service account."
              },
              "level": {
                "enum": [
                  "Group",
                  "Org"
                ],
                "type": "string",
                "description": "The level of access for the service account:\n  * Group - the service account was created at the Group level.\n  * Org - the service account was created at the Org level."
              },
              "api_key": {
                "type": "string",
                "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
              },
              "role_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the role which the Service Account is associated with."
              },
              "jwks_url": {
                "type": "string",
                "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
              },
              "auth_type": {
                "enum": [
                  "api_key",
                  "oauth_client_secret",
                  "oauth_private_key_jwt"
                ],
                "type": "string",
                "description": "The authentication strategy for the service account:\n  * api_key - Regular Snyk API Key.\n  * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n  * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
              },
              "client_id": {
                "type": "string",
                "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
              },
              "client_secret": {
                "type": "string",
                "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
              },
              "access_token_ttl_seconds": {
                "type": "number",
                "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
              }
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object ServiceAccountsListOrganizationServiceAccountsResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "id",
          "attributes"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "type": "string"
          },
          "links": {
            "type": "object",
            "properties": {
              "last": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "next": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "prev": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "self": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "first": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              },
              "related": {
                "oneOf": [
                  {
                    "type": "string",
                    "example": "https://example.com/api/resource",
                    "description": "A string containing the link’s URL."
                  },
                  {
                    "type": "object",
                    "example": {
                      "href": "https://example.com/api/resource"
                    },
                    "required": [
                      "href"
                    ],
                    "properties": {
                      "href": {
                        "type": "string",
                        "example": "https://example.com/api/resource",
                        "description": "A string containing the link’s URL."
                      },
                      "meta": {
                        "type": "object",
                        "example": {
                          "key1": "value1",
                          "key2": {
                            "sub_key": "sub_value"
                          },
                          "key3": [
                            "array_value1",
                            "array_value2"
                          ]
                        },
                        "description": "Free-form object that may contain non-standard information.",
                        "additionalProperties": true
                      }
                    }
                  }
                ],
                "example": "https://example.com/api/resource"
              }
            }
          },
          "attributes": {
            "type": "object",
            "required": [
              "name",
              "auth_type",
              "role_id"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "A human-friendly name of the service account."
              },
              "level": {
                "enum": [
                  "Group",
                  "Org"
                ],
                "type": "string",
                "description": "The level of access for the service account:\n  * Group - the service account was created at the Group level.\n  * Org - the service account was created at the Org level."
              },
              "api_key": {
                "type": "string",
                "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
              },
              "role_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the role which the Service Account is associated with."
              },
              "jwks_url": {
                "type": "string",
                "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
              },
              "auth_type": {
                "enum": [
                  "api_key",
                  "oauth_client_secret",
                  "oauth_private_key_jwt"
                ],
                "type": "string",
                "description": "The authentication strategy for the service account:\n  * api_key - Regular Snyk API Key.\n  * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n  * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
              },
              "client_id": {
                "type": "string",
                "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
              },
              "client_secret": {
                "type": "string",
                "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
              },
              "access_token_ttl_seconds": {
                "type": "number",
                "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
              }
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object ServiceAccountsManageClientSecretForOrganizationServiceAccountRequest
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "attributes",
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            "service_account"
          ],
          "type": "string",
          "description": "The Resource type."
        },
        "attributes": {
          "type": "object",
          "required": [
            "mode"
          ],
          "properties": {
            "mode": {
              "enum": [
                "replace",
                "create",
                "delete"
              ],
              "type": "string",
              "description": "Operation to perform:\n  * `replace` - Replace existing secrets with a new generated secret.\n  * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n  * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n"
            },
            "secret": {
              "type": "string",
              "description": "Secret to delete when using `delete` mode"
            }
          }
        }
      }
    }
  }
}
object ServiceAccountsManageClientSecretForOrganizationServiceAccountResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "type": "string"
        },
        "links": {
          "type": "object",
          "properties": {
            "last": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "next": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "prev": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "self": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "first": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "related": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            }
          }
        },
        "attributes": {
          "type": "object",
          "required": [
            "name",
            "auth_type",
            "role_id"
          ],
          "properties": {
            "name": {
              "type": "string",
              "description": "A human-friendly name of the service account."
            },
            "level": {
              "enum": [
                "Group",
                "Org"
              ],
              "type": "string",
              "description": "The level of access for the service account:\n  * Group - the service account was created at the Group level.\n  * Org - the service account was created at the Org level."
            },
            "api_key": {
              "type": "string",
              "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
            },
            "role_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the role which the Service Account is associated with."
            },
            "jwks_url": {
              "type": "string",
              "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
            },
            "auth_type": {
              "enum": [
                "api_key",
                "oauth_client_secret",
                "oauth_private_key_jwt"
              ],
              "type": "string",
              "description": "The authentication strategy for the service account:\n  * api_key - Regular Snyk API Key.\n  * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n  * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
            },
            "client_id": {
              "type": "string",
              "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
            },
            "client_secret": {
              "type": "string",
              "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
            },
            "access_token_ttl_seconds": {
              "type": "number",
              "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object ServiceAccountsManageClientSecretRequest
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "attributes",
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            "service_account"
          ],
          "type": "string",
          "description": "The Resource type."
        },
        "attributes": {
          "type": "object",
          "required": [
            "mode"
          ],
          "properties": {
            "mode": {
              "enum": [
                "replace",
                "create",
                "delete"
              ],
              "type": "string",
              "description": "Operation to perform:\n  * `replace` - Replace existing secrets with a new generated secret.\n  * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n  * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n"
            },
            "secret": {
              "type": "string",
              "description": "Secret to delete when using `delete` mode"
            }
          }
        }
      }
    }
  }
}
object ServiceAccountsManageClientSecretResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "type": "string"
        },
        "links": {
          "type": "object",
          "properties": {
            "last": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "next": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "prev": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "self": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "first": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "related": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            }
          }
        },
        "attributes": {
          "type": "object",
          "required": [
            "name",
            "auth_type",
            "role_id"
          ],
          "properties": {
            "name": {
              "type": "string",
              "description": "A human-friendly name of the service account."
            },
            "level": {
              "enum": [
                "Group",
                "Org"
              ],
              "type": "string",
              "description": "The level of access for the service account:\n  * Group - the service account was created at the Group level.\n  * Org - the service account was created at the Org level."
            },
            "api_key": {
              "type": "string",
              "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
            },
            "role_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the role which the Service Account is associated with."
            },
            "jwks_url": {
              "type": "string",
              "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
            },
            "auth_type": {
              "enum": [
                "api_key",
                "oauth_client_secret",
                "oauth_private_key_jwt"
              ],
              "type": "string",
              "description": "The authentication strategy for the service account:\n  * api_key - Regular Snyk API Key.\n  * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n  * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
            },
            "client_id": {
              "type": "string",
              "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
            },
            "client_secret": {
              "type": "string",
              "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
            },
            "access_token_ttl_seconds": {
              "type": "number",
              "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object ServiceAccountsUpdateGroupNameByIdRequest
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the service account. Must match the id in the url path."
        },
        "type": {
          "enum": [
            "service_account"
          ],
          "type": "string",
          "description": "The Resource type."
        },
        "attributes": {
          "type": "object",
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "description": "A human-friendly name for the service account. Must be unique within the group."
            }
          }
        }
      }
    }
  }
}
object ServiceAccountsUpdateGroupNameByIdResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "type": "string"
        },
        "links": {
          "type": "object",
          "properties": {
            "last": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "next": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "prev": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "self": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "first": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "related": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            }
          }
        },
        "attributes": {
          "type": "object",
          "required": [
            "name",
            "auth_type",
            "role_id"
          ],
          "properties": {
            "name": {
              "type": "string",
              "description": "A human-friendly name of the service account."
            },
            "level": {
              "enum": [
                "Group",
                "Org"
              ],
              "type": "string",
              "description": "The level of access for the service account:\n  * Group - the service account was created at the Group level.\n  * Org - the service account was created at the Org level."
            },
            "api_key": {
              "type": "string",
              "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
            },
            "role_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the role which the Service Account is associated with."
            },
            "jwks_url": {
              "type": "string",
              "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
            },
            "auth_type": {
              "enum": [
                "api_key",
                "oauth_client_secret",
                "oauth_private_key_jwt"
              ],
              "type": "string",
              "description": "The authentication strategy for the service account:\n  * api_key - Regular Snyk API Key.\n  * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n  * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
            },
            "client_id": {
              "type": "string",
              "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
            },
            "client_secret": {
              "type": "string",
              "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
            },
            "access_token_ttl_seconds": {
              "type": "number",
              "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object ServiceAccountsUpdateOrganizationServiceAccountNameRequest
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the service account. Must match the id in the url path."
        },
        "type": {
          "enum": [
            "service_account"
          ],
          "type": "string",
          "description": "The Resource type."
        },
        "attributes": {
          "type": "object",
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "description": "A human-friendly name for the service account. Must be unique within the organization."
            }
          }
        }
      }
    }
  }
}
object ServiceAccountsUpdateOrganizationServiceAccountNameResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "id",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "type": "string"
        },
        "links": {
          "type": "object",
          "properties": {
            "last": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "next": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "prev": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "self": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "first": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            },
            "related": {
              "oneOf": [
                {
                  "type": "string",
                  "example": "https://example.com/api/resource",
                  "description": "A string containing the link’s URL."
                },
                {
                  "type": "object",
                  "example": {
                    "href": "https://example.com/api/resource"
                  },
                  "required": [
                    "href"
                  ],
                  "properties": {
                    "href": {
                      "type": "string",
                      "example": "https://example.com/api/resource",
                      "description": "A string containing the link’s URL."
                    },
                    "meta": {
                      "type": "object",
                      "example": {
                        "key1": "value1",
                        "key2": {
                          "sub_key": "sub_value"
                        },
                        "key3": [
                          "array_value1",
                          "array_value2"
                        ]
                      },
                      "description": "Free-form object that may contain non-standard information.",
                      "additionalProperties": true
                    }
                  }
                }
              ],
              "example": "https://example.com/api/resource"
            }
          }
        },
        "attributes": {
          "type": "object",
          "required": [
            "name",
            "auth_type",
            "role_id"
          ],
          "properties": {
            "name": {
              "type": "string",
              "description": "A human-friendly name of the service account."
            },
            "level": {
              "enum": [
                "Group",
                "Org"
              ],
              "type": "string",
              "description": "The level of access for the service account:\n  * Group - the service account was created at the Group level.\n  * Org - the service account was created at the Org level."
            },
            "api_key": {
              "type": "string",
              "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key."
            },
            "role_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the role which the Service Account is associated with."
            },
            "jwks_url": {
              "type": "string",
              "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt."
            },
            "auth_type": {
              "enum": [
                "api_key",
                "oauth_client_secret",
                "oauth_private_key_jwt"
              ],
              "type": "string",
              "description": "The authentication strategy for the service account:\n  * api_key - Regular Snyk API Key.\n  * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n  * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9."
            },
            "client_id": {
              "type": "string",
              "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt."
            },
            "client_secret": {
              "type": "string",
              "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret."
            },
            "access_token_ttl_seconds": {
              "type": "number",
              "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt."
            }
          }
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object SessionAttributes
{
  "type": "object",
  "required": [
    "created_at"
  ],
  "properties": {
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}
object SessionData
{
  "type": "object",
  "required": [
    "type",
    "id",
    "attributes"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "type": {
      "$ref": "#/components/schemas/Type"
    },
    "attributes": {
      "$ref": "#/components/schemas/SessionAttributes"
    }
  }
}
object SettingsAttributes
{
  "type": "object",
  "required": [
    "target_channel_id",
    "severity_threshold"
  ],
  "properties": {
    "target_channel_id": {
      "$ref": "#/components/schemas/TargetChannelId"
    },
    "severity_threshold": {
      "$ref": "#/components/schemas/SeverityThreshold"
    }
  }
}
object SettingsRequest
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "attributes"
      ],
      "properties": {
        "type": {
          "enum": [
            "slack"
          ],
          "type": "string"
        },
        "attributes": {
          "$ref": "#/components/schemas/SettingsAttributes"
        }
      }
    }
  }
}
object Severity
{
  "type": "object",
  "properties": {
    "level": {
      "type": "string",
      "example": "medium"
    },
    "score": {
      "type": "number",
      "example": 5.3,
      "nullable": true,
      "description": "The CVSSv3 value of the vulnerability."
    },
    "source": {
      "type": "string",
      "example": "Snyk",
      "description": "The source of this severity. The value must be the id of a referenced problem or class, in which case that problem or class is the source of this issue. If source is omitted, this severity is sourced internally in the Snyk application."
    },
    "vector": {
      "type": "string",
      "example": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:L",
      "nullable": true,
      "description": "The CVSSv3 value of the vulnerability."
    }
  }
}
string SeverityThreshold
{
  "enum": [
    "low",
    "medium",
    "high",
    "critical"
  ],
  "type": "string",
  "example": "high",
  "description": "Minimum Snyk issue severity to send a notification for, messages will not be sent for any issue below this value"
}
object SlackChannel
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uri",
      "example": "slack://channel?team=T123456&id=C123456"
    },
    "type": {
      "type": "string",
      "example": "slack_channel"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "general",
          "description": "Name of the Slack Channel"
        },
        "type": {
          "enum": [
            "public",
            "private",
            "direct_message",
            "multiparty_direct_message"
          ],
          "type": "string",
          "description": "Channel type"
        }
      }
    }
  }
}
object SlackDefaultSettingsData
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/Uuid"
    },
    "type": {
      "type": "string",
      "example": "slack"
    },
    "attributes": {
      "type": "object",
      "required": [
        "target_channel_id",
        "target_channel_name",
        "severity_threshold"
      ],
      "properties": {
        "target_channel_id": {
          "$ref": "#/components/schemas/TargetChannelId"
        },
        "severity_threshold": {
          "$ref": "#/components/schemas/SeverityThreshold"
        },
        "target_channel_name": {
          "$ref": "#/components/schemas/TargetChannelName"
        }
      }
    }
  }
}
object SlackGetChannelNameByIdResponse
{
  "type": "object",
  "required": [
    "data",
    "jsonapi",
    "links"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SlackChannel"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object SlackGetChannelsResponse
{
  "type": "object",
  "required": [
    "data",
    "jsonapi",
    "links"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SlackChannel"
      }
    },
    "links": {
      "$ref": "#/components/schemas/PaginatedLinks"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object SlackSettingsCreateDefaultNotificationSettingsResponse
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SlackDefaultSettingsData"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object SlackSettingsGetDefaultNotificationSettingsResponse
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SlackDefaultSettingsData"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object SlackSettingsProjectOverrideResponse
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProjectSettingsData"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object SlackSettingsUpdateNotificationSettingsForProjectResponse
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProjectSettingsData"
    },
    "links": {
      "$ref": "#/components/schemas/SelfLink"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object Slots
{
  "type": "object",
  "properties": {
    "exploit": {
      "type": "string",
      "example": "Not Defined",
      "description": "The exploit maturity. Value of ‘No Data’, ‘Not Defined’, ‘Unproven’, ‘Proof of Concept’, ‘Functional’ or ‘High’."
    },
    "references": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "URL for an external reference to the issue"
          },
          "title": {
            "type": "string",
            "description": "Descriptor for an external reference to the issue"
          }
        }
      }
    },
    "disclosure_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-06-16T13:51:13Z",
      "description": "The time at which this vulnerability was disclosed."
    },
    "publication_time": {
      "type": "string",
      "example": "2022-06-16T14:00:24.315507Z",
      "description": "The time at which this vulnerability was published."
    }
  }
}
object SourceLocation
{
  "type": "object",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "maximum": 2048,
      "minimum": 1,
      "description": "A path to the file containing this issue, relative to the root of the project target,\nformatted using POSIX separators.\n"
    },
    "region": {
      "$ref": "#/components/schemas/Region"
    }
  }
}
object SpdxDocument
{
  "type": "object",
  "additionalProperties": true
}
string TargetChannelId
{
  "type": "string",
  "format": "uri",
  "example": "slack://channel?team=team-id&id=channel-id"
}
string TargetChannelName
{
  "type": "string",
  "example": "channel-name",
  "minLength": 1
}
object TargetsGetByIdResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PublicTarget"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
object TargetsListByOrgIdResponse
{
  "type": "object",
  "required": [
    "jsonapi",
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PublicTarget"
      }
    },
    "meta": {
      "type": "object",
      "example": {
        "count": 3
      },
      "properties": {
        "count": {
          "type": "number"
        }
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "jsonapi": {
      "$ref": "#/components/schemas/JsonApi"
    }
  }
}
string TestExecutionType
{
  "enum": [
    "test-workflow-execution",
    "custom-execution"
  ],
  "type": "string"
}
string Type
{
  "type": "string"
}
string TypeDef
{
  "enum": [
    "package_vulnerability",
    "license",
    "cloud",
    "code",
    "custom",
    "config"
  ],
  "type": "string",
  "example": "cloud",
  "description": "The type of an issue."
}
string Types
{
  "type": "string",
  "example": "resource",
  "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$"
}
object UpdateCollectionRequest
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "type": {
          "$ref": "#/components/schemas/Types"
        },
        "attributes": {
          "type": "object",
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "$ref": "#/components/schemas/name"
            }
          }
        }
      }
    }
  }
}
object UpdateCollectionWithProjectsRequest
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "type"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "enum": [
              "project"
            ],
            "type": "string",
            "description": "Type of the item id"
          }
        }
      },
      "maxItems": 100,
      "description": "IDs of items to add to a collection"
    }
  }
}
string Updated
{
  "type": "string",
  "format": "date-time",
  "example": "2021-11-12T10:31:06.026Z",
  "description": "The last time the settings were updated."
}
string Uuid
{
  "type": "string",
  "format": "uuid"
}
object VersioningSchema
{
  "allOf": [
    {
      "oneOf": [
        {
          "$ref": "#/components/schemas/VersioningSchemaSemverType"
        },
        {
          "$ref": "#/components/schemas/VersioningSchemaCustomType"
        },
        {
          "$ref": "#/components/schemas/VersioningSchemaSingleSelectionType"
        }
      ]
    }
  ],
  "description": "The versioning scheme used by images in the repository.\n\nA versioning schema is a system for identifying and organizing different versions of a project. \nIt is used to track changes and updates to the project over time, and to help users identify which version they are using. \nA versioning schema typically consists of a series of numbers or labels that are incremented to reflect the progression of versions. \nFor example, a versioning schema might use a series of numbers, such as \"1.0\", \"1.1\", \"2.0\", and so on, to indicate major and minor releases of a product. \nA consistent and well-defined versioning schema helps users and tools understand and track the development of a project.\n"
}
object VersioningSchemaCustomType
{
  "type": "object",
  "required": [
    "type",
    "expression"
  ],
  "properties": {
    "type": {
      "enum": [
        "custom"
      ],
      "type": "string"
    },
    "label": {
      "type": "string",
      "example": "calendar with flavor schema",
      "description": "A customizable string that can be set for a custom versioning schema to describe its meaning.\nThis label has no function.\n"
    },
    "expression": {
      "type": "string",
      "example": "(?<C0>.)\\-(?<M2>.*)",
      "description": "The regular expression used to describe the format of tags.\nKeep in mind that backslashes in the expression need to be escaped due to being encompassed in a JSON string.\n"
    }
  },
  "description": "The Custom Schema type is a way for Snyk to understand your company’s container image tag versioning scheme,\nenabling Snyk to give more accurate base image upgrade recommendations.\n\nThis schema type is essentially a regular expression that groups the different parts of an image’s tag into comparable sections.\n\nIf your container image's tags follow a versioning scheme other than Semantic Versioning (SemVer), \nit is highly recommended that you select the \"Custom Versioning\" schema for your image repositories.\n"
}
object VersioningSchemaSemverType
{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "semver"
      ],
      "type": "string",
      "example": "semver"
    }
  }
}
object VersioningSchemaSingleSelectionType
{
  "type": "object",
  "required": [
    "type",
    "is_selected"
  ],
  "properties": {
    "type": {
      "enum": [
        "single-selection"
      ],
      "type": "string",
      "example": "single-selection"
    },
    "is_selected": {
      "type": "boolean",
      "example": true,
      "description": "Whether this image should be the recommendation. Only one image can be selected at a given time. Setting this\nas true will remove previous selection.\n"
    }
  },
  "description": "The Single Selection Versioning Schema allows manual setting of which image should be given as a recommendation.\n\nOnly one image can be set as the current recommendation. If no images are set as the current selection, \nno recommendation will be given.\n\nIt is recommended to use this versioning schema if your repository's tags aren't supported by the other schemas.\n"
}
object YarnBuildArgs
{
  "type": "object",
  "required": [
    "root_workspace"
  ],
  "properties": {
    "root_workspace": {
      "type": "string"
    }
  }
}
string name
{
  "type": "string",
  "pattern": "^([a-zA-Z0-9 _\\-\\/:.])+$",
  "maxLength": 255,
  "minLength": 1,
  "description": "User-defined name of the collection"
}