Interface ProjectRead

Export

ProjectRead

Hierarchy

  • ProjectRead

Properties

active_policy_repo_id? created_at description? id key name organization_id settings? updated_at urn_namespace?

Properties

Optional active_policy_repo_id

active_policy_repo_id?: string

the id of the policy repo to use for this project

Memberof

ProjectRead

created_at

created_at: string

Date and time when the project was created (ISO_8601 format).

Memberof

ProjectRead

Optional description

description?: string

a longer description outlining the project objectives

Memberof

ProjectRead

id

id: string

Unique id of the project

Memberof

ProjectRead

key

key: string

A URL-friendly name of the project (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the project.

Memberof

ProjectRead

name

name: string

The name of the project

Memberof

ProjectRead

organization_id

organization_id: string

Unique id of the organization that the project belongs to.

Memberof

ProjectRead

Optional settings

settings?: object

the settings for this project

Memberof

ProjectRead

updated_at

updated_at: string

Date and time when the project was last updated/modified (ISO_8601 format).

Memberof

ProjectRead

Optional urn_namespace

urn_namespace?: string

Optional namespace for URNs. If empty, URNs will be generated from project key.

Memberof

ProjectRead

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc