cdx-proto
    Preparing search index...

    Type Alias Service

    Service: Message<"cyclonedx.v1_5.Service"> & {
        authenticated?: boolean;
        bomRef?: string;
        data: cdx_15.DataFlow[];
        description?: string;
        endpoints: string[];
        externalReferences: cdx_15.ExternalReference[];
        group?: string;
        licenses: cdx_15.LicenseChoice[];
        name: string;
        properties: cdx_15.Property[];
        provider?: cdx_15.OrganizationalEntity;
        releaseNotes?: cdx_15.ReleaseNotes;
        services: cdx_15.Service[];
        trustZone?: string;
        version?: string;
        xTrustBoundary?: boolean;
    }

    Type declaration

    • Optionalauthenticated?: boolean

      A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication.

      from field: optional bool authenticated = 8;

    • OptionalbomRef?: string

      An optional identifier which can be used to reference the service elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.

      from field: optional string bom_ref = 1;

    • data: cdx_15.DataFlow[]

      from field: repeated cyclonedx.v1_5.DataFlow data = 10;

    • Optionaldescription?: string

      Specifies a description for the service.

      from field: optional string description = 6;

    • endpoints: string[]

      from field: repeated string endpoints = 7;

    • externalReferences: cdx_15.ExternalReference[]

      Provides the ability to document external references related to the service.

      from field: repeated cyclonedx.v1_5.ExternalReference external_references = 12;

    • Optionalgroup?: string

      The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.

      from field: optional string group = 3;

    • licenses: cdx_15.LicenseChoice[]

      from field: repeated cyclonedx.v1_5.LicenseChoice licenses = 11;

    • name: string

      The name of the service. This will often be a shortened, single name of the service.

      from field: string name = 4;

    • properties: cdx_15.Property[]

      Specifies optional, custom, properties

      from field: repeated cyclonedx.v1_5.Property properties = 14;

    • Optionalprovider?: cdx_15.OrganizationalEntity

      The organization that provides the service.

      from field: optional cyclonedx.v1_5.OrganizationalEntity provider = 2;

    • OptionalreleaseNotes?: cdx_15.ReleaseNotes

      Specifies optional release notes.

      from field: optional cyclonedx.v1_5.ReleaseNotes releaseNotes = 15;

    • services: cdx_15.Service[]

      Specifies optional sub-service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.

      from field: repeated cyclonedx.v1_5.Service services = 13;

    • OptionaltrustZone?: string

      The name of the trust zone the service resides in.

      from field: optional string trustZone = 16;

    • Optionalversion?: string

      The service version.

      from field: optional string version = 5;

    • OptionalxTrustBoundary?: boolean

      A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed.

      from field: optional bool x_trust_boundary = 9;

    from message cyclonedx.v1_5.Service

    Settings

    Member Visibility