cd6c46212a
Route audit-log and SCIM-event exports through export_jobs with typed arguments, an iam BuildAndUploadExport/SendExportEmail implementation, and a concurrent export-job worker with stale recovery. Stream JSONL via page.WalkAll into S3, and expose the request flow on console, connect, MCP, and CLI. Co-authored-by: Bryan Frimin <bryan@getprobo.com> Signed-off-by: Sacha Al Himdani <sacha@probo.com>
15037 lines
414 KiB
YAML
15037 lines
414 KiB
YAML
info:
|
|
title: Probo MCP Server
|
|
version: 1.0.0
|
|
description: Probo MCP Server API
|
|
|
|
components:
|
|
schemas:
|
|
EmailAddress:
|
|
type: string
|
|
format: string
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/mail.Addr
|
|
|
|
Duration:
|
|
type: string
|
|
description: A duration
|
|
go.probo.inc/mcpgen/type: time.Duration
|
|
|
|
OrderDirection:
|
|
type: string
|
|
enum:
|
|
- ASC
|
|
- DESC
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/page.OrderDirection
|
|
|
|
ThirdPartyOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ThirdPartyOrderField
|
|
|
|
ThirdPartyContactOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- FULL_NAME
|
|
- EMAIL
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ThirdPartyContactOrderField
|
|
|
|
ThirdPartyContactOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ThirdPartyContactOrderField"
|
|
description: ThirdParty contact order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: ThirdParty contact order direction
|
|
|
|
ThirdPartyServiceOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ThirdPartyServiceOrderField
|
|
|
|
ThirdPartyServiceOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ThirdPartyServiceOrderField"
|
|
description: ThirdParty service order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: ThirdParty service order direction
|
|
|
|
ThirdPartyRiskAssessmentOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- EXPIRES_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ThirdPartyRiskAssessmentOrderField
|
|
|
|
ThirdPartyRiskAssessmentOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ThirdPartyRiskAssessmentOrderField"
|
|
description: ThirdParty risk assessment order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: ThirdParty risk assessment order direction
|
|
|
|
DataSensitivity:
|
|
type: string
|
|
enum:
|
|
- NONE
|
|
- LOW
|
|
- MEDIUM
|
|
- HIGH
|
|
- CRITICAL
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DataSensitivity
|
|
|
|
BusinessImpact:
|
|
type: string
|
|
enum:
|
|
- LOW
|
|
- MEDIUM
|
|
- HIGH
|
|
- CRITICAL
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.BusinessImpact
|
|
|
|
ThirdPartyOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ThirdPartyOrderField"
|
|
description: ThirdParty order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: ThirdParty order direction
|
|
|
|
DocumentVersionApprovalQuorumOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalQuorumOrderField"
|
|
description: Order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
DocumentVersionApprovalDecisionOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalDecisionOrderField"
|
|
description: Order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
ProfileOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ProfileOrderField"
|
|
description: Profile order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Profile order direction
|
|
|
|
ProfileOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- FULL_NAME
|
|
- EMAIL_ADDRESS
|
|
- KIND
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.MembershipProfileOrderField
|
|
|
|
MembershipRole:
|
|
type: string
|
|
enum:
|
|
- OWNER
|
|
- ADMIN
|
|
- EMPLOYEE
|
|
- VIEWER
|
|
- AUDITOR
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.MembershipRole
|
|
|
|
ProfileState:
|
|
type: string
|
|
enum:
|
|
- ACTIVE
|
|
- INACTIVE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProfileState
|
|
|
|
ProfileKind:
|
|
type: string
|
|
enum:
|
|
- EMPLOYEE
|
|
- CONTRACTOR
|
|
- SERVICE_ACCOUNT
|
|
|
|
ProfileSource:
|
|
type: string
|
|
enum:
|
|
- MANUAL
|
|
- SCIM
|
|
- SAML
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProfileSource
|
|
|
|
Regulation:
|
|
type: string
|
|
enum:
|
|
- NONE
|
|
- GDPR
|
|
- UK_GDPR
|
|
- FADP
|
|
- CCPA
|
|
- PIPEDA
|
|
- LGPD
|
|
- LFPDPPP
|
|
- POPIA
|
|
- PDPA
|
|
- PIPL
|
|
- PIPA
|
|
- APPI
|
|
- DPDP
|
|
- PDPL
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.Regulation
|
|
|
|
RegulationSource:
|
|
type: string
|
|
enum:
|
|
- DETECTED
|
|
- DEFAULT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RegulationSource
|
|
|
|
CountryCode:
|
|
type: string
|
|
enum:
|
|
- GLOBAL
|
|
- AD
|
|
- AE
|
|
- AF
|
|
- AG
|
|
- AI
|
|
- AL
|
|
- AM
|
|
- AO
|
|
- AQ
|
|
- AR
|
|
- AS
|
|
- AT
|
|
- AU
|
|
- AW
|
|
- AX
|
|
- AZ
|
|
- BA
|
|
- BB
|
|
- BD
|
|
- BE
|
|
- BF
|
|
- BG
|
|
- BH
|
|
- BI
|
|
- BJ
|
|
- BL
|
|
- BM
|
|
- BN
|
|
- BO
|
|
- BQ
|
|
- BR
|
|
- BS
|
|
- BT
|
|
- BV
|
|
- BW
|
|
- BY
|
|
- BZ
|
|
- CA
|
|
- CC
|
|
- CD
|
|
- CF
|
|
- CG
|
|
- CH
|
|
- CI
|
|
- CK
|
|
- CL
|
|
- CM
|
|
- CN
|
|
- CO
|
|
- CR
|
|
- CU
|
|
- CV
|
|
- CW
|
|
- CX
|
|
- CY
|
|
- CZ
|
|
- DE
|
|
- DJ
|
|
- DK
|
|
- DM
|
|
- DO
|
|
- DZ
|
|
- EC
|
|
- EE
|
|
- EG
|
|
- EH
|
|
- ER
|
|
- ES
|
|
- ET
|
|
- EU
|
|
- FI
|
|
- FJ
|
|
- FK
|
|
- FM
|
|
- FO
|
|
- FR
|
|
- GA
|
|
- GB
|
|
- GD
|
|
- GE
|
|
- GF
|
|
- GG
|
|
- GH
|
|
- GI
|
|
- GL
|
|
- GM
|
|
- GN
|
|
- GP
|
|
- GQ
|
|
- GR
|
|
- GT
|
|
- GU
|
|
- GW
|
|
- GY
|
|
- HK
|
|
- HM
|
|
- HN
|
|
- HR
|
|
- HT
|
|
- HU
|
|
- ID
|
|
- IE
|
|
- IL
|
|
- IM
|
|
- IN
|
|
- IO
|
|
- IQ
|
|
- IR
|
|
- IS
|
|
- IT
|
|
- JE
|
|
- JM
|
|
- JO
|
|
- JP
|
|
- KE
|
|
- KG
|
|
- KH
|
|
- KI
|
|
- KM
|
|
- KN
|
|
- KP
|
|
- KR
|
|
- KW
|
|
- KY
|
|
- KZ
|
|
- LA
|
|
- LB
|
|
- LC
|
|
- LI
|
|
- LK
|
|
- LR
|
|
- LS
|
|
- LT
|
|
- LU
|
|
- LV
|
|
- LY
|
|
- MA
|
|
- MC
|
|
- MD
|
|
- ME
|
|
- MF
|
|
- MG
|
|
- MH
|
|
- MK
|
|
- ML
|
|
- MM
|
|
- MN
|
|
- MO
|
|
- MP
|
|
- MQ
|
|
- MR
|
|
- MS
|
|
- MT
|
|
- MU
|
|
- MV
|
|
- MW
|
|
- MX
|
|
- MY
|
|
- MZ
|
|
- NA
|
|
- NC
|
|
- NE
|
|
- NF
|
|
- NG
|
|
- NI
|
|
- NL
|
|
- NO
|
|
- NP
|
|
- NR
|
|
- NU
|
|
- NZ
|
|
- OM
|
|
- PA
|
|
- PE
|
|
- PF
|
|
- PG
|
|
- PH
|
|
- PK
|
|
- PL
|
|
- PM
|
|
- PN
|
|
- PR
|
|
- PS
|
|
- PT
|
|
- PW
|
|
- PY
|
|
- QA
|
|
- RE
|
|
- RO
|
|
- RS
|
|
- RU
|
|
- RW
|
|
- SA
|
|
- SB
|
|
- SC
|
|
- SD
|
|
- SE
|
|
- SG
|
|
- SH
|
|
- SI
|
|
- SJ
|
|
- SK
|
|
- SL
|
|
- SM
|
|
- SN
|
|
- SO
|
|
- SR
|
|
- SS
|
|
- ST
|
|
- SV
|
|
- SX
|
|
- SY
|
|
- SZ
|
|
- TC
|
|
- TD
|
|
- TF
|
|
- TG
|
|
- TH
|
|
- TJ
|
|
- TK
|
|
- TL
|
|
- TM
|
|
- TN
|
|
- TO
|
|
- TR
|
|
- TT
|
|
- TV
|
|
- TW
|
|
- TZ
|
|
- UA
|
|
- UG
|
|
- UM
|
|
- US
|
|
- UY
|
|
- UZ
|
|
- VA
|
|
- VC
|
|
- VE
|
|
- VG
|
|
- VI
|
|
- VN
|
|
- VU
|
|
- WF
|
|
- WS
|
|
- YE
|
|
- YT
|
|
- ZA
|
|
- ZM
|
|
- ZW
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.CountryCode
|
|
|
|
Profile:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- full_name
|
|
- email_address
|
|
- additional_email_addresses
|
|
- kind
|
|
- source
|
|
- state
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Profile ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
email_address:
|
|
$ref: "#/components/schemas/EmailAddress"
|
|
description: Primary email address
|
|
additional_email_addresses:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/EmailAddress"
|
|
description: Additional email addresses
|
|
kind:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Profile kind
|
|
source:
|
|
$ref: "#/components/schemas/ProfileSource"
|
|
description: Profile source (MANUAL, SCIM, or SAML)
|
|
state:
|
|
$ref: "#/components/schemas/ProfileState"
|
|
description: Profile state (ACTIVE or INACTIVE)
|
|
position:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Position
|
|
contract_start_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Contract start date
|
|
contract_end_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Contract end date
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListUsersInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ProfileOrderBy"
|
|
description: User order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
contract_ended:
|
|
type: boolean
|
|
description: Filter by contract status. True returns only users with ended contracts, false returns only users with active or no contract.
|
|
state:
|
|
$ref: "#/components/schemas/ProfileState"
|
|
description: Filter by profile state (ACTIVE or INACTIVE)
|
|
query:
|
|
type: string
|
|
description: Search by full name, email address, or position
|
|
role:
|
|
$ref: "#/components/schemas/MembershipRole"
|
|
description: Filter by membership role
|
|
kind:
|
|
$ref: "#/components/schemas/ProfileKind"
|
|
description: Filter by profile kind
|
|
|
|
ListUsersOutput:
|
|
type: object
|
|
required:
|
|
- users
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
users:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Profile"
|
|
|
|
GID:
|
|
type: string
|
|
format: string
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/gid.GID
|
|
|
|
CursorKey:
|
|
type: string
|
|
format: string
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/page.CursorKey
|
|
|
|
ListOrganizationsInput:
|
|
type: object
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
|
|
ListOrganizationsOutput:
|
|
type: object
|
|
properties:
|
|
organizations:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Organization"
|
|
|
|
Organization:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Organization name
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListThirdPartiesInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
level:
|
|
type: integer
|
|
description: Filter by level
|
|
order_by:
|
|
$ref: "#/components/schemas/ThirdPartyOrderBy"
|
|
description: ThirdParty order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListThirdPartiesOutput:
|
|
type: object
|
|
required:
|
|
- thirdParties
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
thirdParties:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ThirdParty"
|
|
|
|
ListChildThirdPartiesInput:
|
|
type: object
|
|
required:
|
|
- parent_third_party_id
|
|
properties:
|
|
parent_third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Parent third party ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ThirdPartyOrderBy"
|
|
description: ThirdParty order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListChildThirdPartiesOutput:
|
|
type: object
|
|
required:
|
|
- thirdParties
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
thirdParties:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ThirdParty"
|
|
|
|
ThirdParty:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- organization_id
|
|
- category
|
|
- level
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: ThirdParty name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: ThirdParty description
|
|
category:
|
|
type: string
|
|
enum:
|
|
- ANALYTICS
|
|
- CLOUD_MONITORING
|
|
- CLOUD_PROVIDER
|
|
- COLLABORATION
|
|
- CUSTOMER_SUPPORT
|
|
- DATA_STORAGE_AND_PROCESSING
|
|
- DOCUMENT_MANAGEMENT
|
|
- EMPLOYEE_MANAGEMENT
|
|
- ENGINEERING
|
|
- FINANCE
|
|
- IDENTITY_PROVIDER
|
|
- IT
|
|
- MARKETING
|
|
- OFFICE_OPERATIONS
|
|
- OTHER
|
|
- PASSWORD_MANAGEMENT
|
|
- PRODUCT_AND_DESIGN
|
|
- PROFESSIONAL_SERVICES
|
|
- RECRUITING
|
|
- SALES
|
|
- SECURITY
|
|
- VERSION_CONTROL
|
|
description: ThirdParty category
|
|
headquarter_address:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Headquarter address
|
|
legal_name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Legal name
|
|
website_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Website URL
|
|
privacy_policy_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Privacy policy URL
|
|
service_level_agreement_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Service level agreement URL
|
|
data_processing_agreement_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Data processing agreement URL
|
|
business_associate_agreement_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Business associate agreement URL
|
|
subprocessors_list_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Subprocessors list URL
|
|
certifications:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Certifications
|
|
countries:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Countries or regions (ISO 3166-1 alpha-2 country codes, EU, or GLOBAL)
|
|
business_owner_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Business owner ID
|
|
security_owner_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Security owner ID
|
|
status_page_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Status page URL
|
|
terms_of_service_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Terms of service URL
|
|
security_page_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Security page URL
|
|
trust_page_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Trust page URL
|
|
level:
|
|
type: integer
|
|
description: Level of this third party (1 = direct, 2+ = indirect)
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ThirdPartyRiskAssessment:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- third_party_id
|
|
- expires_at
|
|
- data_sensitivity
|
|
- business_impact
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty risk assessment ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
expires_at:
|
|
type: string
|
|
format: date-time
|
|
description: Expiration timestamp
|
|
data_sensitivity:
|
|
$ref: "#/components/schemas/DataSensitivity"
|
|
description: Data sensitivity level
|
|
business_impact:
|
|
$ref: "#/components/schemas/BusinessImpact"
|
|
description: Business impact level
|
|
notes:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Notes
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListThirdPartyRiskAssessmentsInput:
|
|
type: object
|
|
required:
|
|
- third_party_id
|
|
properties:
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ThirdPartyRiskAssessmentOrderBy"
|
|
description: ThirdParty risk assessment order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListThirdPartyRiskAssessmentsOutput:
|
|
type: object
|
|
required:
|
|
- third_party_risk_assessments
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
third_party_risk_assessments:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ThirdPartyRiskAssessment"
|
|
|
|
AddThirdPartyRiskAssessmentInput:
|
|
type: object
|
|
required:
|
|
- third_party_id
|
|
- expires_at
|
|
- data_sensitivity
|
|
- business_impact
|
|
properties:
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
expires_at:
|
|
type: string
|
|
format: date-time
|
|
description: Expiration timestamp
|
|
data_sensitivity:
|
|
$ref: "#/components/schemas/DataSensitivity"
|
|
description: Data sensitivity level
|
|
business_impact:
|
|
$ref: "#/components/schemas/BusinessImpact"
|
|
description: Business impact level
|
|
notes:
|
|
type: string
|
|
description: Notes
|
|
|
|
AddThirdPartyRiskAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- third_party_risk_assessment
|
|
properties:
|
|
third_party_risk_assessment:
|
|
$ref: "#/components/schemas/ThirdPartyRiskAssessment"
|
|
|
|
AddThirdPartyInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: ThirdParty name
|
|
description:
|
|
type: string
|
|
description: ThirdParty description
|
|
category:
|
|
type: string
|
|
enum:
|
|
- ANALYTICS
|
|
- CLOUD_MONITORING
|
|
- CLOUD_PROVIDER
|
|
- COLLABORATION
|
|
- CUSTOMER_SUPPORT
|
|
- DATA_STORAGE_AND_PROCESSING
|
|
- DOCUMENT_MANAGEMENT
|
|
- EMPLOYEE_MANAGEMENT
|
|
- ENGINEERING
|
|
- FINANCE
|
|
- IDENTITY_PROVIDER
|
|
- IT
|
|
- MARKETING
|
|
- OFFICE_OPERATIONS
|
|
- OTHER
|
|
- PASSWORD_MANAGEMENT
|
|
- PRODUCT_AND_DESIGN
|
|
- PROFESSIONAL_SERVICES
|
|
- RECRUITING
|
|
- SALES
|
|
- SECURITY
|
|
- VERSION_CONTROL
|
|
description: ThirdParty category
|
|
headquarter_address:
|
|
type: string
|
|
description: Headquarter address
|
|
legal_name:
|
|
type: string
|
|
description: Legal name
|
|
website_url:
|
|
type: string
|
|
description: Website URL
|
|
privacy_policy_url:
|
|
type: string
|
|
description: Privacy policy URL
|
|
service_level_agreement_url:
|
|
type: string
|
|
description: Service level agreement URL
|
|
data_processing_agreement_url:
|
|
type: string
|
|
description: Data processing agreement URL
|
|
business_associate_agreement_url:
|
|
type: string
|
|
description: Business associate agreement URL
|
|
subprocessors_list_url:
|
|
type: string
|
|
description: Subprocessors list URL
|
|
certifications:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Certifications
|
|
countries:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Countries or regions (ISO 3166-1 alpha-2 country codes, EU, or GLOBAL)
|
|
business_owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Business owner ID
|
|
security_owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Security owner ID
|
|
status_page_url:
|
|
type: string
|
|
description: Status page URL
|
|
terms_of_service_url:
|
|
type: string
|
|
description: Terms of service URL
|
|
security_page_url:
|
|
type: string
|
|
description: Security page URL
|
|
trust_page_url:
|
|
type: string
|
|
description: Trust page URL
|
|
|
|
AddThirdPartyOutput:
|
|
type: object
|
|
required:
|
|
- thirdParty
|
|
properties:
|
|
thirdParty:
|
|
$ref: "#/components/schemas/ThirdParty"
|
|
|
|
UpdateThirdPartyInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
name:
|
|
type: string
|
|
description: ThirdParty name
|
|
description:
|
|
type: string
|
|
description: ThirdParty description
|
|
category:
|
|
type: string
|
|
enum:
|
|
- ANALYTICS
|
|
- CLOUD_MONITORING
|
|
- CLOUD_PROVIDER
|
|
- COLLABORATION
|
|
- CUSTOMER_SUPPORT
|
|
- DATA_STORAGE_AND_PROCESSING
|
|
- DOCUMENT_MANAGEMENT
|
|
- EMPLOYEE_MANAGEMENT
|
|
- ENGINEERING
|
|
- FINANCE
|
|
- IDENTITY_PROVIDER
|
|
- IT
|
|
- MARKETING
|
|
- OFFICE_OPERATIONS
|
|
- OTHER
|
|
- PASSWORD_MANAGEMENT
|
|
- PRODUCT_AND_DESIGN
|
|
- PROFESSIONAL_SERVICES
|
|
- RECRUITING
|
|
- SALES
|
|
- SECURITY
|
|
- VERSION_CONTROL
|
|
description: ThirdParty category
|
|
headquarter_address:
|
|
type: string
|
|
description: Headquarter address
|
|
legal_name:
|
|
type: string
|
|
description: Legal name
|
|
website_url:
|
|
type: string
|
|
description: Website URL
|
|
privacy_policy_url:
|
|
type: string
|
|
description: Privacy policy URL
|
|
service_level_agreement_url:
|
|
type: string
|
|
description: Service level agreement URL
|
|
data_processing_agreement_url:
|
|
type: string
|
|
description: Data processing agreement URL
|
|
business_associate_agreement_url:
|
|
type: string
|
|
description: Business associate agreement URL
|
|
subprocessors_list_url:
|
|
type: string
|
|
description: Subprocessors list URL
|
|
certifications:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Certifications
|
|
countries:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Countries or regions (ISO 3166-1 alpha-2 country codes, EU, or GLOBAL)
|
|
business_owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Business owner ID
|
|
security_owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Security owner ID
|
|
status_page_url:
|
|
type: string
|
|
description: Status page URL
|
|
terms_of_service_url:
|
|
type: string
|
|
description: Terms of service URL
|
|
security_page_url:
|
|
type: string
|
|
description: Security page URL
|
|
trust_page_url:
|
|
type: string
|
|
description: Trust page URL
|
|
|
|
UpdateThirdPartyOutput:
|
|
type: object
|
|
required:
|
|
- thirdParty
|
|
properties:
|
|
thirdParty:
|
|
$ref: "#/components/schemas/ThirdParty"
|
|
|
|
DeleteThirdPartyInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
|
|
DeleteThirdPartyOutput:
|
|
type: object
|
|
required:
|
|
- deleted_third_party_id
|
|
properties:
|
|
deleted_third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted thirdParty ID
|
|
|
|
ThirdPartyContact:
|
|
type: object
|
|
required:
|
|
- id
|
|
- third_party_id
|
|
- full_name
|
|
- email
|
|
- phone
|
|
- role
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty contact ID
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
email:
|
|
type: string
|
|
description: Email address
|
|
phone:
|
|
type: string
|
|
description: Phone number
|
|
role:
|
|
type: string
|
|
description: Role
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListThirdPartyContactsInput:
|
|
type: object
|
|
required:
|
|
- third_party_id
|
|
properties:
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ThirdPartyContactOrderBy"
|
|
description: ThirdParty contact order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListThirdPartyContactsOutput:
|
|
type: object
|
|
required:
|
|
- third_party_contacts
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
third_party_contacts:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ThirdPartyContact"
|
|
|
|
AddThirdPartyContactInput:
|
|
type: object
|
|
required:
|
|
- third_party_id
|
|
- full_name
|
|
- email
|
|
- phone
|
|
- role
|
|
properties:
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
email:
|
|
type: string
|
|
description: Email address
|
|
phone:
|
|
type: string
|
|
description: Phone number
|
|
role:
|
|
type: string
|
|
description: Role
|
|
|
|
AddThirdPartyContactOutput:
|
|
type: object
|
|
required:
|
|
- third_party_contact
|
|
properties:
|
|
third_party_contact:
|
|
$ref: "#/components/schemas/ThirdPartyContact"
|
|
|
|
UpdateThirdPartyContactInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty contact ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
email:
|
|
type: string
|
|
description: Email address
|
|
phone:
|
|
type: string
|
|
description: Phone number
|
|
role:
|
|
type: string
|
|
description: Role
|
|
|
|
UpdateThirdPartyContactOutput:
|
|
type: object
|
|
required:
|
|
- third_party_contact
|
|
properties:
|
|
third_party_contact:
|
|
$ref: "#/components/schemas/ThirdPartyContact"
|
|
|
|
DeleteThirdPartyContactInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty contact ID
|
|
|
|
DeleteThirdPartyContactOutput:
|
|
type: object
|
|
required:
|
|
- deleted_third_party_contact_id
|
|
properties:
|
|
deleted_third_party_contact_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted thirdParty contact ID
|
|
|
|
ThirdPartyService:
|
|
type: object
|
|
required:
|
|
- id
|
|
- third_party_id
|
|
- name
|
|
- description
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty service ID
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
name:
|
|
type: string
|
|
description: Service name
|
|
description:
|
|
type: string
|
|
description: Service description
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListThirdPartyServicesInput:
|
|
type: object
|
|
required:
|
|
- third_party_id
|
|
properties:
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ThirdPartyServiceOrderBy"
|
|
description: ThirdParty service order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListThirdPartyServicesOutput:
|
|
type: object
|
|
required:
|
|
- third_party_services
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
third_party_services:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ThirdPartyService"
|
|
|
|
AddThirdPartyServiceInput:
|
|
type: object
|
|
required:
|
|
- third_party_id
|
|
- name
|
|
properties:
|
|
third_party_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID
|
|
name:
|
|
type: string
|
|
description: Service name
|
|
description:
|
|
type: string
|
|
description: Service description
|
|
|
|
AddThirdPartyServiceOutput:
|
|
type: object
|
|
required:
|
|
- third_party_service
|
|
properties:
|
|
third_party_service:
|
|
$ref: "#/components/schemas/ThirdPartyService"
|
|
|
|
UpdateThirdPartyServiceInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty service ID
|
|
name:
|
|
type: string
|
|
description: Service name
|
|
description:
|
|
type: string
|
|
description: Service description
|
|
|
|
UpdateThirdPartyServiceOutput:
|
|
type: object
|
|
required:
|
|
- third_party_service
|
|
properties:
|
|
third_party_service:
|
|
$ref: "#/components/schemas/ThirdPartyService"
|
|
|
|
DeleteThirdPartyServiceInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty service ID
|
|
|
|
DeleteThirdPartyServiceOutput:
|
|
type: object
|
|
required:
|
|
- deleted_third_party_service_id
|
|
properties:
|
|
deleted_third_party_service_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted thirdParty service ID
|
|
|
|
VetThirdPartyInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
- website_url
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty ID to vet
|
|
website_url:
|
|
type: string
|
|
description: ThirdParty website URL to crawl and vet
|
|
procedure:
|
|
type: string
|
|
description: Optional custom vetting procedure (overrides the default)
|
|
|
|
VetThirdPartyOutput:
|
|
type: object
|
|
required:
|
|
- thirdParty
|
|
properties:
|
|
thirdParty:
|
|
$ref: "#/components/schemas/ThirdParty"
|
|
|
|
GetUserInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: User ID (profile ID)
|
|
|
|
GetUserOutput:
|
|
type: object
|
|
required:
|
|
- user
|
|
properties:
|
|
user:
|
|
$ref: "#/components/schemas/Profile"
|
|
|
|
CreateUserInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- full_name
|
|
- email_address
|
|
- role
|
|
- kind
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
email_address:
|
|
$ref: "#/components/schemas/EmailAddress"
|
|
description: Email address
|
|
role:
|
|
$ref: "#/components/schemas/MembershipRole"
|
|
description: Membership role
|
|
additional_email_addresses:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/EmailAddress"
|
|
description: Additional email addresses
|
|
kind:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: User kind
|
|
position:
|
|
type: ["string", "null"]
|
|
description: Position
|
|
contract_start_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Contract start date
|
|
contract_end_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Contract end date
|
|
|
|
CreateUserOutput:
|
|
type: object
|
|
required:
|
|
- user
|
|
properties:
|
|
user:
|
|
$ref: "#/components/schemas/Profile"
|
|
|
|
InviteUserInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- profile_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
profile_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: User (profile) ID to invite
|
|
|
|
InviteUserOutput:
|
|
type: object
|
|
required:
|
|
- invitation_id
|
|
properties:
|
|
invitation_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created invitation ID
|
|
|
|
UpdateUserInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
- full_name
|
|
- kind
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: User (profile) ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
additional_email_addresses:
|
|
anyOf:
|
|
- type: array
|
|
items:
|
|
$ref: "#/components/schemas/EmailAddress"
|
|
- type: "null"
|
|
description: Additional email addresses
|
|
kind:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: User kind
|
|
position:
|
|
type: ["string", "null"]
|
|
description: Position
|
|
go.probo.inc/mcpgen/omittable: true
|
|
contract_start_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Contract start date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
contract_end_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Contract end date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateUserOutput:
|
|
type: object
|
|
required:
|
|
- user
|
|
properties:
|
|
user:
|
|
$ref: "#/components/schemas/Profile"
|
|
|
|
Membership:
|
|
type: object
|
|
required:
|
|
- id
|
|
- role
|
|
- created_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Membership ID
|
|
role:
|
|
$ref: "#/components/schemas/MembershipRole"
|
|
description: Membership role
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
|
|
UpdateMembershipInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- membership_id
|
|
- role
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
membership_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Membership ID
|
|
role:
|
|
$ref: "#/components/schemas/MembershipRole"
|
|
description: New role
|
|
|
|
UpdateMembershipOutput:
|
|
type: object
|
|
required:
|
|
- membership
|
|
properties:
|
|
membership:
|
|
$ref: "#/components/schemas/Membership"
|
|
|
|
RemoveUserInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- profile_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
profile_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: User (profile) ID to remove
|
|
|
|
RemoveUserOutput:
|
|
type: object
|
|
required:
|
|
- deleted_user_id
|
|
properties:
|
|
deleted_user_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted user (profile) ID
|
|
|
|
ArchiveUserInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- profile_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
profile_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: User (profile) ID to archive
|
|
|
|
ArchiveUserOutput:
|
|
type: object
|
|
required:
|
|
- archived_user_id
|
|
properties:
|
|
archived_user_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Archived user (profile) ID
|
|
|
|
GetProfileInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Profile ID
|
|
|
|
GetProfileOutput:
|
|
type: object
|
|
required:
|
|
- profile
|
|
properties:
|
|
profile:
|
|
$ref: "#/components/schemas/Profile"
|
|
|
|
UpdateProfileInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Profile ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
additional_email_addresses:
|
|
anyOf:
|
|
- type: array
|
|
items:
|
|
$ref: "#/components/schemas/EmailAddress"
|
|
- type: "null"
|
|
description: No additional email addresses
|
|
description: Additional email addresses
|
|
kind:
|
|
anyOf:
|
|
- type: string
|
|
- type: "null"
|
|
description: Profile kind
|
|
position:
|
|
type: ["string", "null"]
|
|
description: Position
|
|
go.probo.inc/mcpgen/omittable: true
|
|
contract_start_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Contract start date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
contract_end_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Contract end date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateProfileOutput:
|
|
type: object
|
|
required:
|
|
- profile
|
|
properties:
|
|
profile:
|
|
$ref: "#/components/schemas/Profile"
|
|
|
|
RiskOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
- NAME
|
|
- CATEGORY
|
|
- TREATMENT
|
|
- INHERENT_RISK_SCORE
|
|
- RESIDUAL_RISK_SCORE
|
|
- OWNER_FULL_NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskOrderField
|
|
|
|
RiskOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskOrderField"
|
|
description: Risk order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Risk order direction
|
|
|
|
RiskTreatment:
|
|
type: string
|
|
enum:
|
|
- MITIGATED
|
|
- ACCEPTED
|
|
- AVOIDED
|
|
- TRANSFERRED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskTreatment
|
|
|
|
Risk:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- category
|
|
- treatment
|
|
- inherent_likelihood
|
|
- inherent_impact
|
|
- inherent_risk_score
|
|
- residual_likelihood
|
|
- residual_impact
|
|
- residual_risk_score
|
|
- note
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Risk name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Risk description
|
|
category:
|
|
type: string
|
|
description: Risk category
|
|
treatment:
|
|
$ref: "#/components/schemas/RiskTreatment"
|
|
description: Risk treatment
|
|
inherent_likelihood:
|
|
type: integer
|
|
description: Initial likelihood
|
|
inherent_impact:
|
|
type: integer
|
|
description: Initial impact
|
|
inherent_risk_score:
|
|
type: integer
|
|
description: Initial risk score
|
|
residual_likelihood:
|
|
type: integer
|
|
description: Residual likelihood
|
|
residual_impact:
|
|
type: integer
|
|
description: Residual impact
|
|
residual_risk_score:
|
|
type: integer
|
|
description: Residual risk score
|
|
note:
|
|
type: string
|
|
description: Risk note
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: No owner
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListRisksInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskOrderBy"
|
|
description: Risk order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: Search query
|
|
|
|
ListRisksOutput:
|
|
type: object
|
|
required:
|
|
- risks
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risks:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
GetRiskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
|
|
GetRiskOutput:
|
|
type: object
|
|
required:
|
|
- risk
|
|
properties:
|
|
risk:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
AddRiskInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- category
|
|
- treatment
|
|
- inherent_likelihood
|
|
- inherent_impact
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Risk name
|
|
description:
|
|
type: string
|
|
description: Risk description
|
|
category:
|
|
type: string
|
|
description: Risk category
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
treatment:
|
|
$ref: "#/components/schemas/RiskTreatment"
|
|
description: Risk treatment
|
|
inherent_likelihood:
|
|
type: integer
|
|
description: Initial likelihood
|
|
inherent_impact:
|
|
type: integer
|
|
description: Initial impact
|
|
residual_likelihood:
|
|
type: integer
|
|
description: Residual likelihood
|
|
residual_impact:
|
|
type: integer
|
|
description: Residual impact
|
|
note:
|
|
type: string
|
|
description: Risk note
|
|
|
|
AddRiskOutput:
|
|
type: object
|
|
required:
|
|
- risk
|
|
properties:
|
|
risk:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
UpdateRiskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
name:
|
|
type: string
|
|
description: Risk name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Risk description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
category:
|
|
type: string
|
|
description: Risk category
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
go.probo.inc/mcpgen/omittable: true
|
|
treatment:
|
|
$ref: "#/components/schemas/RiskTreatment"
|
|
description: Risk treatment
|
|
inherent_likelihood:
|
|
type: integer
|
|
description: Initial likelihood
|
|
inherent_impact:
|
|
type: integer
|
|
description: Initial impact
|
|
residual_likelihood:
|
|
type: integer
|
|
description: Residual likelihood
|
|
residual_impact:
|
|
type: integer
|
|
description: Residual impact
|
|
note:
|
|
type: string
|
|
description: Risk note
|
|
|
|
UpdateRiskOutput:
|
|
type: object
|
|
required:
|
|
- risk
|
|
properties:
|
|
risk:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
DeleteRiskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
|
|
DeleteRiskOutput:
|
|
type: object
|
|
required:
|
|
- deleted_risk_id
|
|
properties:
|
|
deleted_risk_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted risk ID
|
|
|
|
MeasureState:
|
|
type: string
|
|
enum:
|
|
- NOT_STARTED
|
|
- IN_PROGRESS
|
|
- NOT_APPLICABLE
|
|
- IMPLEMENTED
|
|
- UNKNOWN
|
|
- NOT_IMPLEMENTED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.MeasureState
|
|
|
|
MeasureOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.MeasureOrderField
|
|
|
|
MeasureOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/MeasureOrderField"
|
|
description: Measure order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Measure order direction
|
|
|
|
Measure:
|
|
type: object
|
|
required:
|
|
- id
|
|
- category
|
|
- name
|
|
- state
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
category:
|
|
type: string
|
|
description: Measure category
|
|
name:
|
|
type: string
|
|
description: Measure name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Measure description
|
|
state:
|
|
$ref: "#/components/schemas/MeasureState"
|
|
description: Measure state
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListMeasuresInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/MeasureOrderBy"
|
|
description: Measure order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: Search query
|
|
state:
|
|
$ref: "#/components/schemas/MeasureState"
|
|
description: Measure state filter
|
|
category:
|
|
type: string
|
|
description: Filter by measure category
|
|
|
|
ListMeasuresOutput:
|
|
type: object
|
|
required:
|
|
- measures
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
measures:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
ListMeasureRisksInput:
|
|
type: object
|
|
required:
|
|
- measure_id
|
|
properties:
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskOrderBy"
|
|
description: Risk order by
|
|
|
|
ListMeasureRisksOutput:
|
|
type: object
|
|
required:
|
|
- risks
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risks:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
ListMeasureControlsInput:
|
|
type: object
|
|
required:
|
|
- measure_id
|
|
properties:
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/ControlOrderBy"
|
|
description: Control order by
|
|
|
|
ListMeasureControlsOutput:
|
|
type: object
|
|
required:
|
|
- controls
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
controls:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Control"
|
|
|
|
ListMeasureDocumentsInput:
|
|
type: object
|
|
required:
|
|
- measure_id
|
|
properties:
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/DocumentOrderBy"
|
|
description: Document order by
|
|
|
|
ListMeasureDocumentsOutput:
|
|
type: object
|
|
required:
|
|
- documents
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
documents:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Document"
|
|
|
|
ListMeasureTasksInput:
|
|
type: object
|
|
required:
|
|
- measure_id
|
|
properties:
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/TaskOrderBy"
|
|
description: Task order by
|
|
|
|
ListMeasureTasksOutput:
|
|
type: object
|
|
required:
|
|
- tasks
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
tasks:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Task"
|
|
|
|
ListMeasureEvidencesInput:
|
|
type: object
|
|
required:
|
|
- measure_id
|
|
properties:
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
|
|
ListMeasureEvidencesOutput:
|
|
type: object
|
|
required:
|
|
- evidences
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
evidences:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Evidence"
|
|
|
|
Evidence:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- measure_id
|
|
- state
|
|
- reference_id
|
|
- type
|
|
- url
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
task_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Task ID
|
|
nullable: true
|
|
state:
|
|
type: string
|
|
enum:
|
|
- REQUESTED
|
|
- FULFILLED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.EvidenceState
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID
|
|
type:
|
|
type: string
|
|
enum:
|
|
- FILE
|
|
- LINK
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.EvidenceType
|
|
url:
|
|
type: string
|
|
description: URL
|
|
description:
|
|
type: string
|
|
description: Description
|
|
nullable: true
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
LinkMeasureInput:
|
|
type: object
|
|
required:
|
|
- measure_id
|
|
- resource_id
|
|
properties:
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the resource to link (control, risk, document, or third party)
|
|
|
|
LinkMeasureOutput:
|
|
type: object
|
|
|
|
UnlinkMeasureInput:
|
|
type: object
|
|
required:
|
|
- measure_id
|
|
- resource_id
|
|
properties:
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the resource to unlink (control, risk, document, or third party)
|
|
|
|
UnlinkMeasureOutput:
|
|
type: object
|
|
|
|
GetMeasureInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
|
|
GetMeasureOutput:
|
|
type: object
|
|
required:
|
|
- measure
|
|
properties:
|
|
measure:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
AddMeasureInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- category
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Measure name
|
|
description:
|
|
type: string
|
|
description: Measure description
|
|
category:
|
|
type: string
|
|
description: Measure category
|
|
|
|
AddMeasureOutput:
|
|
type: object
|
|
required:
|
|
- measure
|
|
properties:
|
|
measure:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
UpdateMeasureInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
name:
|
|
type: string
|
|
description: Measure name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Measure description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
category:
|
|
type: string
|
|
description: Measure category
|
|
state:
|
|
$ref: "#/components/schemas/MeasureState"
|
|
description: Measure state
|
|
|
|
UpdateMeasureOutput:
|
|
type: object
|
|
required:
|
|
- measure
|
|
properties:
|
|
measure:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
DeleteMeasureInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
|
|
DeleteMeasureOutput:
|
|
type: object
|
|
required:
|
|
- deleted_measure_id
|
|
properties:
|
|
deleted_measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted measure ID
|
|
|
|
FrameworkOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.FrameworkOrderField
|
|
|
|
FrameworkOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/FrameworkOrderField"
|
|
description: Framework order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Framework order direction
|
|
|
|
Framework:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Framework name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Framework description
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListFrameworksInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/FrameworkOrderBy"
|
|
description: Framework order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListFrameworksOutput:
|
|
type: object
|
|
required:
|
|
- frameworks
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
frameworks:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Framework"
|
|
|
|
GetFrameworkInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
|
|
GetFrameworkOutput:
|
|
type: object
|
|
required:
|
|
- framework
|
|
properties:
|
|
framework:
|
|
$ref: "#/components/schemas/Framework"
|
|
|
|
AddFrameworkInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Framework name
|
|
description:
|
|
type: string
|
|
description: Framework description
|
|
|
|
AddFrameworkOutput:
|
|
type: object
|
|
required:
|
|
- framework
|
|
properties:
|
|
framework:
|
|
$ref: "#/components/schemas/Framework"
|
|
|
|
UpdateFrameworkInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
name:
|
|
type: string
|
|
description: Framework name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Framework description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateFrameworkOutput:
|
|
type: object
|
|
required:
|
|
- framework
|
|
properties:
|
|
framework:
|
|
$ref: "#/components/schemas/Framework"
|
|
|
|
AssetType:
|
|
type: string
|
|
enum:
|
|
- PHYSICAL
|
|
- VIRTUAL
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AssetType
|
|
|
|
AssetOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- AMOUNT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AssetOrderField
|
|
|
|
AssetOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/AssetOrderField"
|
|
description: Asset order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Asset order direction
|
|
|
|
Asset:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- amount
|
|
- owner_id
|
|
- asset_type
|
|
- data_types_stored
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Asset ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Asset name
|
|
amount:
|
|
type: integer
|
|
description: Asset amount
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
asset_type:
|
|
$ref: "#/components/schemas/AssetType"
|
|
description: Asset type
|
|
data_types_stored:
|
|
type: string
|
|
description: Data types stored
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListAssetsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/AssetOrderBy"
|
|
description: Asset order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListAssetsOutput:
|
|
type: object
|
|
required:
|
|
- assets
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
assets:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Asset"
|
|
|
|
GetAssetInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Asset ID
|
|
|
|
GetAssetOutput:
|
|
type: object
|
|
required:
|
|
- asset
|
|
properties:
|
|
asset:
|
|
$ref: "#/components/schemas/Asset"
|
|
|
|
AddAssetInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- amount
|
|
- owner_id
|
|
- asset_type
|
|
- data_types_stored
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Asset name
|
|
amount:
|
|
type: integer
|
|
description: Asset amount
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
asset_type:
|
|
$ref: "#/components/schemas/AssetType"
|
|
description: Asset type
|
|
data_types_stored:
|
|
type: string
|
|
description: Data types stored
|
|
third_party_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty IDs
|
|
|
|
AddAssetOutput:
|
|
type: object
|
|
required:
|
|
- asset
|
|
properties:
|
|
asset:
|
|
$ref: "#/components/schemas/Asset"
|
|
|
|
UpdateAssetInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Asset ID
|
|
name:
|
|
type: string
|
|
description: Asset name
|
|
amount:
|
|
type: integer
|
|
description: Asset amount
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
asset_type:
|
|
$ref: "#/components/schemas/AssetType"
|
|
description: Asset type
|
|
data_types_stored:
|
|
type: string
|
|
description: Data types stored
|
|
third_party_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty IDs
|
|
|
|
UpdateAssetOutput:
|
|
type: object
|
|
required:
|
|
- asset
|
|
properties:
|
|
asset:
|
|
$ref: "#/components/schemas/Asset"
|
|
|
|
DeleteAssetInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Asset ID
|
|
|
|
DeleteAssetOutput:
|
|
type: object
|
|
required:
|
|
- deleted_asset_id
|
|
properties:
|
|
deleted_asset_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted asset ID
|
|
|
|
DataClassification:
|
|
type: string
|
|
enum:
|
|
- PUBLIC
|
|
- INTERNAL
|
|
- CONFIDENTIAL
|
|
- SECRET
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DataClassification
|
|
|
|
DatumOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
- DATA_CLASSIFICATION
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DatumOrderField
|
|
|
|
DatumOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/DatumOrderField"
|
|
description: Datum order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Datum order direction
|
|
|
|
Datum:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- data_classification
|
|
- owner_id
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Datum ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Datum name
|
|
data_classification:
|
|
$ref: "#/components/schemas/DataClassification"
|
|
description: Data classification
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListDataInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/DatumOrderBy"
|
|
description: Datum order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
ListDataOutput:
|
|
type: object
|
|
required:
|
|
- data
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
data:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Datum"
|
|
|
|
GetDatumInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Datum ID
|
|
|
|
GetDatumOutput:
|
|
type: object
|
|
required:
|
|
- datum
|
|
properties:
|
|
datum:
|
|
$ref: "#/components/schemas/Datum"
|
|
|
|
AddDatumInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- data_classification
|
|
- owner_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Datum name
|
|
data_classification:
|
|
$ref: "#/components/schemas/DataClassification"
|
|
description: Data classification
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
third_party_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty IDs
|
|
|
|
AddDatumOutput:
|
|
type: object
|
|
required:
|
|
- datum
|
|
properties:
|
|
datum:
|
|
$ref: "#/components/schemas/Datum"
|
|
|
|
UpdateDatumInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Datum ID
|
|
name:
|
|
type: string
|
|
description: Datum name
|
|
data_classification:
|
|
$ref: "#/components/schemas/DataClassification"
|
|
description: Data classification
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
third_party_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty IDs
|
|
|
|
UpdateDatumOutput:
|
|
type: object
|
|
required:
|
|
- datum
|
|
properties:
|
|
datum:
|
|
$ref: "#/components/schemas/Datum"
|
|
|
|
DeleteDatumInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Datum ID
|
|
|
|
DeleteDatumOutput:
|
|
type: object
|
|
required:
|
|
- deleted_datum_id
|
|
properties:
|
|
deleted_datum_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted datum ID
|
|
|
|
FindingKind:
|
|
type: string
|
|
enum:
|
|
- MINOR_NONCONFORMITY
|
|
- MAJOR_NONCONFORMITY
|
|
- OBSERVATION
|
|
- EXCEPTION
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.FindingKind
|
|
|
|
FindingStatus:
|
|
type: string
|
|
enum:
|
|
- OPEN
|
|
- IN_PROGRESS
|
|
- CLOSED
|
|
- RISK_ACCEPTED
|
|
- MITIGATED
|
|
- FALSE_POSITIVE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.FindingStatus
|
|
|
|
FindingPriority:
|
|
type: string
|
|
enum:
|
|
- LOW
|
|
- MEDIUM
|
|
- HIGH
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.FindingPriority
|
|
|
|
FindingOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- REFERENCE_ID
|
|
- DATE_IDENTIFIED
|
|
- DUE_DATE
|
|
- STATUS
|
|
- PRIORITY
|
|
- KIND
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.FindingOrderField
|
|
|
|
FindingOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/FindingOrderField"
|
|
description: Finding order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Finding order direction
|
|
|
|
Finding:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- kind
|
|
- reference_id
|
|
- status
|
|
- priority
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Finding ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
kind:
|
|
$ref: "#/components/schemas/FindingKind"
|
|
description: Finding kind
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Description
|
|
source:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Source
|
|
identified_on:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Identified on
|
|
root_cause:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Root cause
|
|
corrective_action:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Corrective action
|
|
owner_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
due_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Due date
|
|
status:
|
|
$ref: "#/components/schemas/FindingStatus"
|
|
description: Status
|
|
priority:
|
|
$ref: "#/components/schemas/FindingPriority"
|
|
description: Priority
|
|
risk_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
- type: "null"
|
|
description: No risk
|
|
description: Risk ID
|
|
effectiveness_check:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Effectiveness check
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListFindingsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/FindingOrderBy"
|
|
description: Finding order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
kind:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/FindingKind"
|
|
- type: "null"
|
|
description: Filter by finding kind (MINOR_NONCONFORMITY, MAJOR_NONCONFORMITY, OBSERVATION, EXCEPTION). Defaults to null which returns all kinds.
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/FindingStatus"
|
|
- type: "null"
|
|
description: Filter by finding status (OPEN, IN_PROGRESS, CLOSED, RISK_ACCEPTED, MITIGATED, FALSE_POSITIVE). Defaults to null which returns all statuses.
|
|
priority:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/FindingPriority"
|
|
- type: "null"
|
|
description: Filter by finding priority (LOW, MEDIUM, HIGH). Defaults to null which returns all priorities.
|
|
owner_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Filter by owner profile ID. Defaults to null which returns all owners.
|
|
|
|
ListFindingsOutput:
|
|
type: object
|
|
required:
|
|
- findings
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
findings:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Finding"
|
|
|
|
GetFindingInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Finding ID
|
|
|
|
GetFindingOutput:
|
|
type: object
|
|
required:
|
|
- finding
|
|
properties:
|
|
finding:
|
|
$ref: "#/components/schemas/Finding"
|
|
|
|
AddFindingInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- kind
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
kind:
|
|
$ref: "#/components/schemas/FindingKind"
|
|
description: Finding kind
|
|
description:
|
|
type: string
|
|
description: Description
|
|
source:
|
|
type: string
|
|
description: Source
|
|
identified_on:
|
|
type: string
|
|
format: date-time
|
|
description: Identified on
|
|
root_cause:
|
|
type: string
|
|
description: Root cause
|
|
corrective_action:
|
|
type: string
|
|
description: Corrective action
|
|
owner_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
due_date:
|
|
type: string
|
|
format: date-time
|
|
description: Due date
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/FindingStatus"
|
|
description: Finding status
|
|
- type: "null"
|
|
description: No status
|
|
description: Status
|
|
priority:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/FindingPriority"
|
|
description: Finding priority
|
|
- type: "null"
|
|
description: No priority
|
|
description: Priority
|
|
risk_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
- type: "null"
|
|
description: No risk
|
|
description: Risk ID
|
|
effectiveness_check:
|
|
type: string
|
|
description: Effectiveness check
|
|
|
|
AddFindingOutput:
|
|
type: object
|
|
required:
|
|
- finding
|
|
properties:
|
|
finding:
|
|
$ref: "#/components/schemas/Finding"
|
|
|
|
UpdateFindingInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Finding ID
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
source:
|
|
type: ["string", "null"]
|
|
description: Source
|
|
go.probo.inc/mcpgen/omittable: true
|
|
identified_on:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Identified on
|
|
go.probo.inc/mcpgen/omittable: true
|
|
root_cause:
|
|
type: ["string", "null"]
|
|
description: Root cause
|
|
go.probo.inc/mcpgen/omittable: true
|
|
corrective_action:
|
|
type: ["string", "null"]
|
|
description: Corrective action
|
|
go.probo.inc/mcpgen/omittable: true
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
due_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Due date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
status:
|
|
$ref: "#/components/schemas/FindingStatus"
|
|
description: Status
|
|
priority:
|
|
$ref: "#/components/schemas/FindingPriority"
|
|
description: Priority
|
|
risk_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Risk ID
|
|
go.probo.inc/mcpgen/omittable: true
|
|
effectiveness_check:
|
|
type: ["string", "null"]
|
|
description: Effectiveness check
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateFindingOutput:
|
|
type: object
|
|
required:
|
|
- finding
|
|
properties:
|
|
finding:
|
|
$ref: "#/components/schemas/Finding"
|
|
|
|
DeleteFindingInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Finding ID
|
|
|
|
DeleteFindingOutput:
|
|
type: object
|
|
required:
|
|
- deleted_finding_id
|
|
properties:
|
|
deleted_finding_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted finding ID
|
|
|
|
LinkFindingAuditInput:
|
|
type: object
|
|
required:
|
|
- finding_id
|
|
- audit_id
|
|
- reference_id
|
|
properties:
|
|
finding_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Finding ID
|
|
audit_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID for the finding within this audit
|
|
|
|
LinkFindingAuditOutput:
|
|
type: object
|
|
required:
|
|
- finding
|
|
- audit
|
|
properties:
|
|
finding:
|
|
$ref: "#/components/schemas/Finding"
|
|
audit:
|
|
$ref: "#/components/schemas/Audit"
|
|
|
|
UnlinkFindingAuditInput:
|
|
type: object
|
|
required:
|
|
- finding_id
|
|
- audit_id
|
|
properties:
|
|
finding_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Finding ID
|
|
audit_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
|
|
UnlinkFindingAuditOutput:
|
|
type: object
|
|
required:
|
|
- deleted_finding_id
|
|
- deleted_audit_id
|
|
properties:
|
|
deleted_finding_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted finding ID
|
|
deleted_audit_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted audit ID
|
|
|
|
ListFindingAuditsInput:
|
|
type: object
|
|
required:
|
|
- finding_id
|
|
properties:
|
|
finding_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Finding ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/AuditOrderBy"
|
|
description: Audit order by
|
|
|
|
ListFindingAuditsOutput:
|
|
type: object
|
|
required:
|
|
- audits
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
audits:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Audit"
|
|
|
|
ObligationStatus:
|
|
type: string
|
|
enum:
|
|
- NON_COMPLIANT
|
|
- PARTIALLY_COMPLIANT
|
|
- COMPLIANT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ObligationStatus
|
|
|
|
ObligationType:
|
|
type: string
|
|
enum:
|
|
- LEGAL
|
|
- CONTRACTUAL
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ObligationType
|
|
|
|
ObligationOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- LAST_REVIEW_DATE
|
|
- DUE_DATE
|
|
- STATUS
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ObligationOrderField
|
|
|
|
ObligationOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ObligationOrderField"
|
|
description: Obligation order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Obligation order direction
|
|
|
|
Obligation:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- owner_id
|
|
- status
|
|
- type
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Obligation ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
area:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Area
|
|
source:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Source
|
|
requirement:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Requirement
|
|
actions_to_be_implemented:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Actions to be implemented
|
|
regulator:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Regulator
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
last_review_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Last review date
|
|
due_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Due date
|
|
status:
|
|
$ref: "#/components/schemas/ObligationStatus"
|
|
description: Status
|
|
type:
|
|
$ref: "#/components/schemas/ObligationType"
|
|
description: Type
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListObligationsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ObligationOrderBy"
|
|
description: Obligation order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
ListObligationsOutput:
|
|
type: object
|
|
required:
|
|
- obligations
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
obligations:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
GetObligationInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Obligation ID
|
|
|
|
GetObligationOutput:
|
|
type: object
|
|
required:
|
|
- obligation
|
|
properties:
|
|
obligation:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
AddObligationInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- owner_id
|
|
- status
|
|
- type
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
area:
|
|
type: string
|
|
description: Area
|
|
source:
|
|
type: string
|
|
description: Source
|
|
requirement:
|
|
type: string
|
|
description: Requirement
|
|
actions_to_be_implemented:
|
|
type: string
|
|
description: Actions to be implemented
|
|
regulator:
|
|
type: string
|
|
description: Regulator
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
last_review_date:
|
|
type: string
|
|
format: date-time
|
|
description: Last review date
|
|
due_date:
|
|
type: string
|
|
format: date-time
|
|
description: Due date
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ObligationStatus"
|
|
description: Obligation status
|
|
- type: "null"
|
|
description: No status
|
|
description: Status
|
|
type:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ObligationType"
|
|
description: Obligation type
|
|
- type: "null"
|
|
description: No type
|
|
description: Type
|
|
|
|
AddObligationOutput:
|
|
type: object
|
|
required:
|
|
- obligation
|
|
properties:
|
|
obligation:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
UpdateObligationInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Obligation ID
|
|
area:
|
|
type: ["string", "null"]
|
|
description: Area
|
|
go.probo.inc/mcpgen/omittable: true
|
|
source:
|
|
type: ["string", "null"]
|
|
description: Source
|
|
go.probo.inc/mcpgen/omittable: true
|
|
requirement:
|
|
type: ["string", "null"]
|
|
description: Requirement
|
|
go.probo.inc/mcpgen/omittable: true
|
|
actions_to_be_implemented:
|
|
type: ["string", "null"]
|
|
description: Actions to be implemented
|
|
go.probo.inc/mcpgen/omittable: true
|
|
regulator:
|
|
type: ["string", "null"]
|
|
description: Regulator
|
|
go.probo.inc/mcpgen/omittable: true
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
last_review_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Last review date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
due_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Due date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ObligationStatus"
|
|
description: Obligation status
|
|
- type: "null"
|
|
description: No status
|
|
description: Status
|
|
type:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ObligationType"
|
|
description: Obligation type
|
|
- type: "null"
|
|
description: No type
|
|
description: Type
|
|
|
|
UpdateObligationOutput:
|
|
type: object
|
|
required:
|
|
- obligation
|
|
properties:
|
|
obligation:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
DeleteObligationInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Obligation ID
|
|
|
|
DeleteObligationOutput:
|
|
type: object
|
|
required:
|
|
- deleted_obligation_id
|
|
properties:
|
|
deleted_obligation_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted obligation ID
|
|
|
|
ProcessingActivityRole:
|
|
type: string
|
|
enum:
|
|
- CONTROLLER
|
|
- PROCESSOR
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProcessingActivityRole
|
|
|
|
ProcessingActivityLawfulBasis:
|
|
type: string
|
|
enum:
|
|
- LEGITIMATE_INTEREST
|
|
- CONSENT
|
|
- CONTRACTUAL_NECESSITY
|
|
- LEGAL_OBLIGATION
|
|
- VITAL_INTERESTS
|
|
- PUBLIC_TASK
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProcessingActivityLawfulBasis
|
|
|
|
ProcessingActivitySpecialOrCriminalDatum:
|
|
type: string
|
|
enum:
|
|
- YES
|
|
- NO
|
|
- POSSIBLE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProcessingActivitySpecialOrCriminalDatum
|
|
|
|
ProcessingActivityTransferSafeguard:
|
|
type: string
|
|
enum:
|
|
- STANDARD_CONTRACTUAL_CLAUSES
|
|
- BINDING_CORPORATE_RULES
|
|
- ADEQUACY_DECISION
|
|
- DEROGATIONS
|
|
- CODES_OF_CONDUCT
|
|
- CERTIFICATION_MECHANISMS
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProcessingActivityTransferSafeguard
|
|
|
|
ProcessingActivityDataProtectionImpactAssessmentNeeded:
|
|
type: string
|
|
enum:
|
|
- NEEDED
|
|
- NOT_NEEDED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProcessingActivityDataProtectionImpactAssessment
|
|
|
|
ProcessingActivityTransferImpactAssessmentNeeded:
|
|
type: string
|
|
enum:
|
|
- NEEDED
|
|
- NOT_NEEDED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProcessingActivityTransferImpactAssessment
|
|
|
|
ProcessingActivityOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ProcessingActivityOrderField
|
|
|
|
ProcessingActivityOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ProcessingActivityOrderField"
|
|
description: Processing activity order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
ProcessingActivity:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- special_or_criminal_data
|
|
- lawful_basis
|
|
- international_transfers
|
|
- data_protection_impact_assessment_needed
|
|
- transfer_impact_assessment_needed
|
|
- role
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Processing activity ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Name
|
|
purpose:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Purpose
|
|
data_subject_category:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Data subject category
|
|
personal_data_category:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Personal data category
|
|
special_or_criminal_data:
|
|
$ref: "#/components/schemas/ProcessingActivitySpecialOrCriminalDatum"
|
|
description: Special or criminal data
|
|
consent_evidence_link:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Consent evidence link
|
|
lawful_basis:
|
|
$ref: "#/components/schemas/ProcessingActivityLawfulBasis"
|
|
description: Lawful basis
|
|
recipients:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Recipients
|
|
location:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Location
|
|
international_transfers:
|
|
type: boolean
|
|
description: International transfers
|
|
transfer_safeguard:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ProcessingActivityTransferSafeguard"
|
|
- type: "null"
|
|
description: Transfer safeguard
|
|
retention_period:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Retention period
|
|
security_measures:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Security measures
|
|
data_protection_impact_assessment_needed:
|
|
$ref: "#/components/schemas/ProcessingActivityDataProtectionImpactAssessmentNeeded"
|
|
description: DPIA needed
|
|
transfer_impact_assessment_needed:
|
|
$ref: "#/components/schemas/ProcessingActivityTransferImpactAssessmentNeeded"
|
|
description: TIA needed
|
|
last_review_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Last review date
|
|
next_review_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Next review date
|
|
role:
|
|
$ref: "#/components/schemas/ProcessingActivityRole"
|
|
description: Role
|
|
data_protection_officer_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Data protection officer profile ID
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListProcessingActivitiesInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ProcessingActivityOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListProcessingActivitiesOutput:
|
|
type: object
|
|
required:
|
|
- processing_activities
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
processing_activities:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ProcessingActivity"
|
|
|
|
GetProcessingActivityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Processing activity ID
|
|
|
|
GetProcessingActivityOutput:
|
|
type: object
|
|
required:
|
|
- processing_activity
|
|
properties:
|
|
processing_activity:
|
|
$ref: "#/components/schemas/ProcessingActivity"
|
|
|
|
AddProcessingActivityInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- special_or_criminal_data
|
|
- lawful_basis
|
|
- international_transfers
|
|
- data_protection_impact_assessment_needed
|
|
- transfer_impact_assessment_needed
|
|
- role
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Name
|
|
purpose:
|
|
type: string
|
|
description: Purpose
|
|
data_subject_category:
|
|
type: string
|
|
description: Data subject category
|
|
personal_data_category:
|
|
type: string
|
|
description: Personal data category
|
|
special_or_criminal_data:
|
|
$ref: "#/components/schemas/ProcessingActivitySpecialOrCriminalDatum"
|
|
description: Special or criminal data
|
|
consent_evidence_link:
|
|
type: string
|
|
description: Consent evidence link
|
|
lawful_basis:
|
|
$ref: "#/components/schemas/ProcessingActivityLawfulBasis"
|
|
description: Lawful basis
|
|
recipients:
|
|
type: string
|
|
description: Recipients
|
|
location:
|
|
type: string
|
|
description: Location
|
|
international_transfers:
|
|
type: boolean
|
|
description: International transfers
|
|
transfer_safeguard:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ProcessingActivityTransferSafeguard"
|
|
- type: "null"
|
|
description: Transfer safeguard
|
|
retention_period:
|
|
type: string
|
|
description: Retention period
|
|
security_measures:
|
|
type: string
|
|
description: Security measures
|
|
data_protection_impact_assessment_needed:
|
|
$ref: "#/components/schemas/ProcessingActivityDataProtectionImpactAssessmentNeeded"
|
|
description: DPIA needed
|
|
transfer_impact_assessment_needed:
|
|
$ref: "#/components/schemas/ProcessingActivityTransferImpactAssessmentNeeded"
|
|
description: TIA needed
|
|
last_review_date:
|
|
type: string
|
|
format: date-time
|
|
description: Last review date
|
|
next_review_date:
|
|
type: string
|
|
format: date-time
|
|
description: Next review date
|
|
role:
|
|
$ref: "#/components/schemas/ProcessingActivityRole"
|
|
description: Role
|
|
data_protection_officer_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Data protection officer profile ID
|
|
third_party_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ThirdParty IDs
|
|
|
|
AddProcessingActivityOutput:
|
|
type: object
|
|
required:
|
|
- processing_activity
|
|
properties:
|
|
processing_activity:
|
|
$ref: "#/components/schemas/ProcessingActivity"
|
|
|
|
UpdateProcessingActivityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Processing activity ID
|
|
name:
|
|
type: string
|
|
purpose:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
data_subject_category:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
personal_data_category:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
special_or_criminal_data:
|
|
$ref: "#/components/schemas/ProcessingActivitySpecialOrCriminalDatum"
|
|
consent_evidence_link:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
lawful_basis:
|
|
$ref: "#/components/schemas/ProcessingActivityLawfulBasis"
|
|
recipients:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
location:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
international_transfers:
|
|
type: boolean
|
|
transfer_safeguard:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ProcessingActivityTransferSafeguard"
|
|
- type: "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
retention_period:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
security_measures:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
data_protection_impact_assessment_needed:
|
|
$ref: "#/components/schemas/ProcessingActivityDataProtectionImpactAssessmentNeeded"
|
|
transfer_impact_assessment_needed:
|
|
$ref: "#/components/schemas/ProcessingActivityTransferImpactAssessmentNeeded"
|
|
last_review_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
go.probo.inc/mcpgen/omittable: true
|
|
next_review_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
go.probo.inc/mcpgen/omittable: true
|
|
role:
|
|
$ref: "#/components/schemas/ProcessingActivityRole"
|
|
data_protection_officer_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
third_party_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
UpdateProcessingActivityOutput:
|
|
type: object
|
|
required:
|
|
- processing_activity
|
|
properties:
|
|
processing_activity:
|
|
$ref: "#/components/schemas/ProcessingActivity"
|
|
|
|
DeleteProcessingActivityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Processing activity ID
|
|
|
|
DeleteProcessingActivityOutput:
|
|
type: object
|
|
required:
|
|
- deleted_processing_activity_id
|
|
properties:
|
|
deleted_processing_activity_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted processing activity ID
|
|
|
|
DataProtectionImpactAssessmentResidualRisk:
|
|
type: string
|
|
enum:
|
|
- LOW
|
|
- MEDIUM
|
|
- HIGH
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DataProtectionImpactAssessmentResidualRisk
|
|
|
|
DataProtectionImpactAssessmentOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DataProtectionImpactAssessmentOrderField
|
|
|
|
DataProtectionImpactAssessmentOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/DataProtectionImpactAssessmentOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
DataProtectionImpactAssessment:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- processing_activity_id
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
processing_activity_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
necessity_and_proportionality:
|
|
type:
|
|
- string
|
|
- "null"
|
|
potential_risk:
|
|
type:
|
|
- string
|
|
- "null"
|
|
mitigations:
|
|
type:
|
|
- string
|
|
- "null"
|
|
residual_risk:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/DataProtectionImpactAssessmentResidualRisk"
|
|
- type: "null"
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
ListDataProtectionImpactAssessmentsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
order_by:
|
|
$ref: "#/components/schemas/DataProtectionImpactAssessmentOrderBy"
|
|
size:
|
|
type: integer
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
|
|
ListDataProtectionImpactAssessmentsOutput:
|
|
type: object
|
|
required:
|
|
- data_protection_impact_assessments
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
data_protection_impact_assessments:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DataProtectionImpactAssessment"
|
|
|
|
GetDataProtectionImpactAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
GetDataProtectionImpactAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- data_protection_impact_assessment
|
|
properties:
|
|
data_protection_impact_assessment:
|
|
$ref: "#/components/schemas/DataProtectionImpactAssessment"
|
|
|
|
AddDataProtectionImpactAssessmentInput:
|
|
type: object
|
|
required:
|
|
- processing_activity_id
|
|
properties:
|
|
processing_activity_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description:
|
|
type: string
|
|
necessity_and_proportionality:
|
|
type: string
|
|
potential_risk:
|
|
type: string
|
|
mitigations:
|
|
type: string
|
|
residual_risk:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/DataProtectionImpactAssessmentResidualRisk"
|
|
- type: "null"
|
|
|
|
AddDataProtectionImpactAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- data_protection_impact_assessment
|
|
properties:
|
|
data_protection_impact_assessment:
|
|
$ref: "#/components/schemas/DataProtectionImpactAssessment"
|
|
|
|
UpdateDataProtectionImpactAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
necessity_and_proportionality:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
potential_risk:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
mitigations:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
residual_risk:
|
|
$ref: "#/components/schemas/DataProtectionImpactAssessmentResidualRisk"
|
|
|
|
UpdateDataProtectionImpactAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- data_protection_impact_assessment
|
|
properties:
|
|
data_protection_impact_assessment:
|
|
$ref: "#/components/schemas/DataProtectionImpactAssessment"
|
|
|
|
DeleteDataProtectionImpactAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
DeleteDataProtectionImpactAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- deleted_data_protection_impact_assessment_id
|
|
properties:
|
|
deleted_data_protection_impact_assessment_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
TransferImpactAssessmentOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.TransferImpactAssessmentOrderField
|
|
|
|
TransferImpactAssessmentOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/TransferImpactAssessmentOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
TransferImpactAssessment:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- processing_activity_id
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
processing_activity_id:
|
|
$ref: "#/components/schemas/GID"
|
|
data_subjects:
|
|
type:
|
|
- string
|
|
- "null"
|
|
legal_mechanism:
|
|
type:
|
|
- string
|
|
- "null"
|
|
transfer:
|
|
type:
|
|
- string
|
|
- "null"
|
|
local_law_risk:
|
|
type:
|
|
- string
|
|
- "null"
|
|
supplementary_measures:
|
|
type:
|
|
- string
|
|
- "null"
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
ListTransferImpactAssessmentsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
order_by:
|
|
$ref: "#/components/schemas/TransferImpactAssessmentOrderBy"
|
|
size:
|
|
type: integer
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
|
|
ListTransferImpactAssessmentsOutput:
|
|
type: object
|
|
required:
|
|
- transfer_impact_assessments
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
transfer_impact_assessments:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/TransferImpactAssessment"
|
|
|
|
GetTransferImpactAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
GetTransferImpactAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- transfer_impact_assessment
|
|
properties:
|
|
transfer_impact_assessment:
|
|
$ref: "#/components/schemas/TransferImpactAssessment"
|
|
|
|
AddTransferImpactAssessmentInput:
|
|
type: object
|
|
required:
|
|
- processing_activity_id
|
|
properties:
|
|
processing_activity_id:
|
|
$ref: "#/components/schemas/GID"
|
|
data_subjects:
|
|
type: string
|
|
legal_mechanism:
|
|
type: string
|
|
transfer:
|
|
type: string
|
|
local_law_risk:
|
|
type: string
|
|
supplementary_measures:
|
|
type: string
|
|
|
|
AddTransferImpactAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- transfer_impact_assessment
|
|
properties:
|
|
transfer_impact_assessment:
|
|
$ref: "#/components/schemas/TransferImpactAssessment"
|
|
|
|
UpdateTransferImpactAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
data_subjects:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
legal_mechanism:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
transfer:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
local_law_risk:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
supplementary_measures:
|
|
type: ["string", "null"]
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateTransferImpactAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- transfer_impact_assessment
|
|
properties:
|
|
transfer_impact_assessment:
|
|
$ref: "#/components/schemas/TransferImpactAssessment"
|
|
|
|
DeleteTransferImpactAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
DeleteTransferImpactAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- deleted_transfer_impact_assessment_id
|
|
properties:
|
|
deleted_transfer_impact_assessment_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
|
|
AuditState:
|
|
type: string
|
|
enum:
|
|
- NOT_STARTED
|
|
- IN_PROGRESS
|
|
- COMPLETED
|
|
- REJECTED
|
|
- OUTDATED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AuditState
|
|
|
|
CompliancePortalVisibility:
|
|
type: string
|
|
enum:
|
|
- NONE
|
|
- PRIVATE
|
|
- PUBLIC
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.CompliancePortalVisibility
|
|
|
|
AuditOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- VALID_FROM
|
|
- VALID_UNTIL
|
|
- AUDIT_START_DATE
|
|
- AUDIT_END_DATE
|
|
- STATE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AuditOrderField
|
|
|
|
AuditOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/AuditOrderField"
|
|
description: Audit order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Audit order direction
|
|
|
|
Audit:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- framework_id
|
|
- state
|
|
- compliance_portal_visibility
|
|
- has_report
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
framework_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Audit name
|
|
valid_from:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Valid from date
|
|
valid_until:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Valid until date
|
|
audit_start_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Audit start date
|
|
audit_end_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Audit end date
|
|
state:
|
|
$ref: "#/components/schemas/AuditState"
|
|
description: Audit state
|
|
compliance_portal_visibility:
|
|
$ref: "#/components/schemas/CompliancePortalVisibility"
|
|
description: Compliance portal visibility
|
|
has_report:
|
|
type: boolean
|
|
description: Whether the audit has an attached report
|
|
report_filename:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Report filename, null if no report attached
|
|
report_mime_type:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Report MIME type, null if no report attached
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
GetAuditReportUrlInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
|
|
GetAuditReportUrlOutput:
|
|
type: object
|
|
required:
|
|
- url
|
|
properties:
|
|
url:
|
|
type: string
|
|
description: Presigned download URL for the report (valid for 15 minutes)
|
|
|
|
ListAuditsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/AuditOrderBy"
|
|
description: Audit order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListAuditsOutput:
|
|
type: object
|
|
required:
|
|
- audits
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
audits:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Audit"
|
|
|
|
GetAuditInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
|
|
GetAuditOutput:
|
|
type: object
|
|
required:
|
|
- audit
|
|
properties:
|
|
audit:
|
|
$ref: "#/components/schemas/Audit"
|
|
|
|
AddAuditInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- framework_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
framework_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
name:
|
|
type: string
|
|
description: Audit name
|
|
valid_from:
|
|
type: string
|
|
format: date-time
|
|
description: Valid from date
|
|
valid_until:
|
|
type: string
|
|
format: date-time
|
|
description: Valid until date
|
|
audit_start_date:
|
|
type: string
|
|
format: date-time
|
|
description: Audit start date
|
|
audit_end_date:
|
|
type: string
|
|
format: date-time
|
|
description: Audit end date
|
|
state:
|
|
$ref: "#/components/schemas/AuditState"
|
|
description: Audit state
|
|
|
|
AddAuditOutput:
|
|
type: object
|
|
required:
|
|
- audit
|
|
properties:
|
|
audit:
|
|
$ref: "#/components/schemas/Audit"
|
|
|
|
UpdateAuditInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
name:
|
|
type: ["string", "null"]
|
|
description: Audit name
|
|
go.probo.inc/mcpgen/omittable: true
|
|
valid_from:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Valid from date
|
|
valid_until:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Valid until date
|
|
audit_start_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Audit start date
|
|
audit_end_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Audit end date
|
|
state:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/AuditState"
|
|
description: Audit state
|
|
- type: "null"
|
|
description: No state
|
|
description: Audit state
|
|
compliance_portal_visibility:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/CompliancePortalVisibility"
|
|
description: Compliance portal visibility
|
|
- type: "null"
|
|
description: No compliance portal visibility
|
|
description: Compliance portal visibility
|
|
|
|
UpdateAuditOutput:
|
|
type: object
|
|
required:
|
|
- audit
|
|
properties:
|
|
audit:
|
|
$ref: "#/components/schemas/Audit"
|
|
|
|
DeleteAuditInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
|
|
DeleteAuditOutput:
|
|
type: object
|
|
required:
|
|
- deleted_audit_id
|
|
properties:
|
|
deleted_audit_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted audit ID
|
|
|
|
ControlOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- SECTION_TITLE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ControlOrderField
|
|
|
|
ControlOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ControlOrderField"
|
|
description: Control order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Control order direction
|
|
|
|
Control:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- framework_id
|
|
- section_title
|
|
- name
|
|
- best_practice
|
|
- maturity_level
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
framework_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
section_title:
|
|
type: string
|
|
description: Section title
|
|
name:
|
|
type: string
|
|
description: Control name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Control description
|
|
best_practice:
|
|
type: boolean
|
|
description: Whether control is a best practice
|
|
maturity_level:
|
|
type: string
|
|
enum: [NONE, INITIAL, MANAGED, DEFINED, QUANTITATIVELY_MANAGED, OPTIMIZING]
|
|
description: CMMI 0-5 maturity level of the control
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ControlMaturityLevel
|
|
not_implemented_justification:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Justification for non-implementation
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListControlsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ControlOrderBy"
|
|
description: Control order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: Search query
|
|
framework_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID to filter controls by
|
|
|
|
ListControlsOutput:
|
|
type: object
|
|
required:
|
|
- controls
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
controls:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Control"
|
|
|
|
GetControlInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
|
|
GetControlOutput:
|
|
type: object
|
|
required:
|
|
- control
|
|
properties:
|
|
control:
|
|
$ref: "#/components/schemas/Control"
|
|
|
|
AddControlInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- framework_id
|
|
- section_title
|
|
- name
|
|
- best_practice
|
|
- maturity_level
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
framework_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
section_title:
|
|
type: string
|
|
description: Section title
|
|
name:
|
|
type: string
|
|
description: Control name
|
|
description:
|
|
type: string
|
|
description: Control description
|
|
best_practice:
|
|
type: boolean
|
|
description: Whether control is a best practice
|
|
maturity_level:
|
|
type: string
|
|
enum: [NONE, INITIAL, MANAGED, DEFINED, QUANTITATIVELY_MANAGED, OPTIMIZING]
|
|
description: CMMI 0-5 maturity level of the control
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ControlMaturityLevel
|
|
not_implemented_justification:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Justification for non-implementation
|
|
|
|
AddControlOutput:
|
|
type: object
|
|
required:
|
|
- control
|
|
properties:
|
|
control:
|
|
$ref: "#/components/schemas/Control"
|
|
|
|
UpdateControlInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
section_title:
|
|
type: string
|
|
description: Section title
|
|
name:
|
|
type: string
|
|
description: Control name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Control description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
best_practice:
|
|
type: boolean
|
|
description: Whether control is a best practice
|
|
maturity_level:
|
|
type: string
|
|
enum: [NONE, INITIAL, MANAGED, DEFINED, QUANTITATIVELY_MANAGED, OPTIMIZING]
|
|
description: CMMI 0-5 maturity level of the control
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ControlMaturityLevel
|
|
not_implemented_justification:
|
|
type: ["string", "null"]
|
|
description: Justification for non-implementation
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateControlOutput:
|
|
type: object
|
|
required:
|
|
- control
|
|
properties:
|
|
control:
|
|
$ref: "#/components/schemas/Control"
|
|
|
|
LinkControlInput:
|
|
type: object
|
|
required:
|
|
- control_id
|
|
- resource_id
|
|
properties:
|
|
control_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the resource to link (measure, document, audit, or obligation)
|
|
|
|
LinkControlOutput:
|
|
type: object
|
|
|
|
UnlinkControlInput:
|
|
type: object
|
|
required:
|
|
- control_id
|
|
- resource_id
|
|
properties:
|
|
control_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the resource to unlink (measure, document, audit, or obligation)
|
|
|
|
UnlinkControlOutput:
|
|
type: object
|
|
|
|
ListControlObligationsInput:
|
|
type: object
|
|
required:
|
|
- control_id
|
|
properties:
|
|
control_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/ObligationOrderBy"
|
|
description: Obligation order by
|
|
|
|
ListControlObligationsOutput:
|
|
type: object
|
|
required:
|
|
- obligations
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
obligations:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
ListControlMeasuresInput:
|
|
type: object
|
|
required:
|
|
- control_id
|
|
properties:
|
|
control_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/MeasureOrderBy"
|
|
description: Measure order by
|
|
|
|
ListControlMeasuresOutput:
|
|
type: object
|
|
required:
|
|
- measures
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
measures:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
ListControlDocumentsInput:
|
|
type: object
|
|
required:
|
|
- control_id
|
|
properties:
|
|
control_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/DocumentOrderBy"
|
|
description: Document order by
|
|
|
|
ListControlDocumentsOutput:
|
|
type: object
|
|
required:
|
|
- documents
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
documents:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Document"
|
|
|
|
ListControlAuditsInput:
|
|
type: object
|
|
required:
|
|
- control_id
|
|
properties:
|
|
control_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/AuditOrderBy"
|
|
description: Audit order by
|
|
|
|
ListControlAuditsOutput:
|
|
type: object
|
|
required:
|
|
- audits
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
audits:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Audit"
|
|
|
|
ListRiskObligationsInput:
|
|
type: object
|
|
required:
|
|
- risk_id
|
|
properties:
|
|
risk_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
order_by:
|
|
$ref: "#/components/schemas/ObligationOrderBy"
|
|
description: Obligation order by
|
|
|
|
ListRiskObligationsOutput:
|
|
type: object
|
|
required:
|
|
- obligations
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
obligations:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
LinkRiskInput:
|
|
type: object
|
|
required:
|
|
- risk_id
|
|
- resource_id
|
|
properties:
|
|
risk_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the resource to link (document, measure, or obligation)
|
|
|
|
LinkRiskOutput:
|
|
type: object
|
|
|
|
UnlinkRiskInput:
|
|
type: object
|
|
required:
|
|
- risk_id
|
|
- resource_id
|
|
properties:
|
|
risk_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the resource to unlink (document, measure, or obligation)
|
|
|
|
UnlinkRiskOutput:
|
|
type: object
|
|
|
|
TaskState:
|
|
type: string
|
|
enum:
|
|
- TODO
|
|
- IN_PROGRESS
|
|
- DONE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.TaskState
|
|
|
|
TaskOrderField:
|
|
type: string
|
|
enum:
|
|
- PRIORITY_RANK
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.TaskOrderField
|
|
|
|
TaskOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/TaskOrderField"
|
|
description: Task order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Task order direction
|
|
|
|
TaskPriority:
|
|
type: string
|
|
enum:
|
|
- URGENT
|
|
- HIGH
|
|
- MEDIUM
|
|
- LOW
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.TaskPriority
|
|
|
|
Task:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- state
|
|
- priority
|
|
- rank
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Task ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
measure_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
- type: "null"
|
|
description: No measure
|
|
description: Measure ID
|
|
name:
|
|
type: string
|
|
description: Task name
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
description: Task description
|
|
- type: "null"
|
|
description: No description
|
|
description: Task description
|
|
state:
|
|
$ref: "#/components/schemas/TaskState"
|
|
description: Task state
|
|
priority:
|
|
$ref: "#/components/schemas/TaskPriority"
|
|
description: Task priority level
|
|
rank:
|
|
type: integer
|
|
description: Task rank within state
|
|
time_estimate:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/Duration"
|
|
- type: "null"
|
|
description: No time estimate
|
|
description: Time estimate
|
|
deadline:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
description: Deadline
|
|
- type: "null"
|
|
description: No deadline
|
|
description: Deadline
|
|
assigned_to_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Assigned to person ID
|
|
- type: "null"
|
|
description: Not assigned
|
|
description: Assigned to person ID
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListTasksInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
measure_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
order_by:
|
|
$ref: "#/components/schemas/TaskOrderBy"
|
|
description: Task order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListTasksOutput:
|
|
type: object
|
|
required:
|
|
- tasks
|
|
properties:
|
|
tasks:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Task"
|
|
description: List of tasks
|
|
next_cursor:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/CursorKey"
|
|
- type: "null"
|
|
description: Next page cursor
|
|
|
|
GetTaskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Task ID
|
|
|
|
GetTaskOutput:
|
|
type: object
|
|
required:
|
|
- task
|
|
properties:
|
|
task:
|
|
$ref: "#/components/schemas/Task"
|
|
|
|
AddTaskInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
measure_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
- type: "null"
|
|
description: No measure
|
|
description: Measure ID
|
|
name:
|
|
type: string
|
|
description: Task name
|
|
description:
|
|
type: string
|
|
description: Task description
|
|
time_estimate:
|
|
$ref: "#/components/schemas/Duration"
|
|
description: Time estimate
|
|
deadline:
|
|
type: string
|
|
format: date-time
|
|
description: Deadline
|
|
assigned_to_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Assigned to person ID
|
|
- type: "null"
|
|
description: Not assigned
|
|
description: Assigned to person ID
|
|
priority:
|
|
$ref: "#/components/schemas/TaskPriority"
|
|
description: Task priority level (defaults to MEDIUM if not specified)
|
|
default: MEDIUM
|
|
|
|
AddTaskOutput:
|
|
type: object
|
|
required:
|
|
- task
|
|
properties:
|
|
task:
|
|
$ref: "#/components/schemas/Task"
|
|
|
|
UpdateTaskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Task ID
|
|
name:
|
|
type: string
|
|
description: Task name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Task description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
state:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/TaskState"
|
|
description: Task state
|
|
- type: "null"
|
|
description: No state
|
|
description: Task state
|
|
priority:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/TaskPriority"
|
|
description: Task priority level
|
|
- type: "null"
|
|
description: No priority
|
|
description: Task priority level
|
|
rank:
|
|
type: integer
|
|
description: Task rank within state
|
|
time_estimate:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/Duration"
|
|
- type: "null"
|
|
description: No time estimate
|
|
description: Time estimate
|
|
go.probo.inc/mcpgen/omittable: true
|
|
deadline:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
description: Deadline
|
|
- type: "null"
|
|
description: No deadline
|
|
description: Deadline
|
|
go.probo.inc/mcpgen/omittable: true
|
|
assigned_to_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Assigned to person ID
|
|
- type: "null"
|
|
description: Not assigned
|
|
description: Assigned to person ID
|
|
go.probo.inc/mcpgen/omittable: true
|
|
measure_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
- type: "null"
|
|
description: No measure
|
|
description: Measure ID
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateTaskOutput:
|
|
type: object
|
|
required:
|
|
- task
|
|
properties:
|
|
task:
|
|
$ref: "#/components/schemas/Task"
|
|
|
|
AssignTaskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
- assigned_to_id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Task ID
|
|
assigned_to_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Assigned to person ID
|
|
|
|
AssignTaskOutput:
|
|
type: object
|
|
required:
|
|
- task
|
|
properties:
|
|
task:
|
|
$ref: "#/components/schemas/Task"
|
|
|
|
UnassignTaskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Task ID
|
|
|
|
UnassignTaskOutput:
|
|
type: object
|
|
required:
|
|
- task
|
|
properties:
|
|
task:
|
|
$ref: "#/components/schemas/Task"
|
|
|
|
DeleteTaskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Task ID
|
|
|
|
DeleteTaskOutput:
|
|
type: object
|
|
required:
|
|
- deleted_task_id
|
|
properties:
|
|
deleted_task_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted task ID
|
|
|
|
DocumentType:
|
|
type: string
|
|
enum:
|
|
- OTHER
|
|
- GOVERNANCE
|
|
- POLICY
|
|
- PROCEDURE
|
|
- PLAN
|
|
- REGISTER
|
|
- RECORD
|
|
- REPORT
|
|
- TEMPLATE
|
|
- STATEMENT_OF_APPLICABILITY
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentType
|
|
|
|
DocumentClassification:
|
|
type: string
|
|
enum:
|
|
- PUBLIC
|
|
- INTERNAL
|
|
- CONFIDENTIAL
|
|
- SECRET
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentClassification
|
|
|
|
DocumentVersionStatus:
|
|
type: string
|
|
enum:
|
|
- DRAFT
|
|
- PENDING_APPROVAL
|
|
- PUBLISHED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentVersionStatus
|
|
|
|
DocumentVersionApprovalQuorumStatus:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- APPROVED
|
|
- REJECTED
|
|
- VOIDED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentVersionApprovalQuorumStatus
|
|
|
|
DocumentVersionApprovalQuorumOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentVersionApprovalQuorumOrderField
|
|
|
|
DocumentVersionApprovalDecisionState:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- APPROVED
|
|
- REJECTED
|
|
- VOIDED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentVersionApprovalDecisionState
|
|
|
|
DocumentVersionApprovalDecisionOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentVersionApprovalDecisionOrderField
|
|
|
|
DocumentStatus:
|
|
type: string
|
|
enum:
|
|
- ACTIVE
|
|
- ARCHIVED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentStatus
|
|
|
|
DocumentWriteMode:
|
|
type: string
|
|
enum:
|
|
- AUTHORED
|
|
- GENERATED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentWriteMode
|
|
|
|
DocumentVersionSignatureState:
|
|
type: string
|
|
enum:
|
|
- REQUESTED
|
|
- SIGNED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentVersionSignatureState
|
|
|
|
DocumentOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
- TITLE
|
|
- DOCUMENT_TYPE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentOrderField
|
|
|
|
DocumentOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/DocumentOrderField"
|
|
description: Document order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Document order direction
|
|
|
|
DocumentVersionOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentVersionOrderField
|
|
|
|
DocumentVersionOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/DocumentVersionOrderField"
|
|
description: Document version order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Document version order direction
|
|
|
|
DocumentVersionSignatureOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- SIGNED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DocumentVersionSignatureOrderField
|
|
|
|
DocumentVersionSignatureOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/DocumentVersionSignatureOrderField"
|
|
description: Document version signature order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Document version signature order direction
|
|
|
|
Document:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- compliance_portal_visibility
|
|
- write_mode
|
|
- status
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
current_published_major:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Current published major version number
|
|
current_published_minor:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Current published minor version number
|
|
compliance_portal_visibility:
|
|
$ref: "#/components/schemas/CompliancePortalVisibility"
|
|
description: Compliance portal visibility
|
|
write_mode:
|
|
$ref: "#/components/schemas/DocumentWriteMode"
|
|
description: Write mode (authored or generated)
|
|
status:
|
|
$ref: "#/components/schemas/DocumentStatus"
|
|
description: Document status
|
|
archived_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Archive timestamp
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
DocumentVersion:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- document_id
|
|
- title
|
|
- major
|
|
- minor
|
|
- classification
|
|
- document_type
|
|
- content
|
|
- changelog
|
|
- status
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
title:
|
|
type: string
|
|
description: Document version title
|
|
major:
|
|
type: integer
|
|
description: Major version number
|
|
minor:
|
|
type: integer
|
|
description: Minor version number
|
|
classification:
|
|
$ref: "#/components/schemas/DocumentClassification"
|
|
description: Document classification
|
|
document_type:
|
|
$ref: "#/components/schemas/DocumentType"
|
|
description: Document type
|
|
content:
|
|
type: string
|
|
description: Document body in markdown (converted from stored ProseMirror JSON)
|
|
changelog:
|
|
type: string
|
|
description: Changelog
|
|
status:
|
|
$ref: "#/components/schemas/DocumentVersionStatus"
|
|
description: Document version status
|
|
published_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Published timestamp
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
DocumentVersionApprovalQuorum:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- version_id
|
|
- status
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Approval quorum ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version ID
|
|
status:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalQuorumStatus"
|
|
description: Approval quorum status
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
DocumentVersionApprovalDecision:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- quorum_id
|
|
- approver_id
|
|
- state
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Approval decision ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
quorum_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Approval quorum ID
|
|
approver_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Approver profile ID
|
|
state:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalDecisionState"
|
|
description: Decision state
|
|
comment:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Approval or rejection comment
|
|
decided_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Decision timestamp
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
DocumentVersionSignature:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- document_version_id
|
|
- state
|
|
- signed_by
|
|
- requested_at
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version signature ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version ID
|
|
state:
|
|
$ref: "#/components/schemas/DocumentVersionSignatureState"
|
|
description: Signature state
|
|
signed_by:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Signatory ID
|
|
signed_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Signed timestamp
|
|
requested_at:
|
|
type: string
|
|
format: date-time
|
|
description: Requested timestamp
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListDocumentsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/DocumentOrderBy"
|
|
description: Document order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: Search query
|
|
write_modes:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentWriteMode"
|
|
description: Filter by write mode (AUTHORED or GENERATED)
|
|
compliance_portal_visibilities:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/CompliancePortalVisibility"
|
|
description: Compliance portal visibilities
|
|
document_types:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentType"
|
|
description: Document types
|
|
classifications:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentClassification"
|
|
description: Document classifications
|
|
status:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentStatus"
|
|
description: Document statuses
|
|
|
|
ListDocumentsOutput:
|
|
type: object
|
|
required:
|
|
- documents
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
documents:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Document"
|
|
|
|
GetDocumentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
|
|
GetDocumentOutput:
|
|
type: object
|
|
required:
|
|
- document
|
|
properties:
|
|
document:
|
|
$ref: "#/components/schemas/Document"
|
|
|
|
AddDocumentInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- title
|
|
- content
|
|
- classification
|
|
- document_type
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
title:
|
|
type: string
|
|
description: Document title
|
|
content:
|
|
type: string
|
|
description: Document content in markdown format
|
|
classification:
|
|
$ref: "#/components/schemas/DocumentClassification"
|
|
description: Document classification
|
|
document_type:
|
|
$ref: "#/components/schemas/DocumentType"
|
|
description: Document type
|
|
compliance_portal_visibility:
|
|
$ref: "#/components/schemas/CompliancePortalVisibility"
|
|
description: Compliance portal visibility
|
|
default_approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Default approver profile IDs
|
|
|
|
AddDocumentOutput:
|
|
type: object
|
|
description: Created document and version; document_version.content is markdown
|
|
required:
|
|
- document
|
|
- document_version
|
|
properties:
|
|
document:
|
|
$ref: "#/components/schemas/Document"
|
|
document_version:
|
|
$ref: "#/components/schemas/DocumentVersion"
|
|
|
|
UpdateDocumentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
title:
|
|
type: string
|
|
description: Document title
|
|
content:
|
|
type: string
|
|
description: Document content in markdown format
|
|
classification:
|
|
$ref: "#/components/schemas/DocumentClassification"
|
|
description: Document classification
|
|
document_type:
|
|
$ref: "#/components/schemas/DocumentType"
|
|
description: Document type
|
|
compliance_portal_visibility:
|
|
$ref: "#/components/schemas/CompliancePortalVisibility"
|
|
description: Compliance portal visibility
|
|
default_approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Default approver profile IDs
|
|
|
|
UpdateDocumentOutput:
|
|
type: object
|
|
required:
|
|
- document
|
|
properties:
|
|
document:
|
|
$ref: "#/components/schemas/Document"
|
|
document_version:
|
|
$ref: "#/components/schemas/DocumentVersion"
|
|
|
|
DeleteDocumentDraftInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
|
|
DeleteDocumentDraftOutput:
|
|
type: object
|
|
required:
|
|
- document
|
|
properties:
|
|
document:
|
|
$ref: "#/components/schemas/Document"
|
|
|
|
ArchiveDocumentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
|
|
ArchiveDocumentOutput:
|
|
type: object
|
|
required:
|
|
- document
|
|
properties:
|
|
document:
|
|
$ref: "#/components/schemas/Document"
|
|
|
|
UnarchiveDocumentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
|
|
UnarchiveDocumentOutput:
|
|
type: object
|
|
required:
|
|
- document
|
|
properties:
|
|
document:
|
|
$ref: "#/components/schemas/Document"
|
|
|
|
ListDocumentVersionsInput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
order_by:
|
|
$ref: "#/components/schemas/DocumentVersionOrderBy"
|
|
description: Document version order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
statuses:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentVersionStatus"
|
|
description: Document version statuses
|
|
|
|
ListDocumentVersionsOutput:
|
|
type: object
|
|
description: Each document_versions[].content is markdown
|
|
required:
|
|
- document_versions
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
document_versions:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentVersion"
|
|
|
|
GetDocumentVersionInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version ID
|
|
|
|
GetDocumentVersionOutput:
|
|
type: object
|
|
description: document_version.content is markdown
|
|
required:
|
|
- document_version
|
|
properties:
|
|
document_version:
|
|
$ref: "#/components/schemas/DocumentVersion"
|
|
|
|
PublishDocumentInput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- minor
|
|
- changelog
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish the draft as a minor version (the document must already have a published major version). When false, publish a new major version using the document's default approvers; if the document has default approvers an approval is requested from them (they receive an email notification), otherwise the version is published directly. Configure a document's default approvers with updateDocument.
|
|
changelog:
|
|
type: string
|
|
description: Changelog for this version
|
|
|
|
PublishDocumentOutput:
|
|
type: object
|
|
description: document_version.content is markdown
|
|
required:
|
|
- document
|
|
- document_version
|
|
properties:
|
|
document:
|
|
$ref: "#/components/schemas/Document"
|
|
document_version:
|
|
$ref: "#/components/schemas/DocumentVersion"
|
|
approval_quorum:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalQuorum"
|
|
description: Set when an approval was requested from the document's default approvers instead of publishing directly.
|
|
|
|
DeleteDocumentInput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document ID
|
|
|
|
DeleteDocumentOutput:
|
|
type: object
|
|
required:
|
|
- deleted_document_id
|
|
properties:
|
|
deleted_document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted document ID
|
|
|
|
ListDocumentVersionSignaturesInput:
|
|
type: object
|
|
required:
|
|
- document_version_id
|
|
properties:
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version ID
|
|
order_by:
|
|
$ref: "#/components/schemas/DocumentVersionSignatureOrderBy"
|
|
description: Document version signature order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
states:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentVersionSignatureState"
|
|
description: Signature states
|
|
active_contract:
|
|
type: boolean
|
|
description: Signatory contract status
|
|
profile_state:
|
|
$ref: "#/components/schemas/ProfileState"
|
|
description: Signatory profile state
|
|
|
|
ListDocumentVersionSignaturesOutput:
|
|
type: object
|
|
required:
|
|
- document_version_signatures
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
document_version_signatures:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentVersionSignature"
|
|
|
|
GetDocumentVersionSignatureInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version signature ID
|
|
|
|
GetDocumentVersionSignatureOutput:
|
|
type: object
|
|
required:
|
|
- document_version_signature
|
|
properties:
|
|
document_version_signature:
|
|
$ref: "#/components/schemas/DocumentVersionSignature"
|
|
|
|
RequestDocumentVersionSignatureInput:
|
|
type: object
|
|
required:
|
|
- document_version_id
|
|
- signatory_id
|
|
properties:
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version ID
|
|
signatory_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Signatory ID (Profile ID)
|
|
|
|
RequestDocumentVersionSignatureOutput:
|
|
type: object
|
|
required:
|
|
- document_version_signature
|
|
properties:
|
|
document_version_signature:
|
|
$ref: "#/components/schemas/DocumentVersionSignature"
|
|
|
|
CancelSignatureRequestInput:
|
|
type: object
|
|
required:
|
|
- document_version_signature_id
|
|
properties:
|
|
document_version_signature_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version signature ID
|
|
|
|
CancelSignatureRequestOutput:
|
|
type: object
|
|
required:
|
|
- deleted_document_version_signature_id
|
|
properties:
|
|
deleted_document_version_signature_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted document version signature ID
|
|
|
|
VoidDocumentVersionApprovalInput:
|
|
type: object
|
|
required:
|
|
- document_version_id
|
|
properties:
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version ID
|
|
|
|
VoidDocumentVersionApprovalOutput:
|
|
type: object
|
|
required:
|
|
- document_version
|
|
properties:
|
|
document_version:
|
|
$ref: "#/components/schemas/DocumentVersion"
|
|
|
|
ListDocumentVersionApprovalQuorumsInput:
|
|
type: object
|
|
required:
|
|
- document_version_id
|
|
properties:
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document version ID
|
|
order_by:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalQuorumOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListDocumentVersionApprovalQuorumsOutput:
|
|
type: object
|
|
required:
|
|
- approval_quorums
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
approval_quorums:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalQuorum"
|
|
|
|
GetDocumentVersionApprovalQuorumInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Approval quorum ID
|
|
|
|
GetDocumentVersionApprovalQuorumOutput:
|
|
type: object
|
|
required:
|
|
- approval_quorum
|
|
properties:
|
|
approval_quorum:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalQuorum"
|
|
|
|
ListDocumentVersionApprovalDecisionsInput:
|
|
type: object
|
|
required:
|
|
- quorum_id
|
|
properties:
|
|
quorum_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Approval quorum ID
|
|
order_by:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalDecisionOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
states:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalDecisionState"
|
|
description: Filter by decision states
|
|
|
|
ListDocumentVersionApprovalDecisionsOutput:
|
|
type: object
|
|
required:
|
|
- approval_decisions
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
approval_decisions:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalDecision"
|
|
|
|
GetDocumentVersionApprovalDecisionInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Approval decision ID
|
|
|
|
GetDocumentVersionApprovalDecisionOutput:
|
|
type: object
|
|
required:
|
|
- approval_decision
|
|
properties:
|
|
approval_decision:
|
|
$ref: "#/components/schemas/DocumentVersionApprovalDecision"
|
|
|
|
WebhookEventType:
|
|
type: string
|
|
enum:
|
|
- "third-party:created"
|
|
- "third-party:updated"
|
|
- "third-party:deleted"
|
|
- "user:created"
|
|
- "user:updated"
|
|
- "user:deleted"
|
|
- "obligation:created"
|
|
- "obligation:updated"
|
|
- "obligation:deleted"
|
|
- "right-request:created"
|
|
- "right-request:updated"
|
|
- "right-request:deleted"
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.WebhookEventType
|
|
|
|
WebhookEventStatus:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- SUCCEEDED
|
|
- FAILED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.WebhookEventStatus
|
|
|
|
WebhookSubscriptionOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.WebhookSubscriptionOrderField
|
|
|
|
WebhookSubscriptionOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/WebhookSubscriptionOrderField"
|
|
description: Webhook subscription order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
WebhookEventOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.WebhookEventOrderField
|
|
|
|
WebhookEventOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/WebhookEventOrderField"
|
|
description: Webhook event order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
WebhookSubscription:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- endpoint_url
|
|
- selected_events
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Webhook subscription ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
endpoint_url:
|
|
type: string
|
|
description: The HTTPS endpoint URL that receives webhook events
|
|
selected_events:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/WebhookEventType"
|
|
description: List of event types this subscription listens to
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
WebhookEvent:
|
|
type: object
|
|
required:
|
|
- id
|
|
- webhook_subscription_id
|
|
- status
|
|
- created_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Webhook event ID
|
|
webhook_subscription_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Webhook subscription ID
|
|
status:
|
|
$ref: "#/components/schemas/WebhookEventStatus"
|
|
description: Delivery status
|
|
response:
|
|
anyOf:
|
|
- type: string
|
|
- type: "null"
|
|
description: HTTP response body from the endpoint
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
|
|
ListWebhookSubscriptionsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/WebhookSubscriptionOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListWebhookSubscriptionsOutput:
|
|
type: object
|
|
required:
|
|
- webhook_subscriptions
|
|
properties:
|
|
webhook_subscriptions:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/WebhookSubscription"
|
|
description: List of webhook subscriptions
|
|
next_cursor:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/CursorKey"
|
|
- type: "null"
|
|
description: Next page cursor
|
|
|
|
GetWebhookSubscriptionInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Webhook subscription ID
|
|
|
|
GetWebhookSubscriptionOutput:
|
|
type: object
|
|
required:
|
|
- webhook_subscription
|
|
properties:
|
|
webhook_subscription:
|
|
$ref: "#/components/schemas/WebhookSubscription"
|
|
|
|
CreateWebhookSubscriptionInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- endpoint_url
|
|
- selected_events
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
endpoint_url:
|
|
type: string
|
|
description: The HTTPS endpoint URL that receives webhook events
|
|
selected_events:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/WebhookEventType"
|
|
description: List of event types to subscribe to
|
|
|
|
CreateWebhookSubscriptionOutput:
|
|
type: object
|
|
required:
|
|
- webhook_subscription
|
|
properties:
|
|
webhook_subscription:
|
|
$ref: "#/components/schemas/WebhookSubscription"
|
|
|
|
UpdateWebhookSubscriptionInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Webhook subscription ID
|
|
endpoint_url:
|
|
type: string
|
|
description: The HTTPS endpoint URL that receives webhook events
|
|
selected_events:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/WebhookEventType"
|
|
description: List of event types to subscribe to
|
|
|
|
UpdateWebhookSubscriptionOutput:
|
|
type: object
|
|
required:
|
|
- webhook_subscription
|
|
properties:
|
|
webhook_subscription:
|
|
$ref: "#/components/schemas/WebhookSubscription"
|
|
|
|
DeleteWebhookSubscriptionInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Webhook subscription ID
|
|
|
|
DeleteWebhookSubscriptionOutput:
|
|
type: object
|
|
required:
|
|
- deleted_webhook_subscription_id
|
|
properties:
|
|
deleted_webhook_subscription_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted webhook subscription ID
|
|
|
|
ListWebhookEventsInput:
|
|
type: object
|
|
required:
|
|
- webhook_subscription_id
|
|
properties:
|
|
webhook_subscription_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Webhook subscription ID
|
|
order_by:
|
|
$ref: "#/components/schemas/WebhookEventOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListWebhookEventsOutput:
|
|
type: object
|
|
required:
|
|
- webhook_events
|
|
properties:
|
|
webhook_events:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/WebhookEvent"
|
|
description: List of webhook events
|
|
next_cursor:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/CursorKey"
|
|
- type: "null"
|
|
description: Next page cursor
|
|
|
|
StatementOfApplicabilityOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.StatementOfApplicabilityOrderField
|
|
|
|
StatementOfApplicabilityOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/StatementOfApplicabilityOrderField"
|
|
description: Statement of applicability order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
StatementOfApplicability:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Statement of applicability ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Statement of applicability name
|
|
document_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Associated document ID
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListStatementsOfApplicabilityInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/StatementOfApplicabilityOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
ListStatementsOfApplicabilityOutput:
|
|
type: object
|
|
required:
|
|
- statements_of_applicability
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
statements_of_applicability:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/StatementOfApplicability"
|
|
|
|
GetStatementOfApplicabilityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Statement of applicability ID
|
|
|
|
GetStatementOfApplicabilityOutput:
|
|
type: object
|
|
required:
|
|
- statement_of_applicability
|
|
properties:
|
|
statement_of_applicability:
|
|
$ref: "#/components/schemas/StatementOfApplicability"
|
|
|
|
AddStatementOfApplicabilityInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Statement of applicability name
|
|
|
|
AddStatementOfApplicabilityOutput:
|
|
type: object
|
|
required:
|
|
- statement_of_applicability
|
|
properties:
|
|
statement_of_applicability:
|
|
$ref: "#/components/schemas/StatementOfApplicability"
|
|
|
|
UpdateStatementOfApplicabilityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Statement of applicability ID
|
|
name:
|
|
type: string
|
|
description: Statement of applicability name
|
|
|
|
UpdateStatementOfApplicabilityOutput:
|
|
type: object
|
|
required:
|
|
- statement_of_applicability
|
|
properties:
|
|
statement_of_applicability:
|
|
$ref: "#/components/schemas/StatementOfApplicability"
|
|
|
|
DeleteStatementOfApplicabilityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Statement of applicability ID
|
|
|
|
DeleteStatementOfApplicabilityOutput:
|
|
type: object
|
|
required:
|
|
- deleted_statement_of_applicability_id
|
|
properties:
|
|
deleted_statement_of_applicability_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted statement of applicability ID
|
|
|
|
|
|
PublishDataListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishDataListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishAssetListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishAssetListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishFindingListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishFindingListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishObligationListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishObligationListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishProcessingActivityListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishProcessingActivityListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishDataProtectionImpactAssessmentListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishDataProtectionImpactAssessmentListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishTransferImpactAssessmentListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishTransferImpactAssessmentListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishThirdPartyListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishThirdPartyListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishRiskListInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- minor
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishRiskListOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
PublishStatementOfApplicabilityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
- minor
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Statement of applicability ID
|
|
approver_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional approver profile IDs. When minor is false and at least one ID is provided, an approval is requested as a major version. Ignored when minor is true.
|
|
minor:
|
|
type: boolean
|
|
description: When true, publish as a minor version (currentMajor.currentMinor+1) and ignore approver_ids; the document must already have a published major version. When false, publish as a new major version; if approver_ids are provided, an approval is requested instead.
|
|
|
|
PublishStatementOfApplicabilityOutput:
|
|
type: object
|
|
required:
|
|
- document_id
|
|
- document_version_id
|
|
properties:
|
|
document_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created or updated document ID
|
|
document_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Created document version ID
|
|
|
|
ApplicabilityStatementOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- CONTROL_SECTION_TITLE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ApplicabilityStatementOrderField
|
|
|
|
ApplicabilityStatementOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ApplicabilityStatementOrderField"
|
|
description: Applicability statement order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
ApplicabilityStatement:
|
|
type: object
|
|
required:
|
|
- id
|
|
- statement_of_applicability_id
|
|
- control_id
|
|
- organization_id
|
|
- applicability
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Applicability statement ID
|
|
statement_of_applicability_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Statement of applicability ID
|
|
control_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
applicability:
|
|
type: boolean
|
|
description: Whether the control is applicable
|
|
justification:
|
|
anyOf:
|
|
- type: string
|
|
- type: "null"
|
|
description: Justification for the applicability decision
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListApplicabilityStatementsInput:
|
|
type: object
|
|
required:
|
|
- statement_of_applicability_id
|
|
properties:
|
|
statement_of_applicability_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Statement of applicability ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ApplicabilityStatementOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListApplicabilityStatementsOutput:
|
|
type: object
|
|
required:
|
|
- applicability_statements
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
applicability_statements:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ApplicabilityStatement"
|
|
|
|
GetApplicabilityStatementInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Applicability statement ID
|
|
|
|
GetApplicabilityStatementOutput:
|
|
type: object
|
|
required:
|
|
- applicability_statement
|
|
properties:
|
|
applicability_statement:
|
|
$ref: "#/components/schemas/ApplicabilityStatement"
|
|
|
|
AddApplicabilityStatementInput:
|
|
type: object
|
|
required:
|
|
- statement_of_applicability_id
|
|
- control_id
|
|
- applicability
|
|
properties:
|
|
statement_of_applicability_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Statement of applicability ID
|
|
control_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Control ID
|
|
applicability:
|
|
type: boolean
|
|
description: Whether the control is applicable
|
|
justification:
|
|
anyOf:
|
|
- type: string
|
|
- type: "null"
|
|
description: Justification for the applicability decision
|
|
|
|
AddApplicabilityStatementOutput:
|
|
type: object
|
|
required:
|
|
- applicability_statement
|
|
properties:
|
|
applicability_statement:
|
|
$ref: "#/components/schemas/ApplicabilityStatement"
|
|
|
|
UpdateApplicabilityStatementInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
- applicability
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Applicability statement ID
|
|
applicability:
|
|
type: boolean
|
|
description: Whether the control is applicable
|
|
justification:
|
|
anyOf:
|
|
- type: string
|
|
- type: "null"
|
|
description: Justification for the applicability decision
|
|
|
|
UpdateApplicabilityStatementOutput:
|
|
type: object
|
|
required:
|
|
- applicability_statement
|
|
properties:
|
|
applicability_statement:
|
|
$ref: "#/components/schemas/ApplicabilityStatement"
|
|
|
|
DeleteApplicabilityStatementInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Applicability statement ID
|
|
|
|
DeleteApplicabilityStatementOutput:
|
|
type: object
|
|
required:
|
|
- deleted_applicability_statement_id
|
|
properties:
|
|
deleted_applicability_statement_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted applicability statement ID
|
|
|
|
AccessReviewCampaignStatus:
|
|
type: string
|
|
enum:
|
|
- DRAFT
|
|
- IN_PROGRESS
|
|
- PENDING_ACTIONS
|
|
- COMPLETED
|
|
- CANCELLED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewCampaignStatus
|
|
|
|
AccessReviewEntryDecision:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- APPROVED
|
|
- REVOKE
|
|
- DEFER
|
|
- ESCALATE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewEntryDecision
|
|
|
|
AccessReviewEntryFlag:
|
|
type: string
|
|
enum:
|
|
- NONE
|
|
- ORPHANED
|
|
- INACTIVE
|
|
- EXCESSIVE
|
|
- ROLE_MISMATCH
|
|
- NEW
|
|
- DORMANT
|
|
- TERMINATED_USER
|
|
- CONTRACTOR_EXPIRED
|
|
- SOD_CONFLICT
|
|
- PRIVILEGED_ACCESS
|
|
- ROLE_CREEP
|
|
- NO_BUSINESS_JUSTIFICATION
|
|
- OUT_OF_DEPARTMENT
|
|
- SHARED_ACCOUNT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewEntryFlag
|
|
|
|
AccessReviewEntryIncrementalTag:
|
|
type: string
|
|
enum:
|
|
- NEW
|
|
- REMOVED
|
|
- UNCHANGED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewEntryIncrementalTag
|
|
|
|
AccessReviewEntryAuthMethod:
|
|
type: string
|
|
enum:
|
|
- SSO
|
|
- PASSWORD
|
|
- API_KEY
|
|
- SERVICE_ACCOUNT
|
|
- UNKNOWN
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewEntryAuthMethod
|
|
|
|
AccessReviewEntryAccountType:
|
|
type: string
|
|
enum:
|
|
- USER
|
|
- SERVICE_ACCOUNT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewEntryAccountType
|
|
|
|
MFAStatus:
|
|
type: string
|
|
enum:
|
|
- ENABLED
|
|
- DISABLED
|
|
- UNKNOWN
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.MFAStatus
|
|
|
|
AccessReviewCampaignOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewCampaignOrderField
|
|
|
|
AccessReviewCampaignOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/AccessReviewCampaignOrderField"
|
|
description: Order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
AccessReviewEntryOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewEntryOrderField
|
|
|
|
AccessReviewEntryOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/AccessReviewEntryOrderField"
|
|
description: Order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
AccessReviewCampaign:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- status
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Campaign name
|
|
description:
|
|
type: string
|
|
description: Campaign description
|
|
status:
|
|
$ref: "#/components/schemas/AccessReviewCampaignStatus"
|
|
description: Campaign status
|
|
started_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Campaign start time
|
|
completed_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Campaign completion time
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
AccessReviewEntry:
|
|
type: object
|
|
required:
|
|
- id
|
|
- campaign_id
|
|
- access_review_campaign_source_id
|
|
- email
|
|
- full_name
|
|
- roles
|
|
- job_title
|
|
- is_admin
|
|
- mfa_status
|
|
- auth_method
|
|
- account_type
|
|
- external_id
|
|
- incremental_tag
|
|
- flags
|
|
- decision
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Entry ID
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
access_review_campaign_source_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Per-campaign source snapshot ID
|
|
email:
|
|
type: string
|
|
description: User email
|
|
full_name:
|
|
type: string
|
|
description: User full name
|
|
roles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User roles in the system
|
|
job_title:
|
|
type: string
|
|
description: User job title
|
|
is_admin:
|
|
type: boolean
|
|
description: Whether the user has admin privileges
|
|
active:
|
|
type:
|
|
- boolean
|
|
- "null"
|
|
description: Whether the account is active at the source (null when unknown)
|
|
mfa_status:
|
|
$ref: "#/components/schemas/MFAStatus"
|
|
description: MFA status
|
|
auth_method:
|
|
$ref: "#/components/schemas/AccessReviewEntryAuthMethod"
|
|
description: Authentication method
|
|
account_type:
|
|
$ref: "#/components/schemas/AccessReviewEntryAccountType"
|
|
description: Account type (user or service account)
|
|
last_login:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Last login time
|
|
account_created_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Account creation time
|
|
external_id:
|
|
type: string
|
|
description: External ID in the source system
|
|
incremental_tag:
|
|
$ref: "#/components/schemas/AccessReviewEntryIncrementalTag"
|
|
description: Change tag compared to previous campaign
|
|
flags:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/AccessReviewEntryFlag"
|
|
description: Risk flags
|
|
flag_reasons:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Reasons for the flags
|
|
decision:
|
|
$ref: "#/components/schemas/AccessReviewEntryDecision"
|
|
description: Review decision
|
|
decision_note:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Decision justification
|
|
decided_by:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Profile ID of the decision maker
|
|
decided_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Decision timestamp
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
AccessReviewStatistics:
|
|
type: object
|
|
required:
|
|
- total_count
|
|
- decision_counts
|
|
- flag_counts
|
|
- incremental_tag_counts
|
|
properties:
|
|
total_count:
|
|
type: integer
|
|
description: Total number of entries
|
|
decision_counts:
|
|
type: object
|
|
additionalProperties:
|
|
type: integer
|
|
description: Count of entries per decision status
|
|
flag_counts:
|
|
type: object
|
|
additionalProperties:
|
|
type: integer
|
|
description: Count of entries per flag type
|
|
incremental_tag_counts:
|
|
type: object
|
|
additionalProperties:
|
|
type: integer
|
|
description: Count of entries per incremental tag
|
|
|
|
ListAccessReviewCampaignsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/AccessReviewCampaignOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListAccessReviewCampaignsOutput:
|
|
type: object
|
|
required:
|
|
- campaigns
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
campaigns:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/AccessReviewCampaign"
|
|
|
|
ListAccessEntriesInput:
|
|
type: object
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID. Required when access_review_campaign_source_id is omitted.
|
|
access_review_campaign_source_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign source snapshot ID. When set, lists entries for that source only and campaign_id is ignored.
|
|
order_by:
|
|
$ref: "#/components/schemas/AccessReviewEntryOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
decision:
|
|
$ref: "#/components/schemas/AccessReviewEntryDecision"
|
|
description: Filter by decision status
|
|
flag:
|
|
$ref: "#/components/schemas/AccessReviewEntryFlag"
|
|
description: Filter by flag
|
|
incremental_tag:
|
|
$ref: "#/components/schemas/AccessReviewEntryIncrementalTag"
|
|
description: Filter by incremental tag
|
|
is_admin:
|
|
type: boolean
|
|
description: Filter by admin status
|
|
active:
|
|
type: boolean
|
|
description: Filter by active status at the source
|
|
auth_method:
|
|
$ref: "#/components/schemas/AccessReviewEntryAuthMethod"
|
|
description: Filter by auth method
|
|
account_type:
|
|
$ref: "#/components/schemas/AccessReviewEntryAccountType"
|
|
description: Filter by account type
|
|
|
|
ListAccessEntriesOutput:
|
|
type: object
|
|
required:
|
|
- entries
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
entries:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/AccessReviewEntry"
|
|
|
|
GetAccessReviewStatisticsInput:
|
|
type: object
|
|
required:
|
|
- campaign_id
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
|
|
GetAccessReviewStatisticsOutput:
|
|
type: object
|
|
required:
|
|
- statistics
|
|
properties:
|
|
statistics:
|
|
$ref: "#/components/schemas/AccessReviewStatistics"
|
|
|
|
RecordAccessReviewEntryDecisionMCPInput:
|
|
type: object
|
|
required:
|
|
- access_review_entry_id
|
|
- decision
|
|
properties:
|
|
access_review_entry_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access entry ID
|
|
decision:
|
|
$ref: "#/components/schemas/AccessReviewEntryDecision"
|
|
description: Decision (APPROVED, REVOKE, DEFER, ESCALATE)
|
|
decision_note:
|
|
type: string
|
|
description: Decision justification (required for non-APPROVED decisions)
|
|
|
|
RecordAccessReviewEntryDecisionMCPOutput:
|
|
type: object
|
|
required:
|
|
- access_entry
|
|
properties:
|
|
access_entry:
|
|
$ref: "#/components/schemas/AccessReviewEntry"
|
|
|
|
RecordAccessReviewEntryDecisionsMCPInput:
|
|
type: object
|
|
required:
|
|
- decisions
|
|
properties:
|
|
decisions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
required:
|
|
- access_review_entry_id
|
|
- decision
|
|
properties:
|
|
access_review_entry_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access entry ID
|
|
decision:
|
|
$ref: "#/components/schemas/AccessReviewEntryDecision"
|
|
description: Decision (APPROVED, REVOKE, DEFER, ESCALATE)
|
|
decision_note:
|
|
type: string
|
|
description: Decision justification (required for non-APPROVED decisions)
|
|
|
|
RecordAccessReviewEntryDecisionsMCPOutput:
|
|
type: object
|
|
required:
|
|
- access_review_entries
|
|
properties:
|
|
access_review_entries:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/AccessReviewEntry"
|
|
|
|
FlagAccessReviewEntryMCPInput:
|
|
type: object
|
|
required:
|
|
- access_review_entry_id
|
|
- flags
|
|
properties:
|
|
access_review_entry_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access entry ID
|
|
flags:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/AccessReviewEntryFlag"
|
|
description: Flags to set (ORPHANED, INACTIVE, EXCESSIVE, ROLE_MISMATCH, NEW, DORMANT, TERMINATED_USER, CONTRACTOR_EXPIRED, SOD_CONFLICT, PRIVILEGED_ACCESS, ROLE_CREEP, NO_BUSINESS_JUSTIFICATION, OUT_OF_DEPARTMENT, SHARED_ACCOUNT)
|
|
flag_reasons:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Reasons for flagging
|
|
|
|
FlagAccessReviewEntryMCPOutput:
|
|
type: object
|
|
required:
|
|
- access_entry
|
|
properties:
|
|
access_entry:
|
|
$ref: "#/components/schemas/AccessReviewEntry"
|
|
|
|
CloseAccessReviewCampaignMCPInput:
|
|
type: object
|
|
required:
|
|
- campaign_id
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
|
|
CloseAccessReviewCampaignMCPOutput:
|
|
type: object
|
|
required:
|
|
- campaign
|
|
properties:
|
|
campaign:
|
|
$ref: "#/components/schemas/AccessReviewCampaign"
|
|
|
|
AccessReviewSourceOrderField:
|
|
type: string
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AccessReviewSourceOrderField
|
|
enum:
|
|
- CREATED_AT
|
|
|
|
AccessReviewSourceOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/AccessReviewSourceOrderField"
|
|
description: Order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Order direction
|
|
|
|
AccessReviewSource:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access source ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
connector_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Connector ID
|
|
name:
|
|
type: string
|
|
description: Access source name
|
|
csv_data:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: CSV data for manual sources
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListAccessReviewSourcesInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/AccessReviewSourceOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListAccessReviewSourcesOutput:
|
|
type: object
|
|
required:
|
|
- access_review_sources
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
access_review_sources:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/AccessReviewSource"
|
|
|
|
CreateAccessReviewSourceMCPInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
connector_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Connector ID (optional)
|
|
name:
|
|
type: string
|
|
description: Access source name
|
|
csv_data:
|
|
type: string
|
|
description: CSV data for manual sources (optional)
|
|
|
|
CreateAccessReviewSourceMCPOutput:
|
|
type: object
|
|
required:
|
|
- access_source
|
|
properties:
|
|
access_review_source:
|
|
$ref: "#/components/schemas/AccessReviewSource"
|
|
|
|
UpdateAccessReviewSourceMCPInput:
|
|
type: object
|
|
required:
|
|
- access_review_source_id
|
|
properties:
|
|
access_review_source_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access source ID
|
|
name:
|
|
type: string
|
|
description: New name
|
|
connector_id:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description: Connector ID (set to null to remove)
|
|
csv_data:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description: CSV data for manual sources (set to null to remove)
|
|
|
|
UpdateAccessReviewSourceMCPOutput:
|
|
type: object
|
|
required:
|
|
- access_source
|
|
properties:
|
|
access_review_source:
|
|
$ref: "#/components/schemas/AccessReviewSource"
|
|
|
|
DeleteAccessReviewSourceMCPInput:
|
|
type: object
|
|
required:
|
|
- access_review_source_id
|
|
properties:
|
|
access_review_source_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access source ID
|
|
|
|
DeleteAccessReviewSourceMCPOutput:
|
|
type: object
|
|
required:
|
|
- deleted_access_review_source_id
|
|
properties:
|
|
deleted_access_review_source_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted access source ID
|
|
|
|
CreateAccessReviewCampaignMCPInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Campaign name
|
|
description:
|
|
type: string
|
|
description: Campaign description
|
|
access_review_source_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access source IDs to include in scope
|
|
|
|
CreateAccessReviewCampaignMCPOutput:
|
|
type: object
|
|
required:
|
|
- campaign
|
|
properties:
|
|
campaign:
|
|
$ref: "#/components/schemas/AccessReviewCampaign"
|
|
|
|
UpdateAccessReviewCampaignMCPInput:
|
|
type: object
|
|
required:
|
|
- campaign_id
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
name:
|
|
type: string
|
|
description: New campaign name
|
|
description:
|
|
type: string
|
|
description: New campaign description
|
|
UpdateAccessReviewCampaignMCPOutput:
|
|
type: object
|
|
required:
|
|
- campaign
|
|
properties:
|
|
campaign:
|
|
$ref: "#/components/schemas/AccessReviewCampaign"
|
|
|
|
DeleteAccessReviewCampaignMCPInput:
|
|
type: object
|
|
required:
|
|
- campaign_id
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
|
|
DeleteAccessReviewCampaignMCPOutput:
|
|
type: object
|
|
required:
|
|
- deleted_campaign_id
|
|
properties:
|
|
deleted_campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted campaign ID
|
|
|
|
StartAccessReviewCampaignMCPInput:
|
|
type: object
|
|
required:
|
|
- campaign_id
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
|
|
StartAccessReviewCampaignMCPOutput:
|
|
type: object
|
|
required:
|
|
- campaign
|
|
properties:
|
|
campaign:
|
|
$ref: "#/components/schemas/AccessReviewCampaign"
|
|
|
|
CancelAccessReviewCampaignMCPInput:
|
|
type: object
|
|
required:
|
|
- campaign_id
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
|
|
CancelAccessReviewCampaignMCPOutput:
|
|
type: object
|
|
required:
|
|
- campaign
|
|
properties:
|
|
campaign:
|
|
$ref: "#/components/schemas/AccessReviewCampaign"
|
|
|
|
AddAccessReviewCampaignSourceMCPInput:
|
|
type: object
|
|
required:
|
|
- campaign_id
|
|
- access_review_source_id
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
access_review_source_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access source ID to add to scope
|
|
|
|
AddAccessReviewCampaignSourceMCPOutput:
|
|
type: object
|
|
required:
|
|
- campaign
|
|
properties:
|
|
campaign:
|
|
$ref: "#/components/schemas/AccessReviewCampaign"
|
|
|
|
RemoveAccessReviewCampaignSourceMCPInput:
|
|
type: object
|
|
required:
|
|
- campaign_id
|
|
- access_review_source_id
|
|
properties:
|
|
campaign_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Campaign ID
|
|
access_review_source_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Access source ID to remove from scope
|
|
|
|
RemoveAccessReviewCampaignSourceMCPOutput:
|
|
type: object
|
|
required:
|
|
- campaign
|
|
properties:
|
|
campaign:
|
|
$ref: "#/components/schemas/AccessReviewCampaign"
|
|
|
|
OrganizationContext:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
product:
|
|
type: string
|
|
description: Product description
|
|
architecture:
|
|
type: string
|
|
description: Architecture description
|
|
team:
|
|
type: string
|
|
description: Team description
|
|
processes:
|
|
type: string
|
|
description: Processes description
|
|
customers:
|
|
type: string
|
|
description: Customers description
|
|
|
|
GetOrganizationContextInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
|
|
GetOrganizationContextOutput:
|
|
type: object
|
|
required:
|
|
- organization_context
|
|
properties:
|
|
organization_context:
|
|
$ref: "#/components/schemas/OrganizationContext"
|
|
|
|
UpdateOrganizationContextInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
product:
|
|
type: string
|
|
description: Product description
|
|
architecture:
|
|
type: string
|
|
description: Architecture description
|
|
team:
|
|
type: string
|
|
description: Team description
|
|
processes:
|
|
type: string
|
|
description: Processes description
|
|
customers:
|
|
type: string
|
|
description: Customers description
|
|
|
|
UpdateOrganizationContextOutput:
|
|
type: object
|
|
required:
|
|
- organization_context
|
|
properties:
|
|
organization_context:
|
|
$ref: "#/components/schemas/OrganizationContext"
|
|
|
|
GetAuditLogEntryInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit log entry ID
|
|
|
|
GetAuditLogEntryOutput:
|
|
type: object
|
|
required:
|
|
- audit_log_entry
|
|
properties:
|
|
audit_log_entry:
|
|
$ref: "#/components/schemas/AuditLogEntry"
|
|
|
|
ListAuditLogEntriesInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
action:
|
|
type: string
|
|
description: Filter by action (e.g. "core:thirdParty:create")
|
|
actor_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Filter by actor ID
|
|
resource_type:
|
|
type: string
|
|
description: Filter by resource type (e.g. "ThirdParty")
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Filter by resource ID
|
|
|
|
ListAuditLogEntriesOutput:
|
|
type: object
|
|
required:
|
|
- audit_log_entries
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
audit_log_entries:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/AuditLogEntry"
|
|
|
|
RequestAuditLogExportInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- from_time
|
|
- to_time
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
from_time:
|
|
type: string
|
|
format: date-time
|
|
go.probo.inc/mcpgen/type: time.Time
|
|
description: Start of the time range (inclusive). The range must not exceed 1 year.
|
|
to_time:
|
|
type: string
|
|
format: date-time
|
|
go.probo.inc/mcpgen/type: time.Time
|
|
description: End of the time range (exclusive). The range must not exceed 1 year.
|
|
|
|
RequestAuditLogExportOutput:
|
|
type: object
|
|
required:
|
|
- export_job_id
|
|
properties:
|
|
export_job_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the created log export
|
|
|
|
RequestSCIMEventExportInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- from_time
|
|
- to_time
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
from_time:
|
|
type: string
|
|
format: date-time
|
|
go.probo.inc/mcpgen/type: time.Time
|
|
description: Start of the time range (inclusive). The range must not exceed 1 year.
|
|
to_time:
|
|
type: string
|
|
format: date-time
|
|
go.probo.inc/mcpgen/type: time.Time
|
|
description: End of the time range (exclusive). The range must not exceed 1 year.
|
|
|
|
RequestSCIMEventExportOutput:
|
|
type: object
|
|
required:
|
|
- export_job_id
|
|
properties:
|
|
export_job_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the created log export
|
|
|
|
AuditLogEntry:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- actor_id
|
|
- actor_type
|
|
- action
|
|
- resource_type
|
|
- resource_id
|
|
- created_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit log entry ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
actor_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the actor who performed the action
|
|
actor_type:
|
|
type: string
|
|
enum: [USER, API_KEY, SYSTEM]
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AuditLogActorType
|
|
description: Type of actor
|
|
action:
|
|
type: string
|
|
description: Action performed (e.g. "core:thirdParty:create")
|
|
resource_type:
|
|
type: string
|
|
description: Type of resource affected (e.g. "ThirdParty")
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the affected resource
|
|
metadata:
|
|
type: object
|
|
description: Additional metadata about the action
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
go.probo.inc/mcpgen/type: time.Time
|
|
description: When the action was performed
|
|
|
|
RightsRequestType:
|
|
type: string
|
|
enum:
|
|
- ACCESS
|
|
- DELETION
|
|
- RECTIFICATION
|
|
- PORTABILITY
|
|
- OBJECTION
|
|
- COMPLAINT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RightsRequestType
|
|
|
|
RightsRequestState:
|
|
type: string
|
|
enum:
|
|
- TODO
|
|
- IN_PROGRESS
|
|
- DONE
|
|
- REJECTED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RightsRequestState
|
|
|
|
RightsRequestOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- DEADLINE
|
|
- STATE
|
|
- TYPE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RightsRequestOrderField
|
|
|
|
RightsRequestOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RightsRequestOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
RightsRequest:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- request_type
|
|
- request_state
|
|
- data_subject
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
request_type:
|
|
$ref: "#/components/schemas/RightsRequestType"
|
|
request_state:
|
|
$ref: "#/components/schemas/RightsRequestState"
|
|
data_subject:
|
|
type: string
|
|
contact:
|
|
type:
|
|
- string
|
|
- "null"
|
|
details:
|
|
type:
|
|
- string
|
|
- "null"
|
|
deadline:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
- type: "null"
|
|
action_taken:
|
|
type:
|
|
- string
|
|
- "null"
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
ListRightsRequestsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RightsRequestOrderBy"
|
|
description: Rights request order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListRightsRequestsOutput:
|
|
type: object
|
|
required:
|
|
- rights_requests
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
rights_requests:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/RightsRequest"
|
|
|
|
GetRightsRequestInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Rights request ID
|
|
|
|
GetRightsRequestOutput:
|
|
type: object
|
|
required:
|
|
- rights_request
|
|
properties:
|
|
rights_request:
|
|
$ref: "#/components/schemas/RightsRequest"
|
|
|
|
AddRightsRequestInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- request_type
|
|
- request_state
|
|
- data_subject
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
request_type:
|
|
$ref: "#/components/schemas/RightsRequestType"
|
|
description: Rights request type
|
|
request_state:
|
|
$ref: "#/components/schemas/RightsRequestState"
|
|
description: Rights request state
|
|
data_subject:
|
|
type: string
|
|
description: Data subject
|
|
contact:
|
|
type: string
|
|
description: Contact information
|
|
details:
|
|
type: string
|
|
description: Request details
|
|
deadline:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
- type: "null"
|
|
description: Deadline
|
|
action_taken:
|
|
type: string
|
|
description: Action taken
|
|
|
|
AddRightsRequestOutput:
|
|
type: object
|
|
required:
|
|
- rights_request
|
|
properties:
|
|
rights_request:
|
|
$ref: "#/components/schemas/RightsRequest"
|
|
|
|
UpdateRightsRequestInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Rights request ID
|
|
request_type:
|
|
$ref: "#/components/schemas/RightsRequestType"
|
|
description: Rights request type
|
|
request_state:
|
|
$ref: "#/components/schemas/RightsRequestState"
|
|
description: Rights request state
|
|
data_subject:
|
|
type: string
|
|
description: Data subject
|
|
contact:
|
|
type: ["string", "null"]
|
|
description: Contact information
|
|
go.probo.inc/mcpgen/omittable: true
|
|
details:
|
|
type: ["string", "null"]
|
|
description: Request details
|
|
go.probo.inc/mcpgen/omittable: true
|
|
deadline:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
- type: "null"
|
|
description: Deadline
|
|
go.probo.inc/mcpgen/omittable: true
|
|
action_taken:
|
|
type: ["string", "null"]
|
|
description: Action taken
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateRightsRequestOutput:
|
|
type: object
|
|
required:
|
|
- rights_request
|
|
properties:
|
|
rights_request:
|
|
$ref: "#/components/schemas/RightsRequest"
|
|
|
|
DeleteRightsRequestInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Rights request ID
|
|
|
|
DeleteRightsRequestOutput:
|
|
type: object
|
|
required:
|
|
- deleted_rights_request_id
|
|
properties:
|
|
deleted_rights_request_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted rights request ID
|
|
|
|
SearchEngineIndexing:
|
|
type: string
|
|
enum:
|
|
- INDEXABLE
|
|
- NOT_INDEXABLE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.SearchEngineIndexing
|
|
|
|
SSLStatus:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- PROVISIONING
|
|
- ACTIVE
|
|
- RENEWING
|
|
- EXPIRED
|
|
- FAILED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.CertificateStatus
|
|
|
|
CompliancePortalReferenceOrderField:
|
|
type: string
|
|
enum:
|
|
- RANK
|
|
- NAME
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.CompliancePortalReferenceOrderField
|
|
|
|
CompliancePortalReferenceOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/CompliancePortalReferenceOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
CompliancePortalFileOrderField:
|
|
type: string
|
|
enum:
|
|
- NAME
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.CompliancePortalFileOrderField
|
|
|
|
CompliancePortalFileOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/CompliancePortalFileOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
ComplianceCustomLinkOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- RANK
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ComplianceCustomLinkOrderField
|
|
|
|
ComplianceCustomLinkOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ComplianceCustomLinkOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
File:
|
|
type: object
|
|
required:
|
|
- id
|
|
- mime_type
|
|
- file_name
|
|
- size
|
|
- download_url
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
mime_type:
|
|
type: string
|
|
file_name:
|
|
type: string
|
|
size:
|
|
type: integer
|
|
format: int64
|
|
download_url:
|
|
type: string
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
CompliancePortal:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- active
|
|
- search_engine_indexing
|
|
- entity_name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
active:
|
|
type: boolean
|
|
search_engine_indexing:
|
|
$ref: "#/components/schemas/SearchEngineIndexing"
|
|
logo:
|
|
$ref: "#/components/schemas/File"
|
|
dark_logo:
|
|
$ref: "#/components/schemas/File"
|
|
nda:
|
|
$ref: "#/components/schemas/File"
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Compliance page description
|
|
website_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Compliance page website URL
|
|
email:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Compliance page contact email
|
|
headquarter_address:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Compliance page headquarter address
|
|
entity_name:
|
|
type: string
|
|
description: Entity name shown on the public compliance page
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
CompliancePortalReference:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- rank
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
website_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
logo:
|
|
$ref: "#/components/schemas/File"
|
|
rank:
|
|
type: integer
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
CompliancePortalFile:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- category
|
|
- file
|
|
- compliance_portal_visibility
|
|
- organization_id
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
category:
|
|
type: string
|
|
file:
|
|
$ref: "#/components/schemas/File"
|
|
compliance_portal_visibility:
|
|
$ref: "#/components/schemas/CompliancePortalVisibility"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
ComplianceCustomLink:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- url
|
|
- rank
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
url:
|
|
type: string
|
|
rank:
|
|
type: integer
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
Certificate:
|
|
type: object
|
|
required:
|
|
- id
|
|
- status
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
status:
|
|
$ref: "#/components/schemas/SSLStatus"
|
|
expires_at:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
- type: "null"
|
|
provisioning_error:
|
|
anyOf:
|
|
- type: string
|
|
- type: "null"
|
|
|
|
CustomDomain:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- domain
|
|
- managed
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
domain:
|
|
type: string
|
|
managed:
|
|
type: boolean
|
|
description: Whether this domain is a Probo-managed probopage subdomain
|
|
certificate:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/Certificate"
|
|
- type: "null"
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
GetCompliancePortalInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
|
|
GetCompliancePortalOutput:
|
|
type: object
|
|
required:
|
|
- compliance_portal
|
|
properties:
|
|
compliance_portal:
|
|
$ref: "#/components/schemas/CompliancePortal"
|
|
|
|
UpdateCompliancePortalInput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_id
|
|
properties:
|
|
compliance_portal_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal ID
|
|
active:
|
|
type:
|
|
- boolean
|
|
- "null"
|
|
description: Whether the compliance portal is active
|
|
go.probo.inc/mcpgen/omittable: true
|
|
search_engine_indexing:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/SearchEngineIndexing"
|
|
- type: "null"
|
|
description: Search engine indexing setting
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Compliance page description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
website_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Compliance page website URL
|
|
go.probo.inc/mcpgen/omittable: true
|
|
email:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Compliance page contact email
|
|
go.probo.inc/mcpgen/omittable: true
|
|
headquarter_address:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Compliance page headquarter address
|
|
go.probo.inc/mcpgen/omittable: true
|
|
entity_name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Entity name shown on the public compliance page
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateCompliancePortalOutput:
|
|
type: object
|
|
required:
|
|
- compliance_portal
|
|
properties:
|
|
compliance_portal:
|
|
$ref: "#/components/schemas/CompliancePortal"
|
|
|
|
ListCompliancePortalReferencesInput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_id
|
|
properties:
|
|
compliance_portal_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal ID
|
|
order_by:
|
|
$ref: "#/components/schemas/CompliancePortalReferenceOrderBy"
|
|
description: Compliance portal reference order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListCompliancePortalReferencesOutput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_references
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
compliance_portal_references:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/CompliancePortalReference"
|
|
|
|
AddCompliancePortalReferenceInput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_id
|
|
- name
|
|
properties:
|
|
compliance_portal_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal ID
|
|
name:
|
|
type: string
|
|
description: Reference name
|
|
description:
|
|
type: string
|
|
description: Reference description
|
|
website_url:
|
|
type: string
|
|
description: Reference website URL
|
|
|
|
AddCompliancePortalReferenceOutput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_reference
|
|
properties:
|
|
compliance_portal_reference:
|
|
$ref: "#/components/schemas/CompliancePortalReference"
|
|
|
|
UpdateCompliancePortalReferenceInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal reference ID
|
|
name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Reference name
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Reference description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
website_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Reference website URL
|
|
go.probo.inc/mcpgen/omittable: true
|
|
rank:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Reference rank
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateCompliancePortalReferenceOutput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_reference
|
|
properties:
|
|
compliance_portal_reference:
|
|
$ref: "#/components/schemas/CompliancePortalReference"
|
|
|
|
DeleteCompliancePortalReferenceInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal reference ID
|
|
|
|
DeleteCompliancePortalReferenceOutput:
|
|
type: object
|
|
required:
|
|
- deleted_compliance_portal_reference_id
|
|
properties:
|
|
deleted_compliance_portal_reference_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted compliance portal reference ID
|
|
|
|
CompliancePortalCommitmentIcon:
|
|
type: string
|
|
enum:
|
|
- LOCK_KEY
|
|
- EYE_SLASH
|
|
- FINGERPRINT
|
|
- SHIELD_WARNING
|
|
- SHIELD_CHECK
|
|
- SIREN
|
|
- KEY
|
|
- LOCK
|
|
- CLOUD
|
|
- DATABASE
|
|
- GLOBE
|
|
- EYE
|
|
- USERS
|
|
- CERTIFICATE
|
|
- GAVEL
|
|
- HEARTBEAT
|
|
- BELL
|
|
- BUG
|
|
- CODE
|
|
- SERVER
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.CompliancePortalCommitmentIcon
|
|
|
|
CompliancePortalCommitmentGroupOrderField:
|
|
type: string
|
|
enum:
|
|
- RANK
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.CompliancePortalCommitmentGroupOrderField
|
|
|
|
CompliancePortalCommitmentGroupOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/CompliancePortalCommitmentGroupOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
CompliancePortalCommitmentOrderField:
|
|
type: string
|
|
enum:
|
|
- RANK
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.CompliancePortalCommitmentOrderField
|
|
|
|
CompliancePortalCommitmentOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/CompliancePortalCommitmentOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
CommitmentGroup:
|
|
type: object
|
|
required:
|
|
- id
|
|
- title
|
|
- description
|
|
- rank
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
title:
|
|
type: string
|
|
description:
|
|
type: string
|
|
rank:
|
|
type: integer
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
Commitment:
|
|
type: object
|
|
required:
|
|
- id
|
|
- group_id
|
|
- icon
|
|
- eyebrow
|
|
- title
|
|
- description
|
|
- rank
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
group_id:
|
|
$ref: "#/components/schemas/GID"
|
|
icon:
|
|
$ref: "#/components/schemas/CompliancePortalCommitmentIcon"
|
|
eyebrow:
|
|
type: string
|
|
title:
|
|
type: string
|
|
description:
|
|
type: string
|
|
rank:
|
|
type: integer
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
ListCommitmentGroupsInput:
|
|
type: object
|
|
required:
|
|
- trust_center_id
|
|
properties:
|
|
trust_center_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Trust center ID
|
|
order_by:
|
|
$ref: "#/components/schemas/CompliancePortalCommitmentGroupOrderBy"
|
|
description: Commitment group order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListCommitmentGroupsOutput:
|
|
type: object
|
|
required:
|
|
- commitment_groups
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
commitment_groups:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/CommitmentGroup"
|
|
|
|
AddCommitmentGroupInput:
|
|
type: object
|
|
required:
|
|
- trust_center_id
|
|
- title
|
|
- description
|
|
properties:
|
|
trust_center_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Trust center ID
|
|
title:
|
|
type: string
|
|
description: Group title
|
|
description:
|
|
type: string
|
|
description: Group description
|
|
|
|
AddCommitmentGroupOutput:
|
|
type: object
|
|
required:
|
|
- commitment_group
|
|
properties:
|
|
commitment_group:
|
|
$ref: "#/components/schemas/CommitmentGroup"
|
|
|
|
UpdateCommitmentGroupInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Commitment group ID
|
|
title:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Group title
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Group description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
rank:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Group rank
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateCommitmentGroupOutput:
|
|
type: object
|
|
required:
|
|
- commitment_group
|
|
properties:
|
|
commitment_group:
|
|
$ref: "#/components/schemas/CommitmentGroup"
|
|
|
|
DeleteCommitmentGroupInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Commitment group ID
|
|
|
|
DeleteCommitmentGroupOutput:
|
|
type: object
|
|
required:
|
|
- deleted_commitment_group_id
|
|
properties:
|
|
deleted_commitment_group_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted commitment group ID
|
|
|
|
ListCommitmentsInput:
|
|
type: object
|
|
required:
|
|
- group_id
|
|
properties:
|
|
group_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Commitment group ID
|
|
order_by:
|
|
$ref: "#/components/schemas/CompliancePortalCommitmentOrderBy"
|
|
description: Commitment order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListCommitmentsOutput:
|
|
type: object
|
|
required:
|
|
- commitments
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
commitments:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Commitment"
|
|
|
|
AddCommitmentInput:
|
|
type: object
|
|
required:
|
|
- group_id
|
|
- icon
|
|
- eyebrow
|
|
- title
|
|
- description
|
|
properties:
|
|
group_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Commitment group ID
|
|
icon:
|
|
$ref: "#/components/schemas/CompliancePortalCommitmentIcon"
|
|
description: Commitment icon
|
|
eyebrow:
|
|
type: string
|
|
description: Commitment eyebrow
|
|
title:
|
|
type: string
|
|
description: Commitment title
|
|
description:
|
|
type: string
|
|
description: Commitment description
|
|
|
|
AddCommitmentOutput:
|
|
type: object
|
|
required:
|
|
- commitment
|
|
properties:
|
|
commitment:
|
|
$ref: "#/components/schemas/Commitment"
|
|
|
|
UpdateCommitmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Commitment ID
|
|
icon:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/CompliancePortalCommitmentIcon"
|
|
- type: "null"
|
|
description: Commitment icon
|
|
go.probo.inc/mcpgen/omittable: true
|
|
eyebrow:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Commitment eyebrow
|
|
go.probo.inc/mcpgen/omittable: true
|
|
title:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Commitment title
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Commitment description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
rank:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Commitment rank
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateCommitmentOutput:
|
|
type: object
|
|
required:
|
|
- commitment
|
|
properties:
|
|
commitment:
|
|
$ref: "#/components/schemas/Commitment"
|
|
|
|
DeleteCommitmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Commitment ID
|
|
|
|
DeleteCommitmentOutput:
|
|
type: object
|
|
required:
|
|
- deleted_commitment_id
|
|
properties:
|
|
deleted_commitment_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted commitment ID
|
|
|
|
ResourceAlias:
|
|
type: object
|
|
required:
|
|
- resource_id
|
|
- alias
|
|
properties:
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Document, compliance portal file, or audit ID
|
|
alias:
|
|
type: string
|
|
description: Human-readable alias slug
|
|
|
|
SetResourceAliasInput:
|
|
type: object
|
|
required:
|
|
- resource_id
|
|
- alias
|
|
properties:
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the resource to alias
|
|
alias:
|
|
type: string
|
|
description: Human-readable alias slug
|
|
|
|
SetResourceAliasOutput:
|
|
type: object
|
|
required:
|
|
- resource_alias
|
|
properties:
|
|
resource_alias:
|
|
$ref: "#/components/schemas/ResourceAlias"
|
|
|
|
RemoveResourceAliasInput:
|
|
type: object
|
|
required:
|
|
- resource_id
|
|
properties:
|
|
resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the resource whose alias to remove
|
|
|
|
RemoveResourceAliasOutput:
|
|
type: object
|
|
required:
|
|
- deleted_resource_id
|
|
properties:
|
|
deleted_resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Resource ID whose alias was removed
|
|
|
|
ListCompliancePortalFilesInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/CompliancePortalFileOrderBy"
|
|
description: Compliance portal file order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListCompliancePortalFilesOutput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_files
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
compliance_portal_files:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/CompliancePortalFile"
|
|
|
|
DeleteCompliancePortalFileInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal file ID
|
|
|
|
DeleteCompliancePortalFileOutput:
|
|
type: object
|
|
required:
|
|
- deleted_compliance_portal_file_id
|
|
properties:
|
|
deleted_compliance_portal_file_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted compliance portal file ID
|
|
|
|
ListComplianceCustomLinksInput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_id
|
|
properties:
|
|
compliance_portal_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ComplianceCustomLinkOrderBy"
|
|
description: Compliance custom link order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListComplianceCustomLinksOutput:
|
|
type: object
|
|
required:
|
|
- compliance_custom_links
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
compliance_custom_links:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ComplianceCustomLink"
|
|
|
|
AddComplianceCustomLinkInput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_id
|
|
- name
|
|
- url
|
|
properties:
|
|
compliance_portal_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal ID
|
|
name:
|
|
type: string
|
|
description: Custom Link name
|
|
url:
|
|
type: string
|
|
description: Custom Link
|
|
|
|
AddComplianceCustomLinkOutput:
|
|
type: object
|
|
required:
|
|
- compliance_custom_link
|
|
properties:
|
|
compliance_custom_link:
|
|
$ref: "#/components/schemas/ComplianceCustomLink"
|
|
|
|
UpdateComplianceCustomLinkInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance custom link ID
|
|
name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Custom Link name
|
|
go.probo.inc/mcpgen/omittable: true
|
|
url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Custom Link
|
|
go.probo.inc/mcpgen/omittable: true
|
|
rank:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Custom Link rank
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateComplianceCustomLinkOutput:
|
|
type: object
|
|
required:
|
|
- compliance_custom_link
|
|
properties:
|
|
compliance_custom_link:
|
|
$ref: "#/components/schemas/ComplianceCustomLink"
|
|
|
|
DeleteComplianceCustomLinkInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance custom link ID
|
|
|
|
DeleteComplianceCustomLinkOutput:
|
|
type: object
|
|
required:
|
|
- deleted_compliance_custom_link_id
|
|
properties:
|
|
deleted_compliance_custom_link_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted compliance custom link ID
|
|
|
|
CreateCustomDomainInput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_id
|
|
- domain
|
|
properties:
|
|
compliance_portal_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal ID
|
|
domain:
|
|
type: string
|
|
description: Custom domain name
|
|
|
|
CreateCustomDomainOutput:
|
|
type: object
|
|
required:
|
|
- custom_domain
|
|
properties:
|
|
custom_domain:
|
|
$ref: "#/components/schemas/CustomDomain"
|
|
|
|
DeleteCustomDomainInput:
|
|
type: object
|
|
required:
|
|
- compliance_portal_id
|
|
properties:
|
|
compliance_portal_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Compliance portal ID
|
|
|
|
DeleteCustomDomainOutput:
|
|
type: object
|
|
required:
|
|
- deleted_custom_domain
|
|
properties:
|
|
deleted_custom_domain:
|
|
$ref: "#/components/schemas/CustomDomain"
|
|
|
|
CookieBanner:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- origin
|
|
- state
|
|
- cookie_policy_url
|
|
- consent_expiry_days
|
|
- show_branding
|
|
- default_language
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Banner name
|
|
origin:
|
|
type: string
|
|
description: Website origin (scheme + host)
|
|
state:
|
|
type: string
|
|
enum: [ACTIVE, INACTIVE]
|
|
description: Banner state
|
|
privacy_policy_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Privacy policy URL
|
|
cookie_policy_url:
|
|
type: string
|
|
description: Cookie policy URL
|
|
consent_expiry_days:
|
|
type: integer
|
|
description: Days until consent expires
|
|
show_branding:
|
|
type: boolean
|
|
description: Whether to show Probo branding
|
|
default_language:
|
|
type: string
|
|
description: Default language code
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Last update timestamp
|
|
|
|
CookieCategory:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- cookie_banner_id
|
|
- name
|
|
- slug
|
|
- description
|
|
- kind
|
|
- rank
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie category ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
name:
|
|
type: string
|
|
description: Category name
|
|
slug:
|
|
type: string
|
|
description: Category slug
|
|
description:
|
|
type: string
|
|
description: Category description
|
|
kind:
|
|
type: string
|
|
enum: [NORMAL, NECESSARY, UNCATEGORISED]
|
|
description: Category kind
|
|
rank:
|
|
type: integer
|
|
description: Display order rank
|
|
gcm_consent_types:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Google Consent Mode types
|
|
posthog_consent:
|
|
type: boolean
|
|
description: Whether this category controls PostHog consent
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Last update timestamp
|
|
|
|
TrackerPattern:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- cookie_banner_id
|
|
- cookie_category_id
|
|
- tracker_type
|
|
- pattern
|
|
- match_type
|
|
- display_name
|
|
- description
|
|
- source
|
|
- excluded
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Tracker pattern ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
cookie_category_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie category ID
|
|
tracker_type:
|
|
type: string
|
|
enum: [COOKIE, LOCAL_STORAGE, SESSION_STORAGE, INDEXED_DB, CACHE_STORAGE]
|
|
description: Type of tracker
|
|
pattern:
|
|
type: string
|
|
description: Tracker name pattern
|
|
match_type:
|
|
type: string
|
|
enum: [EXACT, GLOB]
|
|
description: "Pattern match type. GLOB uses * as single wildcard (e.g. ph_phc_*_posthog)"
|
|
display_name:
|
|
type: string
|
|
description: Human-friendly display name
|
|
max_age_seconds:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
description: Cookie max age in seconds
|
|
description:
|
|
type: string
|
|
description: Pattern description
|
|
source:
|
|
type: string
|
|
enum: [SCRIPT, PRE_EXISTING, EXTENSION]
|
|
description: How the pattern was discovered
|
|
excluded:
|
|
type: boolean
|
|
description: Whether this pattern is excluded from the consent banner
|
|
last_matched_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Timestamp when a cookie last matched this pattern
|
|
common_tracker_pattern_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Linked common tracker-pattern catalog ID, if any. Non-null indicates the pattern was matched to the global catalog (description may originate from the seed or agents); null means no catalog link.
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Last update timestamp
|
|
|
|
TrackerResource:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- cookie_banner_id
|
|
- cookie_category_id
|
|
- resource_type
|
|
- origin
|
|
- path
|
|
- display_name
|
|
- description
|
|
- excluded
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Tracker resource ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
cookie_category_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie category ID
|
|
resource_type:
|
|
type: string
|
|
enum: [SCRIPT, IFRAME, IMAGE, STYLESHEET, FONT, BEACON, FETCH, MEDIA, SERVICE_WORKER]
|
|
description: Type of tracked resource
|
|
origin:
|
|
type: string
|
|
description: Resource origin (scheme://host[:port])
|
|
path:
|
|
type: string
|
|
description: Resource path
|
|
display_name:
|
|
type: string
|
|
description: Human-friendly display name
|
|
description:
|
|
type: string
|
|
description: Resource description
|
|
excluded:
|
|
type: boolean
|
|
description: Whether this resource is excluded from the consent banner
|
|
last_detected_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Timestamp when this resource was last detected
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Last update timestamp
|
|
|
|
CookieBannerVersion:
|
|
type: object
|
|
required:
|
|
- id
|
|
- cookie_banner_id
|
|
- version
|
|
- state
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Version ID
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
version:
|
|
type: integer
|
|
description: Version number
|
|
state:
|
|
type: string
|
|
enum: [DRAFT, PUBLISHED]
|
|
description: Version state
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Last update timestamp
|
|
|
|
CookieBannerTranslation:
|
|
type: object
|
|
required:
|
|
- id
|
|
- cookie_banner_id
|
|
- language
|
|
- translations
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Translation ID
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
language:
|
|
type: string
|
|
description: Language code
|
|
translations:
|
|
type: string
|
|
description: Translation JSON string
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Last update timestamp
|
|
|
|
CookieConsentRecord:
|
|
type: object
|
|
required:
|
|
- id
|
|
- cookie_banner_id
|
|
- cookie_banner_version_id
|
|
- visitor_id
|
|
- consent_data
|
|
- action
|
|
- sdk_version
|
|
- created_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Consent record ID
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
cookie_banner_version_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Banner version ID
|
|
visitor_id:
|
|
type: string
|
|
description: Visitor identifier
|
|
ip_address:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Anonymized IP address
|
|
user_agent:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: User agent string
|
|
consent_data:
|
|
type: string
|
|
description: Consent data JSON
|
|
action:
|
|
type: string
|
|
enum: [ACCEPT_ALL, REJECT_ALL, CUSTOMIZE, GPC]
|
|
description: Consent action taken
|
|
sdk_version:
|
|
type: string
|
|
description: SDK version
|
|
regulation:
|
|
$ref: "#/components/schemas/Regulation"
|
|
description: Applicable regulation
|
|
nullable: true
|
|
regulation_source:
|
|
$ref: "#/components/schemas/RegulationSource"
|
|
description: Whether the regulation was detected from geolocation or defaulted to GDPR
|
|
nullable: true
|
|
country_code:
|
|
$ref: "#/components/schemas/CountryCode"
|
|
description: Visitor country code (ISO 3166-1 alpha-2)
|
|
nullable: true
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
|
|
ListCookieBannersInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
size:
|
|
type: integer
|
|
description: Page size (default 100)
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Pagination cursor
|
|
|
|
ListCookieBannersOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banners
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
cookie_banners:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/CookieBanner"
|
|
|
|
GetCookieBannerInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
|
|
GetCookieBannerOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner
|
|
properties:
|
|
cookie_banner:
|
|
$ref: "#/components/schemas/CookieBanner"
|
|
|
|
AddCookieBannerInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- origin
|
|
- cookie_policy_url
|
|
- consent_expiry_days
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Banner name
|
|
origin:
|
|
type: string
|
|
description: Website origin
|
|
privacy_policy_url:
|
|
type: string
|
|
description: Privacy policy URL
|
|
cookie_policy_url:
|
|
type: string
|
|
description: Cookie policy URL
|
|
consent_expiry_days:
|
|
type: integer
|
|
description: Days until consent expires
|
|
|
|
AddCookieBannerOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner
|
|
properties:
|
|
cookie_banner:
|
|
$ref: "#/components/schemas/CookieBanner"
|
|
|
|
UpdateCookieBannerInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
privacy_policy_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
cookie_policy_url:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
consent_expiry_days:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
default_language:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateCookieBannerOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner
|
|
properties:
|
|
cookie_banner:
|
|
$ref: "#/components/schemas/CookieBanner"
|
|
|
|
DeleteCookieBannerInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
|
|
DeleteCookieBannerOutput:
|
|
type: object
|
|
required:
|
|
- deleted_id
|
|
properties:
|
|
deleted_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
ActivateCookieBannerInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
|
|
ActivateCookieBannerOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner
|
|
properties:
|
|
cookie_banner:
|
|
$ref: "#/components/schemas/CookieBanner"
|
|
|
|
DeactivateCookieBannerInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
|
|
DeactivateCookieBannerOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner
|
|
properties:
|
|
cookie_banner:
|
|
$ref: "#/components/schemas/CookieBanner"
|
|
|
|
ListCookieCategoriesInput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_id
|
|
properties:
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Cookie banner ID
|
|
size:
|
|
type: integer
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
|
|
ListCookieCategoriesOutput:
|
|
type: object
|
|
required:
|
|
- cookie_categories
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
cookie_categories:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/CookieCategory"
|
|
|
|
GetCookieCategoryInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
GetCookieCategoryOutput:
|
|
type: object
|
|
required:
|
|
- cookie_category
|
|
properties:
|
|
cookie_category:
|
|
$ref: "#/components/schemas/CookieCategory"
|
|
|
|
AddCookieCategoryInput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_id
|
|
- name
|
|
- slug
|
|
- description
|
|
- rank
|
|
properties:
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
slug:
|
|
type: string
|
|
description:
|
|
type: string
|
|
rank:
|
|
type: integer
|
|
|
|
AddCookieCategoryOutput:
|
|
type: object
|
|
required:
|
|
- cookie_category
|
|
properties:
|
|
cookie_category:
|
|
$ref: "#/components/schemas/CookieCategory"
|
|
|
|
UpdateCookieCategoryInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
slug:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateCookieCategoryOutput:
|
|
type: object
|
|
required:
|
|
- cookie_category
|
|
properties:
|
|
cookie_category:
|
|
$ref: "#/components/schemas/CookieCategory"
|
|
|
|
DeleteCookieCategoryInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
DeleteCookieCategoryOutput:
|
|
type: object
|
|
required:
|
|
- deleted_id
|
|
properties:
|
|
deleted_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
ReorderCookieCategoryInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
- rank
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
rank:
|
|
type: integer
|
|
|
|
ReorderCookieCategoryOutput:
|
|
type: object
|
|
required:
|
|
- cookie_category
|
|
properties:
|
|
cookie_category:
|
|
$ref: "#/components/schemas/CookieCategory"
|
|
|
|
ListTrackerPatternsInput:
|
|
type: object
|
|
required:
|
|
- cookie_category_id
|
|
properties:
|
|
cookie_category_id:
|
|
$ref: "#/components/schemas/GID"
|
|
size:
|
|
type: integer
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
|
|
ListTrackerPatternsOutput:
|
|
type: object
|
|
required:
|
|
- tracker_patterns
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
tracker_patterns:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/TrackerPattern"
|
|
|
|
GetTrackerPatternInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
GetTrackerPatternOutput:
|
|
type: object
|
|
required:
|
|
- tracker_pattern
|
|
properties:
|
|
tracker_pattern:
|
|
$ref: "#/components/schemas/TrackerPattern"
|
|
|
|
AddTrackerPatternInput:
|
|
type: object
|
|
required:
|
|
- cookie_category_id
|
|
- tracker_type
|
|
- pattern
|
|
- match_type
|
|
- display_name
|
|
- description
|
|
properties:
|
|
cookie_category_id:
|
|
$ref: "#/components/schemas/GID"
|
|
tracker_type:
|
|
type: string
|
|
enum: [COOKIE, LOCAL_STORAGE, SESSION_STORAGE, INDEXED_DB, CACHE_STORAGE]
|
|
pattern:
|
|
type: string
|
|
match_type:
|
|
type: string
|
|
enum: [EXACT, GLOB]
|
|
display_name:
|
|
type: string
|
|
max_age_seconds:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
|
|
AddTrackerPatternOutput:
|
|
type: object
|
|
required:
|
|
- tracker_pattern
|
|
properties:
|
|
tracker_pattern:
|
|
$ref: "#/components/schemas/TrackerPattern"
|
|
|
|
UpdateTrackerPatternInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
max_age_seconds:
|
|
type:
|
|
- integer
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
excluded:
|
|
type:
|
|
- boolean
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateTrackerPatternOutput:
|
|
type: object
|
|
required:
|
|
- tracker_pattern
|
|
properties:
|
|
tracker_pattern:
|
|
$ref: "#/components/schemas/TrackerPattern"
|
|
|
|
DeleteTrackerPatternInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
DeleteTrackerPatternOutput:
|
|
type: object
|
|
required:
|
|
- deleted_id
|
|
properties:
|
|
deleted_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
MoveTrackerPatternToCategoryInput:
|
|
type: object
|
|
required:
|
|
- tracker_pattern_id
|
|
- target_cookie_category_id
|
|
properties:
|
|
tracker_pattern_id:
|
|
$ref: "#/components/schemas/GID"
|
|
target_cookie_category_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
MoveTrackerPatternToCategoryOutput:
|
|
type: object
|
|
required:
|
|
- tracker_pattern
|
|
properties:
|
|
tracker_pattern:
|
|
$ref: "#/components/schemas/TrackerPattern"
|
|
|
|
ListTrackerResourcesInput:
|
|
type: object
|
|
required:
|
|
- cookie_category_id
|
|
properties:
|
|
cookie_category_id:
|
|
$ref: "#/components/schemas/GID"
|
|
size:
|
|
type: integer
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
|
|
ListTrackerResourcesOutput:
|
|
type: object
|
|
required:
|
|
- tracker_resources
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
tracker_resources:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/TrackerResource"
|
|
|
|
GetTrackerResourceInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
GetTrackerResourceOutput:
|
|
type: object
|
|
required:
|
|
- tracker_resource
|
|
properties:
|
|
tracker_resource:
|
|
$ref: "#/components/schemas/TrackerResource"
|
|
|
|
AddTrackerResourceInput:
|
|
type: object
|
|
required:
|
|
- cookie_category_id
|
|
- resource_type
|
|
- origin
|
|
- path
|
|
- display_name
|
|
properties:
|
|
cookie_category_id:
|
|
$ref: "#/components/schemas/GID"
|
|
resource_type:
|
|
type: string
|
|
enum: [SCRIPT, IFRAME, IMAGE, STYLESHEET, FONT, BEACON, FETCH, MEDIA, SERVICE_WORKER]
|
|
origin:
|
|
type: string
|
|
path:
|
|
type: string
|
|
display_name:
|
|
type: string
|
|
description:
|
|
type: string
|
|
|
|
AddTrackerResourceOutput:
|
|
type: object
|
|
required:
|
|
- tracker_resource
|
|
properties:
|
|
tracker_resource:
|
|
$ref: "#/components/schemas/TrackerResource"
|
|
|
|
UpdateTrackerResourceInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
display_name:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
excluded:
|
|
type:
|
|
- boolean
|
|
- "null"
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateTrackerResourceOutput:
|
|
type: object
|
|
required:
|
|
- tracker_resource
|
|
properties:
|
|
tracker_resource:
|
|
$ref: "#/components/schemas/TrackerResource"
|
|
|
|
DeleteTrackerResourceInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
DeleteTrackerResourceOutput:
|
|
type: object
|
|
required:
|
|
- deleted_id
|
|
properties:
|
|
deleted_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
MoveTrackerResourceToCategoryInput:
|
|
type: object
|
|
required:
|
|
- tracker_resource_id
|
|
- target_cookie_category_id
|
|
properties:
|
|
tracker_resource_id:
|
|
$ref: "#/components/schemas/GID"
|
|
target_cookie_category_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
MoveTrackerResourceToCategoryOutput:
|
|
type: object
|
|
required:
|
|
- tracker_resource
|
|
properties:
|
|
tracker_resource:
|
|
$ref: "#/components/schemas/TrackerResource"
|
|
|
|
PublishCookieBannerVersionInput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_id
|
|
properties:
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
PublishCookieBannerVersionOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_version
|
|
properties:
|
|
cookie_banner_version:
|
|
$ref: "#/components/schemas/CookieBannerVersion"
|
|
|
|
RegenerateCookieBannerTrackerPolicyInput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_id
|
|
properties:
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
RegenerateCookieBannerTrackerPolicyOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner
|
|
properties:
|
|
cookie_banner:
|
|
$ref: "#/components/schemas/CookieBanner"
|
|
|
|
ListCookieBannerVersionsInput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_id
|
|
properties:
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
size:
|
|
type: integer
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
|
|
ListCookieBannerVersionsOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_versions
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
cookie_banner_versions:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/CookieBannerVersion"
|
|
|
|
UpsertCookieBannerTranslationInput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_id
|
|
- language
|
|
- translations
|
|
properties:
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
language:
|
|
type: string
|
|
translations:
|
|
type: string
|
|
description: Translation JSON string
|
|
|
|
UpsertCookieBannerTranslationOutput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_translation
|
|
properties:
|
|
cookie_banner_translation:
|
|
$ref: "#/components/schemas/CookieBannerTranslation"
|
|
|
|
ListCookieConsentRecordsInput:
|
|
type: object
|
|
required:
|
|
- cookie_banner_id
|
|
properties:
|
|
cookie_banner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
size:
|
|
type: integer
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
action:
|
|
type: string
|
|
enum: [ACCEPT_ALL, REJECT_ALL, CUSTOMIZE, GPC]
|
|
description: Filter by consent action
|
|
visitor_id:
|
|
type: string
|
|
description: Filter by visitor ID
|
|
version:
|
|
type: integer
|
|
description: Filter by banner version number
|
|
|
|
ListCookieConsentRecordsOutput:
|
|
type: object
|
|
required:
|
|
- cookie_consent_records
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
cookie_consent_records:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/CookieConsentRecord"
|
|
|
|
GetCookieConsentRecordInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
|
|
GetCookieConsentRecordOutput:
|
|
type: object
|
|
required:
|
|
- cookie_consent_record
|
|
properties:
|
|
cookie_consent_record:
|
|
$ref: "#/components/schemas/CookieConsentRecord"
|
|
|
|
SCIMBridgeType:
|
|
type: string
|
|
enum:
|
|
- GOOGLE_WORKSPACE
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.SCIMBridgeType
|
|
|
|
SCIMBridgeState:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- ACTIVE
|
|
- SYNCING
|
|
- FAILED
|
|
- DISABLED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.SCIMBridgeState
|
|
|
|
SCIMEventOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.SCIMEventOrderField
|
|
|
|
SCIMEventOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/SCIMEventOrderField"
|
|
description: SCIM event order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: SCIM event order direction
|
|
|
|
SCIMConfiguration:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM configuration ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
bridge_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Associated SCIM bridge ID, if any
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Last update timestamp
|
|
|
|
SCIMBridge:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- scim_configuration_id
|
|
- type
|
|
- state
|
|
- excluded_user_names
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM bridge ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
scim_configuration_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM configuration ID
|
|
connector_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Connector ID, if any
|
|
type:
|
|
$ref: "#/components/schemas/SCIMBridgeType"
|
|
description: Bridge type
|
|
state:
|
|
$ref: "#/components/schemas/SCIMBridgeState"
|
|
description: Bridge state
|
|
excluded_user_names:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User names excluded from SCIM sync
|
|
last_synced_at:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Last successful sync timestamp
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Last update timestamp
|
|
|
|
SCIMEvent:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- scim_configuration_id
|
|
- method
|
|
- path
|
|
- status_code
|
|
- user_name
|
|
- ip_address
|
|
- created_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM event ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
scim_configuration_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM configuration ID
|
|
method:
|
|
type: string
|
|
description: HTTP method
|
|
path:
|
|
type: string
|
|
description: Request path
|
|
status_code:
|
|
type: integer
|
|
description: HTTP status code
|
|
request_body:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Request body
|
|
response_body:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Response body
|
|
error_message:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Error message, if any
|
|
user_name:
|
|
type: string
|
|
description: SCIM user name
|
|
ip_address:
|
|
type: string
|
|
description: Client IP address
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
|
|
GetSCIMConfigurationInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
|
|
GetSCIMConfigurationOutput:
|
|
type: object
|
|
required:
|
|
- scim_configuration
|
|
properties:
|
|
scim_configuration:
|
|
$ref: "#/components/schemas/SCIMConfiguration"
|
|
|
|
CreateSCIMConfigurationInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
connector_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Optional connector ID to create a SCIM bridge
|
|
|
|
CreateSCIMConfigurationOutput:
|
|
type: object
|
|
required:
|
|
- scim_configuration
|
|
- token
|
|
properties:
|
|
scim_configuration:
|
|
$ref: "#/components/schemas/SCIMConfiguration"
|
|
scim_bridge:
|
|
$ref: "#/components/schemas/SCIMBridge"
|
|
description: SCIM bridge, if a connector ID was provided
|
|
token:
|
|
type: string
|
|
description: Plaintext SCIM bearer token (only returned at creation time)
|
|
|
|
DeleteSCIMConfigurationInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- scim_configuration_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
scim_configuration_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM configuration ID to delete
|
|
|
|
DeleteSCIMConfigurationOutput:
|
|
type: object
|
|
required:
|
|
- deleted_scim_configuration_id
|
|
properties:
|
|
deleted_scim_configuration_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted SCIM configuration ID
|
|
|
|
RegenerateSCIMTokenInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- scim_configuration_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
scim_configuration_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM configuration ID
|
|
|
|
RegenerateSCIMTokenOutput:
|
|
type: object
|
|
required:
|
|
- scim_configuration
|
|
- token
|
|
properties:
|
|
scim_configuration:
|
|
$ref: "#/components/schemas/SCIMConfiguration"
|
|
token:
|
|
type: string
|
|
description: New plaintext SCIM bearer token
|
|
|
|
GetSCIMBridgeInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM bridge ID
|
|
|
|
GetSCIMBridgeOutput:
|
|
type: object
|
|
required:
|
|
- scim_bridge
|
|
properties:
|
|
scim_bridge:
|
|
$ref: "#/components/schemas/SCIMBridge"
|
|
|
|
UpdateSCIMBridgeInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- scim_bridge_id
|
|
- excluded_user_names
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
scim_bridge_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM bridge ID
|
|
excluded_user_names:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: User names to exclude from SCIM sync
|
|
|
|
UpdateSCIMBridgeOutput:
|
|
type: object
|
|
required:
|
|
- scim_bridge
|
|
properties:
|
|
scim_bridge:
|
|
$ref: "#/components/schemas/SCIMBridge"
|
|
|
|
ListSCIMEventsInput:
|
|
type: object
|
|
required:
|
|
- scim_configuration_id
|
|
properties:
|
|
scim_configuration_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: SCIM configuration ID
|
|
order_by:
|
|
$ref: "#/components/schemas/SCIMEventOrderBy"
|
|
description: SCIM event order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListSCIMEventsOutput:
|
|
type: object
|
|
required:
|
|
- scim_events
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
scim_events:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/SCIMEvent"
|
|
|
|
RiskAssessmentNodeType:
|
|
type: string
|
|
enum:
|
|
- ENTITY
|
|
- ASSET
|
|
- DATA
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskAssessmentNodeType
|
|
|
|
RiskAssessmentOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskAssessmentOrderField
|
|
|
|
RiskAssessmentOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskAssessmentOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
RiskAssessmentScopeOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskAssessmentScopeOrderField
|
|
|
|
RiskAssessmentScopeOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskAssessmentScopeOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
RiskAssessmentNodeOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskAssessmentNodeOrderField
|
|
|
|
RiskAssessmentNodeOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskAssessmentNodeOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
RiskAssessmentBoundaryOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskAssessmentBoundaryOrderField
|
|
|
|
RiskAssessmentBoundaryOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskAssessmentBoundaryOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
RiskAssessmentProcessOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskAssessmentProcessOrderField
|
|
|
|
RiskAssessmentProcessOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskAssessmentProcessOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
RiskAssessmentThreatOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskAssessmentThreatOrderField
|
|
|
|
RiskAssessmentThreatOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskAssessmentThreatOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
RiskAssessmentScenarioOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskAssessmentScenarioOrderField
|
|
|
|
RiskAssessmentScenarioOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskAssessmentScenarioOrderField"
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
|
|
RiskAssessment:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
RiskAssessmentScope:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- risk_assessment_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
risk_assessment_id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
RiskAssessmentNode:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- risk_assessment_scope_id
|
|
- node_type
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
boundary_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the boundary that contains this node, if any
|
|
node_type:
|
|
$ref: "#/components/schemas/RiskAssessmentNodeType"
|
|
name:
|
|
type: string
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
RiskAssessmentBoundary:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- risk_assessment_scope_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
parent_boundary_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the parent boundary, if this boundary is nested
|
|
name:
|
|
type: string
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
RiskAssessmentProcess:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- risk_assessment_scope_id
|
|
- source_node_id
|
|
- target_node_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
source_node_id:
|
|
$ref: "#/components/schemas/GID"
|
|
target_node_id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
RiskAssessmentThreat:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- risk_assessment_scope_id
|
|
- process_id
|
|
- name
|
|
- category
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
process_id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
category:
|
|
type: string
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
RiskAssessmentScenario:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- risk_assessment_scope_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
name:
|
|
type: string
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
|
|
ListRiskAssessmentsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskAssessmentOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListRiskAssessmentsOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessments
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risk_assessments:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/RiskAssessment"
|
|
|
|
GetRiskAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment ID
|
|
|
|
GetRiskAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment
|
|
properties:
|
|
risk_assessment:
|
|
$ref: "#/components/schemas/RiskAssessment"
|
|
|
|
AddRiskAssessmentInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment name
|
|
description:
|
|
type: string
|
|
description: Risk assessment description
|
|
|
|
AddRiskAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment
|
|
properties:
|
|
risk_assessment:
|
|
$ref: "#/components/schemas/RiskAssessment"
|
|
|
|
UpdateRiskAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Risk assessment description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateRiskAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment
|
|
properties:
|
|
risk_assessment:
|
|
$ref: "#/components/schemas/RiskAssessment"
|
|
|
|
DeleteRiskAssessmentInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment ID
|
|
|
|
DeleteRiskAssessmentOutput:
|
|
type: object
|
|
required:
|
|
- deleted_risk_assessment_id
|
|
properties:
|
|
deleted_risk_assessment_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted risk assessment ID
|
|
|
|
ListRiskAssessmentScopesInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_id
|
|
properties:
|
|
risk_assessment_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskAssessmentScopeOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListRiskAssessmentScopesOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scopes
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risk_assessment_scopes:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/RiskAssessmentScope"
|
|
|
|
GetRiskAssessmentScopeInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
|
|
GetRiskAssessmentScopeOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope
|
|
properties:
|
|
risk_assessment_scope:
|
|
$ref: "#/components/schemas/RiskAssessmentScope"
|
|
|
|
GetRiskAssessmentScopeMermaidChartInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
|
|
GetRiskAssessmentScopeMermaidChartOutput:
|
|
type: object
|
|
required:
|
|
- mermaid_chart
|
|
properties:
|
|
mermaid_chart:
|
|
type: string
|
|
description: Mermaid chart of the scope
|
|
|
|
AddRiskAssessmentScopeInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_id
|
|
- name
|
|
properties:
|
|
risk_assessment_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment scope name
|
|
|
|
AddRiskAssessmentScopeOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope
|
|
properties:
|
|
risk_assessment_scope:
|
|
$ref: "#/components/schemas/RiskAssessmentScope"
|
|
|
|
UpdateRiskAssessmentScopeInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment scope name
|
|
|
|
UpdateRiskAssessmentScopeOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope
|
|
properties:
|
|
risk_assessment_scope:
|
|
$ref: "#/components/schemas/RiskAssessmentScope"
|
|
|
|
DeleteRiskAssessmentScopeInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
|
|
DeleteRiskAssessmentScopeOutput:
|
|
type: object
|
|
required:
|
|
- deleted_risk_assessment_scope_id
|
|
properties:
|
|
deleted_risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted risk assessment scope ID
|
|
|
|
ListRiskAssessmentNodesInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskAssessmentNodeOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListRiskAssessmentNodesOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_nodes
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risk_assessment_nodes:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/RiskAssessmentNode"
|
|
|
|
GetRiskAssessmentNodeInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment node ID
|
|
|
|
GetRiskAssessmentNodeOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_node
|
|
properties:
|
|
risk_assessment_node:
|
|
$ref: "#/components/schemas/RiskAssessmentNode"
|
|
|
|
AddRiskAssessmentNodeInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
- node_type
|
|
- name
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
boundary_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the boundary that contains this node (optional)
|
|
node_type:
|
|
$ref: "#/components/schemas/RiskAssessmentNodeType"
|
|
description: Node type
|
|
name:
|
|
type: string
|
|
description: Risk assessment node name
|
|
|
|
AddRiskAssessmentNodeOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_node
|
|
properties:
|
|
risk_assessment_node:
|
|
$ref: "#/components/schemas/RiskAssessmentNode"
|
|
|
|
UpdateRiskAssessmentNodeInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment node ID
|
|
boundary_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the boundary that contains this node (optional)
|
|
node_type:
|
|
$ref: "#/components/schemas/RiskAssessmentNodeType"
|
|
description: Node type
|
|
name:
|
|
type: string
|
|
description: Risk assessment node name
|
|
|
|
UpdateRiskAssessmentNodeOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_node
|
|
properties:
|
|
risk_assessment_node:
|
|
$ref: "#/components/schemas/RiskAssessmentNode"
|
|
|
|
DeleteRiskAssessmentNodeInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment node ID
|
|
|
|
DeleteRiskAssessmentNodeOutput:
|
|
type: object
|
|
required:
|
|
- deleted_risk_assessment_node_id
|
|
properties:
|
|
deleted_risk_assessment_node_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted risk assessment node ID
|
|
|
|
ListRiskAssessmentBoundariesInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskAssessmentBoundaryOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListRiskAssessmentBoundariesOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_boundaries
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risk_assessment_boundaries:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/RiskAssessmentBoundary"
|
|
|
|
GetRiskAssessmentBoundaryInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment boundary ID
|
|
|
|
GetRiskAssessmentBoundaryOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_boundary
|
|
properties:
|
|
risk_assessment_boundary:
|
|
$ref: "#/components/schemas/RiskAssessmentBoundary"
|
|
|
|
AddRiskAssessmentBoundaryInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
- name
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
parent_boundary_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the parent boundary (optional, for nested boundaries)
|
|
name:
|
|
type: string
|
|
description: Risk assessment boundary name
|
|
|
|
AddRiskAssessmentBoundaryOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_boundary
|
|
properties:
|
|
risk_assessment_boundary:
|
|
$ref: "#/components/schemas/RiskAssessmentBoundary"
|
|
|
|
UpdateRiskAssessmentBoundaryInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment boundary ID
|
|
parent_boundary_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: ID of the parent boundary (optional, for nested boundaries)
|
|
name:
|
|
type: string
|
|
description: Risk assessment boundary name
|
|
|
|
UpdateRiskAssessmentBoundaryOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_boundary
|
|
properties:
|
|
risk_assessment_boundary:
|
|
$ref: "#/components/schemas/RiskAssessmentBoundary"
|
|
|
|
DeleteRiskAssessmentBoundaryInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment boundary ID
|
|
|
|
DeleteRiskAssessmentBoundaryOutput:
|
|
type: object
|
|
required:
|
|
- deleted_risk_assessment_boundary_id
|
|
properties:
|
|
deleted_risk_assessment_boundary_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted risk assessment boundary ID
|
|
|
|
ListRiskAssessmentProcessesInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskAssessmentProcessOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListRiskAssessmentProcessesOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_processes
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risk_assessment_processes:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/RiskAssessmentProcess"
|
|
|
|
GetRiskAssessmentProcessInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment process ID
|
|
|
|
GetRiskAssessmentProcessOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_process
|
|
properties:
|
|
risk_assessment_process:
|
|
$ref: "#/components/schemas/RiskAssessmentProcess"
|
|
|
|
AddRiskAssessmentProcessInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
- source_node_id
|
|
- target_node_id
|
|
- name
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
source_node_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Source node ID
|
|
target_node_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Target node ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment process name
|
|
|
|
AddRiskAssessmentProcessOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_process
|
|
properties:
|
|
risk_assessment_process:
|
|
$ref: "#/components/schemas/RiskAssessmentProcess"
|
|
|
|
UpdateRiskAssessmentProcessInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment process ID
|
|
source_node_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Source node ID
|
|
target_node_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Target node ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment process name
|
|
|
|
UpdateRiskAssessmentProcessOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_process
|
|
properties:
|
|
risk_assessment_process:
|
|
$ref: "#/components/schemas/RiskAssessmentProcess"
|
|
|
|
DeleteRiskAssessmentProcessInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment process ID
|
|
|
|
DeleteRiskAssessmentProcessOutput:
|
|
type: object
|
|
required:
|
|
- deleted_risk_assessment_process_id
|
|
properties:
|
|
deleted_risk_assessment_process_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted risk assessment process ID
|
|
|
|
ListRiskAssessmentThreatsInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskAssessmentThreatOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListRiskAssessmentThreatsOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_threats
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risk_assessment_threats:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/RiskAssessmentThreat"
|
|
|
|
GetRiskAssessmentThreatInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment threat ID
|
|
|
|
GetRiskAssessmentThreatOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_threat
|
|
properties:
|
|
risk_assessment_threat:
|
|
$ref: "#/components/schemas/RiskAssessmentThreat"
|
|
|
|
AddRiskAssessmentThreatInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
- process_id
|
|
- name
|
|
- category
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
process_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Process ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment threat name
|
|
category:
|
|
type: string
|
|
description: Risk assessment threat category
|
|
|
|
AddRiskAssessmentThreatOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_threat
|
|
properties:
|
|
risk_assessment_threat:
|
|
$ref: "#/components/schemas/RiskAssessmentThreat"
|
|
|
|
UpdateRiskAssessmentThreatInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment threat ID
|
|
process_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Process ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment threat name
|
|
category:
|
|
type: string
|
|
description: Risk assessment threat category
|
|
|
|
UpdateRiskAssessmentThreatOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_threat
|
|
properties:
|
|
risk_assessment_threat:
|
|
$ref: "#/components/schemas/RiskAssessmentThreat"
|
|
|
|
DeleteRiskAssessmentThreatInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment threat ID
|
|
|
|
DeleteRiskAssessmentThreatOutput:
|
|
type: object
|
|
required:
|
|
- deleted_risk_assessment_threat_id
|
|
properties:
|
|
deleted_risk_assessment_threat_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted risk assessment threat ID
|
|
|
|
ListRiskAssessmentScenariosInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskAssessmentScenarioOrderBy"
|
|
description: Order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListRiskAssessmentScenariosOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scenarios
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risk_assessment_scenarios:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/RiskAssessmentScenario"
|
|
|
|
GetRiskAssessmentScenarioInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scenario ID
|
|
|
|
GetRiskAssessmentScenarioOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scenario
|
|
properties:
|
|
risk_assessment_scenario:
|
|
$ref: "#/components/schemas/RiskAssessmentScenario"
|
|
|
|
AddRiskAssessmentScenarioInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scope_id
|
|
- name
|
|
properties:
|
|
risk_assessment_scope_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scope ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment scenario name
|
|
description:
|
|
type: string
|
|
description: Risk assessment scenario description
|
|
|
|
AddRiskAssessmentScenarioOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scenario
|
|
properties:
|
|
risk_assessment_scenario:
|
|
$ref: "#/components/schemas/RiskAssessmentScenario"
|
|
|
|
UpdateRiskAssessmentScenarioInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scenario ID
|
|
name:
|
|
type: string
|
|
description: Risk assessment scenario name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Risk assessment scenario description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateRiskAssessmentScenarioOutput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scenario
|
|
properties:
|
|
risk_assessment_scenario:
|
|
$ref: "#/components/schemas/RiskAssessmentScenario"
|
|
|
|
DeleteRiskAssessmentScenarioInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scenario ID
|
|
|
|
DeleteRiskAssessmentScenarioOutput:
|
|
type: object
|
|
required:
|
|
- deleted_risk_assessment_scenario_id
|
|
properties:
|
|
deleted_risk_assessment_scenario_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Deleted risk assessment scenario ID
|
|
|
|
LinkRiskAssessmentScenarioThreatInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scenario_id
|
|
- threat_id
|
|
properties:
|
|
risk_assessment_scenario_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scenario ID
|
|
threat_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Threat ID
|
|
|
|
LinkRiskAssessmentScenarioThreatOutput:
|
|
type: object
|
|
|
|
UnlinkRiskAssessmentScenarioThreatInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scenario_id
|
|
- threat_id
|
|
properties:
|
|
risk_assessment_scenario_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scenario ID
|
|
threat_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Threat ID
|
|
|
|
UnlinkRiskAssessmentScenarioThreatOutput:
|
|
type: object
|
|
|
|
LinkRiskAssessmentScenarioRiskInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scenario_id
|
|
- risk_id
|
|
properties:
|
|
risk_assessment_scenario_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scenario ID
|
|
risk_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
|
|
LinkRiskAssessmentScenarioRiskOutput:
|
|
type: object
|
|
|
|
UnlinkRiskAssessmentScenarioRiskInput:
|
|
type: object
|
|
required:
|
|
- risk_assessment_scenario_id
|
|
- risk_id
|
|
properties:
|
|
risk_assessment_scenario_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk assessment scenario ID
|
|
risk_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
|
|
UnlinkRiskAssessmentScenarioRiskOutput:
|
|
type: object
|
|
|
|
tools:
|
|
- name: listOrganizations
|
|
description: List all organizations the user has access to
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListOrganizationsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListOrganizationsOutput"
|
|
- name: listThirdParties
|
|
description: List all thirdParties for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListThirdPartiesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListThirdPartiesOutput"
|
|
- name: listChildThirdParties
|
|
description: List child third parties linked to a parent third party
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListChildThirdPartiesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListChildThirdPartiesOutput"
|
|
- name: listUsers
|
|
description: List all users for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListUsersInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListUsersOutput"
|
|
- name: getUser
|
|
description: Get a user by ID (profile ID)
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetUserInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetUserOutput"
|
|
- name: createUser
|
|
description: Create a new user in the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CreateUserInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CreateUserOutput"
|
|
- name: inviteUser
|
|
description: Invite a user (profile) to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/InviteUserInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/InviteUserOutput"
|
|
- name: updateUser
|
|
description: Update an existing user (profile)
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateUserInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateUserOutput"
|
|
- name: updateMembership
|
|
description: Update a membership role
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateMembershipInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateMembershipOutput"
|
|
- name: removeUser
|
|
description: Remove a user from the organization
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RemoveUserInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RemoveUserOutput"
|
|
- name: archiveUser
|
|
description: Archive a user in the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ArchiveUserInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ArchiveUserOutput"
|
|
- name: addThirdParty
|
|
description: Add a new thirdParty to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddThirdPartyInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddThirdPartyOutput"
|
|
- name: updateThirdParty
|
|
description: Update an existing thirdParty
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateThirdPartyInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateThirdPartyOutput"
|
|
- name: listThirdPartyRiskAssessments
|
|
description: List all risk assessments for a thirdParty
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListThirdPartyRiskAssessmentsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListThirdPartyRiskAssessmentsOutput"
|
|
- name: addThirdPartyRiskAssessment
|
|
description: Add a new risk assessment for a thirdParty
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddThirdPartyRiskAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddThirdPartyRiskAssessmentOutput"
|
|
- name: deleteThirdParty
|
|
description: Delete a thirdParty
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteThirdPartyInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteThirdPartyOutput"
|
|
- name: listThirdPartyContacts
|
|
description: List all contacts for a thirdParty
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListThirdPartyContactsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListThirdPartyContactsOutput"
|
|
- name: addThirdPartyContact
|
|
description: Add a new contact to a thirdParty
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddThirdPartyContactInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddThirdPartyContactOutput"
|
|
- name: updateThirdPartyContact
|
|
description: Update an existing thirdParty contact
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateThirdPartyContactInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateThirdPartyContactOutput"
|
|
- name: deleteThirdPartyContact
|
|
description: Delete a thirdParty contact
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteThirdPartyContactInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteThirdPartyContactOutput"
|
|
- name: listThirdPartyServices
|
|
description: List all services for a thirdParty
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListThirdPartyServicesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListThirdPartyServicesOutput"
|
|
- name: addThirdPartyService
|
|
description: Add a new service to a thirdParty
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddThirdPartyServiceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddThirdPartyServiceOutput"
|
|
- name: updateThirdPartyService
|
|
description: Update an existing thirdParty service
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateThirdPartyServiceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateThirdPartyServiceOutput"
|
|
- name: deleteThirdPartyService
|
|
description: Delete a thirdParty service
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteThirdPartyServiceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteThirdPartyServiceOutput"
|
|
- name: vetThirdParty
|
|
description: Start AI-powered vetting of a third party by crawling its website. Returns immediately; vetting runs in the background.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/VetThirdPartyInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/VetThirdPartyOutput"
|
|
- name: listRisks
|
|
description: List all risks for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRisksInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRisksOutput"
|
|
- name: getRisk
|
|
description: Get a risk by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskOutput"
|
|
- name: addRisk
|
|
description: Add a new risk to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskOutput"
|
|
- name: updateRisk
|
|
description: Update an existing risk
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskOutput"
|
|
- name: deleteRisk
|
|
description: Delete a risk
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskOutput"
|
|
- name: listMeasures
|
|
description: List all measures for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListMeasuresInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListMeasuresOutput"
|
|
- name: getMeasure
|
|
description: Get a measure by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetMeasureOutput"
|
|
- name: addMeasure
|
|
description: Add a new measure to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddMeasureOutput"
|
|
- name: updateMeasure
|
|
description: Update an existing measure
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateMeasureOutput"
|
|
- name: deleteMeasure
|
|
description: Delete a measure
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteMeasureOutput"
|
|
- name: listMeasureRisks
|
|
description: List risks linked to a measure
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListMeasureRisksInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListMeasureRisksOutput"
|
|
- name: listMeasureControls
|
|
description: List controls linked to a measure
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListMeasureControlsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListMeasureControlsOutput"
|
|
- name: listMeasureTasks
|
|
description: List tasks linked to a measure
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListMeasureTasksInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListMeasureTasksOutput"
|
|
- name: listMeasureEvidences
|
|
description: List evidences linked to a measure
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListMeasureEvidencesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListMeasureEvidencesOutput"
|
|
- name: linkMeasure
|
|
description: Link a measure to a resource (control, risk, document, or third party). The resource type is determined from the resource_id GID.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/LinkMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/LinkMeasureOutput"
|
|
- name: unlinkMeasure
|
|
description: Unlink a measure from a resource (control, risk, document, or third party). The resource type is determined from the resource_id GID.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UnlinkMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UnlinkMeasureOutput"
|
|
- name: listMeasureDocuments
|
|
description: List documents linked to a measure
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListMeasureDocumentsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListMeasureDocumentsOutput"
|
|
- name: listFrameworks
|
|
description: List all frameworks for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListFrameworksInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListFrameworksOutput"
|
|
- name: getFramework
|
|
description: Get a framework by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetFrameworkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetFrameworkOutput"
|
|
- name: addFramework
|
|
description: Add a new framework to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddFrameworkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddFrameworkOutput"
|
|
- name: updateFramework
|
|
description: Update an existing framework
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateFrameworkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateFrameworkOutput"
|
|
- name: listAssets
|
|
description: List all assets for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListAssetsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListAssetsOutput"
|
|
- name: getAsset
|
|
description: Get an asset by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetAssetInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetAssetOutput"
|
|
- name: addAsset
|
|
description: Add a new asset to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddAssetInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddAssetOutput"
|
|
- name: updateAsset
|
|
description: Update an existing asset
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateAssetInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateAssetOutput"
|
|
- name: deleteAsset
|
|
description: Delete an asset
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteAssetInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteAssetOutput"
|
|
- name: listData
|
|
description: List all data for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListDataInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListDataOutput"
|
|
- name: getDatum
|
|
description: Get a datum by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetDatumInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetDatumOutput"
|
|
- name: addDatum
|
|
description: Add a new datum to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddDatumInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddDatumOutput"
|
|
- name: updateDatum
|
|
description: Update an existing datum
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateDatumInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateDatumOutput"
|
|
- name: deleteDatum
|
|
description: Delete a datum
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteDatumInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteDatumOutput"
|
|
- name: listFindings
|
|
description: List all findings (nonconformities, observations, exceptions) for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListFindingsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListFindingsOutput"
|
|
- name: getFinding
|
|
description: Get a finding by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetFindingInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetFindingOutput"
|
|
- name: addFinding
|
|
description: Add a new finding (nonconformity, observation, or exception) to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddFindingInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddFindingOutput"
|
|
- name: updateFinding
|
|
description: Update an existing finding
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateFindingInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateFindingOutput"
|
|
- name: deleteFinding
|
|
description: Delete a finding
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteFindingInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteFindingOutput"
|
|
- name: linkFindingAudit
|
|
description: Link a finding to an audit with a reference ID
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/LinkFindingAuditInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/LinkFindingAuditOutput"
|
|
- name: unlinkFindingAudit
|
|
description: Unlink a finding from an audit
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UnlinkFindingAuditInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UnlinkFindingAuditOutput"
|
|
- name: listFindingAudits
|
|
description: List audits linked to a finding
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListFindingAuditsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListFindingAuditsOutput"
|
|
- name: listObligations
|
|
description: List all obligations for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListObligationsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListObligationsOutput"
|
|
- name: getObligation
|
|
description: Get an obligation by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetObligationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetObligationOutput"
|
|
- name: addObligation
|
|
description: Add a new obligation to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddObligationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddObligationOutput"
|
|
- name: updateObligation
|
|
description: Update an existing obligation
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateObligationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateObligationOutput"
|
|
- name: deleteObligation
|
|
description: Delete an obligation
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteObligationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteObligationOutput"
|
|
- name: listProcessingActivities
|
|
description: List all processing activities for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListProcessingActivitiesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListProcessingActivitiesOutput"
|
|
- name: getProcessingActivity
|
|
description: Get a processing activity by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetProcessingActivityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetProcessingActivityOutput"
|
|
- name: addProcessingActivity
|
|
description: Add a new processing activity to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddProcessingActivityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddProcessingActivityOutput"
|
|
- name: updateProcessingActivity
|
|
description: Update an existing processing activity
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateProcessingActivityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateProcessingActivityOutput"
|
|
- name: deleteProcessingActivity
|
|
description: Delete a processing activity
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteProcessingActivityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteProcessingActivityOutput"
|
|
- name: listDataProtectionImpactAssessments
|
|
description: List all data protection impact assessments (DPIAs) for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListDataProtectionImpactAssessmentsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListDataProtectionImpactAssessmentsOutput"
|
|
- name: getDataProtectionImpactAssessment
|
|
description: Get a data protection impact assessment (DPIA) by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetDataProtectionImpactAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetDataProtectionImpactAssessmentOutput"
|
|
- name: addDataProtectionImpactAssessment
|
|
description: Add a new data protection impact assessment (DPIA) for a processing activity
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddDataProtectionImpactAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddDataProtectionImpactAssessmentOutput"
|
|
- name: updateDataProtectionImpactAssessment
|
|
description: Update an existing data protection impact assessment (DPIA)
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateDataProtectionImpactAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateDataProtectionImpactAssessmentOutput"
|
|
- name: deleteDataProtectionImpactAssessment
|
|
description: Delete a data protection impact assessment (DPIA) by ID
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteDataProtectionImpactAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteDataProtectionImpactAssessmentOutput"
|
|
- name: listTransferImpactAssessments
|
|
description: List all transfer impact assessments (TIAs) for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListTransferImpactAssessmentsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListTransferImpactAssessmentsOutput"
|
|
- name: getTransferImpactAssessment
|
|
description: Get a transfer impact assessment (TIA) by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetTransferImpactAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetTransferImpactAssessmentOutput"
|
|
- name: addTransferImpactAssessment
|
|
description: Add a new transfer impact assessment (TIA) for a processing activity
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddTransferImpactAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddTransferImpactAssessmentOutput"
|
|
- name: updateTransferImpactAssessment
|
|
description: Update an existing transfer impact assessment (TIA)
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateTransferImpactAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateTransferImpactAssessmentOutput"
|
|
- name: deleteTransferImpactAssessment
|
|
description: Delete a transfer impact assessment (TIA)
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteTransferImpactAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteTransferImpactAssessmentOutput"
|
|
- name: listAudits
|
|
description: List all audits for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListAuditsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListAuditsOutput"
|
|
- name: getAudit
|
|
description: Get an audit by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetAuditInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetAuditOutput"
|
|
- name: addAudit
|
|
description: Add a new audit to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddAuditInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddAuditOutput"
|
|
- name: updateAudit
|
|
description: Update an existing audit
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateAuditInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateAuditOutput"
|
|
- name: deleteAudit
|
|
description: Delete an audit
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteAuditInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteAuditOutput"
|
|
- name: getAuditReportUrl
|
|
description: Get a presigned download URL for an audit's attached report. Returns a time-limited URL valid for 15 minutes. The audit must have an attached report.
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetAuditReportUrlInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetAuditReportUrlOutput"
|
|
- name: listControls
|
|
description: List all controls for the organization or framework
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListControlsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListControlsOutput"
|
|
- name: getControl
|
|
description: Get a control by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetControlInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetControlOutput"
|
|
- name: addControl
|
|
description: Add a new control to a framework
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddControlInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddControlOutput"
|
|
- name: updateControl
|
|
description: Update an existing control
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateControlInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateControlOutput"
|
|
- name: linkControl
|
|
description: Link a resource to a control (measure, document, audit, or obligation). The resource type is determined from the resource_id GID.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/LinkControlInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/LinkControlOutput"
|
|
- name: unlinkControl
|
|
description: Unlink a resource from a control (measure, document, audit, or obligation). The resource type is determined from the resource_id GID.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UnlinkControlInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UnlinkControlOutput"
|
|
- name: listControlObligations
|
|
description: List obligations linked to a control
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListControlObligationsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListControlObligationsOutput"
|
|
- name: listControlMeasures
|
|
description: List measures linked to a control
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListControlMeasuresInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListControlMeasuresOutput"
|
|
- name: listControlDocuments
|
|
description: List documents linked to a control
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListControlDocumentsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListControlDocumentsOutput"
|
|
- name: listControlAudits
|
|
description: List audits linked to a control
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListControlAuditsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListControlAuditsOutput"
|
|
- name: listRiskObligations
|
|
description: List obligations linked to a risk
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRiskObligationsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRiskObligationsOutput"
|
|
- name: linkRisk
|
|
description: Link a risk to a resource (document, measure, or obligation). The resource type is determined from the resource_id GID.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/LinkRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/LinkRiskOutput"
|
|
- name: unlinkRisk
|
|
description: Unlink a risk from a resource (document, measure, or obligation). The resource type is determined from the resource_id GID.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UnlinkRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UnlinkRiskOutput"
|
|
- name: listTasks
|
|
description: List all tasks for the organization or measure
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListTasksInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListTasksOutput"
|
|
- name: getTask
|
|
description: Get a task by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetTaskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetTaskOutput"
|
|
- name: addTask
|
|
description: Add a new task to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddTaskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddTaskOutput"
|
|
- name: updateTask
|
|
description: Update an existing task
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateTaskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateTaskOutput"
|
|
- name: assignTask
|
|
description: Assign a task to a person
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AssignTaskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AssignTaskOutput"
|
|
- name: unassignTask
|
|
description: Unassign a task from a person
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UnassignTaskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UnassignTaskOutput"
|
|
- name: deleteTask
|
|
description: Delete a task
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteTaskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteTaskOutput"
|
|
- name: listDocuments
|
|
description: List documents for the organization. By default only ACTIVE documents are returned; pass status filter to include ARCHIVED.
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListDocumentsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListDocumentsOutput"
|
|
- name: getDocument
|
|
description: Get a document by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetDocumentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetDocumentOutput"
|
|
- name: addDocument
|
|
description: Add a new document to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddDocumentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddDocumentOutput"
|
|
- name: updateDocument
|
|
description: Update an existing document
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateDocumentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateDocumentOutput"
|
|
- name: deleteDocumentDraft
|
|
description: Delete the latest draft version of a document, reverting to the last published version. Cannot delete the initial v0.1 draft.
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteDocumentDraftInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteDocumentDraftOutput"
|
|
- name: archiveDocument
|
|
description: Archive a document to prevent further modifications
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ArchiveDocumentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ArchiveDocumentOutput"
|
|
- name: unarchiveDocument
|
|
description: Unarchive a document to allow modifications again
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UnarchiveDocumentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UnarchiveDocumentOutput"
|
|
- name: listDocumentVersions
|
|
description: List all versions for a document
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListDocumentVersionsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListDocumentVersionsOutput"
|
|
- name: getDocumentVersion
|
|
description: Get a document version by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetDocumentVersionInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetDocumentVersionOutput"
|
|
- name: publishDocument
|
|
description: Publish the latest draft of a document. Set minor=true to publish a minor version (no approval flow). When minor=false, providing approver_ids triggers an approval request as a new major version; otherwise the draft is published immediately as a new major version.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishDocumentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishDocumentOutput"
|
|
- name: deleteDocument
|
|
description: Delete a document
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteDocumentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteDocumentOutput"
|
|
- name: listDocumentVersionSignatures
|
|
description: List all signatures for a document version
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListDocumentVersionSignaturesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListDocumentVersionSignaturesOutput"
|
|
- name: getDocumentVersionSignature
|
|
description: Get a document version signature by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetDocumentVersionSignatureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetDocumentVersionSignatureOutput"
|
|
- name: requestDocumentVersionSignature
|
|
description: Request a signature for a document version
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RequestDocumentVersionSignatureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RequestDocumentVersionSignatureOutput"
|
|
- name: cancelSignatureRequest
|
|
description: Cancel a document version signature request
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CancelSignatureRequestInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CancelSignatureRequestOutput"
|
|
- name: voidDocumentVersionApproval
|
|
description: Void a pending document version approval request
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/VoidDocumentVersionApprovalInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/VoidDocumentVersionApprovalOutput"
|
|
- name: listStatementsOfApplicability
|
|
description: List all statements of applicability for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListStatementsOfApplicabilityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListStatementsOfApplicabilityOutput"
|
|
- name: getStatementOfApplicability
|
|
description: Get a statement of applicability by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetStatementOfApplicabilityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetStatementOfApplicabilityOutput"
|
|
- name: addStatementOfApplicability
|
|
description: Add a new statement of applicability to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddStatementOfApplicabilityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddStatementOfApplicabilityOutput"
|
|
- name: updateStatementOfApplicability
|
|
description: Update an existing statement of applicability
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateStatementOfApplicabilityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateStatementOfApplicabilityOutput"
|
|
- name: deleteStatementOfApplicability
|
|
description: Delete a statement of applicability
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteStatementOfApplicabilityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteStatementOfApplicabilityOutput"
|
|
- name: publishDataList
|
|
description: Publish the data list for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishDataListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishDataListOutput"
|
|
- name: publishAssetList
|
|
description: Publish the asset list for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishAssetListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishAssetListOutput"
|
|
- name: publishFindingList
|
|
description: Publish the finding register for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishFindingListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishFindingListOutput"
|
|
- name: publishObligationList
|
|
description: Publish the obligation register for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishObligationListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishObligationListOutput"
|
|
- name: publishProcessingActivityList
|
|
description: Publish the processing activity register for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishProcessingActivityListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishProcessingActivityListOutput"
|
|
- name: publishDataProtectionImpactAssessmentList
|
|
description: Publish the Data Protection Impact Assessment register for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishDataProtectionImpactAssessmentListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishDataProtectionImpactAssessmentListOutput"
|
|
- name: publishTransferImpactAssessmentList
|
|
description: Publish the Transfer Impact Assessment register for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishTransferImpactAssessmentListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishTransferImpactAssessmentListOutput"
|
|
- name: publishThirdPartyList
|
|
description: Publish the thirdParty register for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishThirdPartyListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishThirdPartyListOutput"
|
|
- name: publishRiskList
|
|
description: Publish the risk register for an organization as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishRiskListInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishRiskListOutput"
|
|
- name: publishStatementOfApplicability
|
|
description: Publish a statement of applicability as a document. If a document already exists, a new version is created.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishStatementOfApplicabilityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishStatementOfApplicabilityOutput"
|
|
- name: listApplicabilityStatements
|
|
description: List all applicability statements for a statement of applicability
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListApplicabilityStatementsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListApplicabilityStatementsOutput"
|
|
- name: getApplicabilityStatement
|
|
description: Get an applicability statement by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetApplicabilityStatementInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetApplicabilityStatementOutput"
|
|
- name: addApplicabilityStatement
|
|
description: Add a control to a statement of applicability with an applicability decision
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddApplicabilityStatementInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddApplicabilityStatementOutput"
|
|
- name: updateApplicabilityStatement
|
|
description: Update the applicability and justification of an applicability statement
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateApplicabilityStatementInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateApplicabilityStatementOutput"
|
|
- name: deleteApplicabilityStatement
|
|
description: Delete an applicability statement from a statement of applicability
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteApplicabilityStatementInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteApplicabilityStatementOutput"
|
|
- name: listAccessReviewCampaigns
|
|
description: List access review campaigns for an organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListAccessReviewCampaignsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListAccessReviewCampaignsOutput"
|
|
- name: listAccessEntries
|
|
description: List access entries for a campaign with optional filters (decision, flag, incremental_tag, is_admin, active, auth_method, account_type)
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListAccessEntriesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListAccessEntriesOutput"
|
|
- name: getAccessReviewStatistics
|
|
description: Get statistics for an access review campaign including counts by decision, flag, and incremental tag
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetAccessReviewStatisticsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetAccessReviewStatisticsOutput"
|
|
- name: recordAccessReviewEntryDecision
|
|
description: Record a decision on an access entry (APPROVED, REVOKE, DEFER, or ESCALATE). Non-APPROVED decisions require a decision_note.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RecordAccessReviewEntryDecisionMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RecordAccessReviewEntryDecisionMCPOutput"
|
|
- name: recordAccessReviewEntryDecisions
|
|
description: Record decisions on multiple access entries in a single batch. Non-APPROVED decisions require a decision_note.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RecordAccessReviewEntryDecisionsMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RecordAccessReviewEntryDecisionsMCPOutput"
|
|
- name: flagAccessReviewEntry
|
|
description: Flag an access entry with one or more flags during review (ORPHANED, INACTIVE, EXCESSIVE, ROLE_MISMATCH, NEW, etc.). Optionally provide reasons.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/FlagAccessReviewEntryMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/FlagAccessReviewEntryMCPOutput"
|
|
- name: closeAccessReviewCampaign
|
|
description: Close an access review campaign. All entries must have been decided (no PENDING entries).
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CloseAccessReviewCampaignMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CloseAccessReviewCampaignMCPOutput"
|
|
- name: listAccessReviewSources
|
|
description: List access sources for an organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListAccessReviewSourcesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListAccessReviewSourcesOutput"
|
|
- name: createAccessReviewSource
|
|
description: Create a new access source for an organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CreateAccessReviewSourceMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CreateAccessReviewSourceMCPOutput"
|
|
- name: updateAccessReviewSource
|
|
description: Update an existing access source
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateAccessReviewSourceMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateAccessReviewSourceMCPOutput"
|
|
- name: deleteAccessReviewSource
|
|
description: Delete an access source
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteAccessReviewSourceMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteAccessReviewSourceMCPOutput"
|
|
- name: createAccessReviewCampaign
|
|
description: Create a new access review campaign for an organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CreateAccessReviewCampaignMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CreateAccessReviewCampaignMCPOutput"
|
|
- name: updateAccessReviewCampaign
|
|
description: Update an existing access review campaign
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateAccessReviewCampaignMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateAccessReviewCampaignMCPOutput"
|
|
- name: deleteAccessReviewCampaign
|
|
description: Delete an access review campaign
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteAccessReviewCampaignMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteAccessReviewCampaignMCPOutput"
|
|
- name: startAccessReviewCampaign
|
|
description: Start an access review campaign. Triggers data fetching from all configured scope sources.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/StartAccessReviewCampaignMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/StartAccessReviewCampaignMCPOutput"
|
|
- name: cancelAccessReviewCampaign
|
|
description: Cancel an in-progress access review campaign
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CancelAccessReviewCampaignMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CancelAccessReviewCampaignMCPOutput"
|
|
- name: addAccessReviewCampaignSource
|
|
description: Add an access source to an access review campaign's scope
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddAccessReviewCampaignSourceMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddAccessReviewCampaignSourceMCPOutput"
|
|
- name: removeAccessReviewCampaignSource
|
|
description: Remove an access source from an access review campaign's scope
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RemoveAccessReviewCampaignSourceMCPInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RemoveAccessReviewCampaignSourceMCPOutput"
|
|
- name: getOrganizationContext
|
|
description: Get the organization context containing structured sections about the company
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetOrganizationContextInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetOrganizationContextOutput"
|
|
- name: updateOrganizationContext
|
|
description: Update the organization context sections (product, architecture, team, processes, customers)
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateOrganizationContextInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateOrganizationContextOutput"
|
|
- name: getAuditLogEntry
|
|
description: Get an audit log entry by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetAuditLogEntryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetAuditLogEntryOutput"
|
|
- name: listAuditLogEntries
|
|
description: List audit log entries for the organization. Audit log entries record write actions (create, update, delete) performed by users and API keys.
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListAuditLogEntriesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListAuditLogEntriesOutput"
|
|
- name: requestAuditLogExport
|
|
description: Request an export of audit log entries for the organization within a time range. The export will be emailed as a JSONL download link.
|
|
hints:
|
|
readonly: false
|
|
idempotent: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RequestAuditLogExportInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RequestAuditLogExportOutput"
|
|
- name: requestSCIMEventExport
|
|
description: Request an export of SCIM events for the organization within a time range. The export will be emailed as a JSONL download link.
|
|
hints:
|
|
readonly: false
|
|
idempotent: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RequestSCIMEventExportInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RequestSCIMEventExportOutput"
|
|
- name: listWebhookSubscriptions
|
|
description: List all webhook subscriptions for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListWebhookSubscriptionsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListWebhookSubscriptionsOutput"
|
|
- name: getWebhookSubscription
|
|
description: Get a webhook subscription by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetWebhookSubscriptionInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetWebhookSubscriptionOutput"
|
|
- name: createWebhookSubscription
|
|
description: Create a new webhook subscription for the organization. The endpoint URL must use HTTPS. Selected events determine which events trigger webhook deliveries.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CreateWebhookSubscriptionInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CreateWebhookSubscriptionOutput"
|
|
- name: updateWebhookSubscription
|
|
description: Update a webhook subscription's endpoint URL or selected events
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateWebhookSubscriptionInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateWebhookSubscriptionOutput"
|
|
- name: deleteWebhookSubscription
|
|
description: Delete a webhook subscription
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteWebhookSubscriptionInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteWebhookSubscriptionOutput"
|
|
- name: listWebhookEvents
|
|
description: List webhook delivery events for a subscription. Shows delivery status (PENDING, SUCCEEDED, FAILED) and response details.
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListWebhookEventsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListWebhookEventsOutput"
|
|
- name: listDocumentVersionApprovalQuorums
|
|
description: List approval quorums for a document version
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListDocumentVersionApprovalQuorumsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListDocumentVersionApprovalQuorumsOutput"
|
|
- name: getDocumentVersionApprovalQuorum
|
|
description: Get a document version approval quorum by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetDocumentVersionApprovalQuorumInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetDocumentVersionApprovalQuorumOutput"
|
|
- name: listDocumentVersionApprovalDecisions
|
|
description: List approval decisions for an approval quorum
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListDocumentVersionApprovalDecisionsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListDocumentVersionApprovalDecisionsOutput"
|
|
- name: getDocumentVersionApprovalDecision
|
|
description: Get a document version approval decision by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetDocumentVersionApprovalDecisionInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetDocumentVersionApprovalDecisionOutput"
|
|
- name: listRightsRequests
|
|
description: List all rights requests for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRightsRequestsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRightsRequestsOutput"
|
|
- name: getRightsRequest
|
|
description: Get a rights request by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRightsRequestInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRightsRequestOutput"
|
|
- name: addRightsRequest
|
|
description: Add a new rights request to the organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRightsRequestInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRightsRequestOutput"
|
|
- name: updateRightsRequest
|
|
description: Update an existing rights request
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRightsRequestInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRightsRequestOutput"
|
|
- name: deleteRightsRequest
|
|
description: Delete a rights request
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRightsRequestInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRightsRequestOutput"
|
|
- name: getCompliancePortal
|
|
description: Get the compliance portal for an organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetCompliancePortalInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetCompliancePortalOutput"
|
|
- name: updateCompliancePortal
|
|
description: Update a compliance portal's settings
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateCompliancePortalInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateCompliancePortalOutput"
|
|
- name: listCompliancePortalReferences
|
|
description: List all references for a compliance portal
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListCompliancePortalReferencesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListCompliancePortalReferencesOutput"
|
|
- name: addCompliancePortalReference
|
|
description: Add a new reference to a compliance portal
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddCompliancePortalReferenceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddCompliancePortalReferenceOutput"
|
|
- name: updateCompliancePortalReference
|
|
description: Update an existing compliance portal reference
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateCompliancePortalReferenceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateCompliancePortalReferenceOutput"
|
|
- name: deleteCompliancePortalReference
|
|
description: Delete a compliance portal reference
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteCompliancePortalReferenceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteCompliancePortalReferenceOutput"
|
|
- name: listCommitmentGroups
|
|
description: List all commitment groups for a trust center
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListCommitmentGroupsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListCommitmentGroupsOutput"
|
|
- name: addCommitmentGroup
|
|
description: Add a new commitment group to a trust center
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddCommitmentGroupInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddCommitmentGroupOutput"
|
|
- name: updateCommitmentGroup
|
|
description: Update an existing commitment group
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateCommitmentGroupInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateCommitmentGroupOutput"
|
|
- name: deleteCommitmentGroup
|
|
description: Delete a commitment group
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteCommitmentGroupInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteCommitmentGroupOutput"
|
|
- name: listCommitments
|
|
description: List all commitments in a commitment group
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListCommitmentsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListCommitmentsOutput"
|
|
- name: addCommitment
|
|
description: Add a new commitment to a commitment group
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddCommitmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddCommitmentOutput"
|
|
- name: updateCommitment
|
|
description: Update an existing commitment
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateCommitmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateCommitmentOutput"
|
|
- name: deleteCommitment
|
|
description: Delete a commitment
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteCommitmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteCommitmentOutput"
|
|
- name: setResourceAlias
|
|
description: Set a resource alias for a resource
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/SetResourceAliasInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/SetResourceAliasOutput"
|
|
- name: removeResourceAlias
|
|
description: Remove a resource alias from a resource
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RemoveResourceAliasInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RemoveResourceAliasOutput"
|
|
- name: listCompliancePortalFiles
|
|
description: List all files for the compliance portal
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListCompliancePortalFilesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListCompliancePortalFilesOutput"
|
|
- name: deleteCompliancePortalFile
|
|
description: Delete a compliance portal file
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteCompliancePortalFileInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteCompliancePortalFileOutput"
|
|
- name: listComplianceCustomLinks
|
|
description: List all compliance custom links for a compliance portal
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListComplianceCustomLinksInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListComplianceCustomLinksOutput"
|
|
- name: addComplianceCustomLink
|
|
description: Add a new compliance custom link to a compliance portal
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddComplianceCustomLinkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddComplianceCustomLinkOutput"
|
|
- name: updateComplianceCustomLink
|
|
description: Update an existing compliance custom link
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateComplianceCustomLinkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateComplianceCustomLinkOutput"
|
|
- name: deleteComplianceCustomLink
|
|
description: Delete a compliance custom link
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteComplianceCustomLinkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteComplianceCustomLinkOutput"
|
|
- name: createCustomDomain
|
|
description: Create a custom domain for a compliance page
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CreateCustomDomainInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CreateCustomDomainOutput"
|
|
- name: deleteCustomDomain
|
|
description: Delete the custom domain of a compliance page
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteCustomDomainInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteCustomDomainOutput"
|
|
- name: listCookieBanners
|
|
description: List all cookie banners for the organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListCookieBannersInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListCookieBannersOutput"
|
|
- name: getCookieBanner
|
|
description: Get a cookie banner by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetCookieBannerInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetCookieBannerOutput"
|
|
- name: addCookieBanner
|
|
description: Create a new cookie banner for an organization
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddCookieBannerInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddCookieBannerOutput"
|
|
- name: updateCookieBanner
|
|
description: Update an existing cookie banner
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateCookieBannerInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateCookieBannerOutput"
|
|
- name: deleteCookieBanner
|
|
description: Delete a cookie banner
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteCookieBannerInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteCookieBannerOutput"
|
|
- name: activateCookieBanner
|
|
description: Activate a cookie banner
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ActivateCookieBannerInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ActivateCookieBannerOutput"
|
|
- name: deactivateCookieBanner
|
|
description: Deactivate a cookie banner
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeactivateCookieBannerInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeactivateCookieBannerOutput"
|
|
- name: listCookieCategories
|
|
description: List all cookie categories for a banner
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListCookieCategoriesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListCookieCategoriesOutput"
|
|
- name: getCookieCategory
|
|
description: Get a cookie category by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetCookieCategoryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetCookieCategoryOutput"
|
|
- name: addCookieCategory
|
|
description: Create a new cookie category for a banner
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddCookieCategoryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddCookieCategoryOutput"
|
|
- name: updateCookieCategory
|
|
description: Update an existing cookie category
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateCookieCategoryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateCookieCategoryOutput"
|
|
- name: deleteCookieCategory
|
|
description: Delete a cookie category
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteCookieCategoryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteCookieCategoryOutput"
|
|
- name: reorderCookieCategory
|
|
description: Change the display order rank of a cookie category
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ReorderCookieCategoryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ReorderCookieCategoryOutput"
|
|
- name: listTrackerPatterns
|
|
description: List all tracker patterns for a category
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListTrackerPatternsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListTrackerPatternsOutput"
|
|
- name: getTrackerPattern
|
|
description: Get a tracker pattern by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetTrackerPatternInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetTrackerPatternOutput"
|
|
- name: addTrackerPattern
|
|
description: Create a new tracker pattern for a category
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddTrackerPatternInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddTrackerPatternOutput"
|
|
- name: updateTrackerPattern
|
|
description: Update an existing tracker pattern
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateTrackerPatternInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateTrackerPatternOutput"
|
|
- name: deleteTrackerPattern
|
|
description: Delete a tracker pattern
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteTrackerPatternInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteTrackerPatternOutput"
|
|
- name: moveTrackerPatternToCategory
|
|
description: Move a tracker pattern to a different category
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/MoveTrackerPatternToCategoryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/MoveTrackerPatternToCategoryOutput"
|
|
- name: listTrackerResources
|
|
description: List all tracker resources for a category
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListTrackerResourcesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListTrackerResourcesOutput"
|
|
- name: getTrackerResource
|
|
description: Get a tracker resource by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetTrackerResourceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetTrackerResourceOutput"
|
|
- name: addTrackerResource
|
|
description: Create a new tracker resource for a category
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddTrackerResourceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddTrackerResourceOutput"
|
|
- name: updateTrackerResource
|
|
description: Update an existing tracker resource
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateTrackerResourceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateTrackerResourceOutput"
|
|
- name: deleteTrackerResource
|
|
description: Delete a tracker resource
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteTrackerResourceInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteTrackerResourceOutput"
|
|
- name: moveTrackerResourceToCategory
|
|
description: Move a tracker resource to a different category
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/MoveTrackerResourceToCategoryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/MoveTrackerResourceToCategoryOutput"
|
|
- name: publishCookieBannerVersion
|
|
description: Publish the current draft version of a cookie banner
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/PublishCookieBannerVersionInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/PublishCookieBannerVersionOutput"
|
|
- name: regenerateCookieBannerTrackerPolicy
|
|
description: Re-arm tracker policy generation for a cookie banner that already has a published version. Returns immediately; the policy document is regenerated in the background.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RegenerateCookieBannerTrackerPolicyInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RegenerateCookieBannerTrackerPolicyOutput"
|
|
- name: listCookieBannerVersions
|
|
description: List all versions for a cookie banner
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListCookieBannerVersionsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListCookieBannerVersionsOutput"
|
|
- name: upsertCookieBannerTranslation
|
|
description: Insert or update a cookie banner translation for a language
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpsertCookieBannerTranslationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpsertCookieBannerTranslationOutput"
|
|
- name: listCookieConsentRecords
|
|
description: List consent records for a cookie banner
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListCookieConsentRecordsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListCookieConsentRecordsOutput"
|
|
- name: getCookieConsentRecord
|
|
description: Get a consent record by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetCookieConsentRecordInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetCookieConsentRecordOutput"
|
|
- name: getSCIMConfiguration
|
|
description: Get the SCIM configuration for an organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetSCIMConfigurationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetSCIMConfigurationOutput"
|
|
- name: createSCIMConfiguration
|
|
description: Create a SCIM configuration for an organization. Optionally provide a connector ID to also create a SCIM bridge.
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/CreateSCIMConfigurationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/CreateSCIMConfigurationOutput"
|
|
- name: deleteSCIMConfiguration
|
|
description: Delete a SCIM configuration and its associated bridge
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteSCIMConfigurationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteSCIMConfigurationOutput"
|
|
- name: regenerateSCIMToken
|
|
description: Regenerate the bearer token for a SCIM configuration
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/RegenerateSCIMTokenInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/RegenerateSCIMTokenOutput"
|
|
- name: getSCIMBridge
|
|
description: Get a SCIM bridge by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetSCIMBridgeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetSCIMBridgeOutput"
|
|
- name: updateSCIMBridge
|
|
description: Update a SCIM bridge's excluded user names
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateSCIMBridgeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateSCIMBridgeOutput"
|
|
- name: listSCIMEvents
|
|
description: List SCIM events for a configuration
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListSCIMEventsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListSCIMEventsOutput"
|
|
- name: listRiskAssessments
|
|
description: List all risk assessments for an organization
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentsOutput"
|
|
- name: getRiskAssessment
|
|
description: Get a risk assessment by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentOutput"
|
|
- name: addRiskAssessment
|
|
description: Create a new risk assessment
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentOutput"
|
|
- name: updateRiskAssessment
|
|
description: Update an existing risk assessment
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentOutput"
|
|
- name: deleteRiskAssessment
|
|
description: Delete a risk assessment
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentOutput"
|
|
- name: listRiskAssessmentScopes
|
|
description: List all scopes for a risk assessment
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentScopesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentScopesOutput"
|
|
- name: getRiskAssessmentScope
|
|
description: Get a risk assessment scope by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentScopeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentScopeOutput"
|
|
- name: getRiskAssessmentScopeMermaidChart
|
|
description: Get the Mermaid chart for a risk assessment scope
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentScopeMermaidChartInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentScopeMermaidChartOutput"
|
|
- name: addRiskAssessmentScope
|
|
description: Create a new risk assessment scope
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentScopeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentScopeOutput"
|
|
- name: updateRiskAssessmentScope
|
|
description: Update an existing risk assessment scope
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentScopeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentScopeOutput"
|
|
- name: deleteRiskAssessmentScope
|
|
description: Delete a risk assessment scope
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentScopeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentScopeOutput"
|
|
- name: listRiskAssessmentNodes
|
|
description: List all nodes for a risk assessment scope
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentNodesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentNodesOutput"
|
|
- name: getRiskAssessmentNode
|
|
description: Get a risk assessment node by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentNodeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentNodeOutput"
|
|
- name: addRiskAssessmentNode
|
|
description: Create a new risk assessment node
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentNodeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentNodeOutput"
|
|
- name: updateRiskAssessmentNode
|
|
description: Update an existing risk assessment node
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentNodeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentNodeOutput"
|
|
- name: deleteRiskAssessmentNode
|
|
description: Delete a risk assessment node
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentNodeInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentNodeOutput"
|
|
- name: listRiskAssessmentBoundaries
|
|
description: List all boundaries for a risk assessment scope
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentBoundariesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentBoundariesOutput"
|
|
- name: getRiskAssessmentBoundary
|
|
description: Get a risk assessment boundary by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentBoundaryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentBoundaryOutput"
|
|
- name: addRiskAssessmentBoundary
|
|
description: Create a new risk assessment boundary
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentBoundaryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentBoundaryOutput"
|
|
- name: updateRiskAssessmentBoundary
|
|
description: Update an existing risk assessment boundary
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentBoundaryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentBoundaryOutput"
|
|
- name: deleteRiskAssessmentBoundary
|
|
description: Delete a risk assessment boundary
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentBoundaryInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentBoundaryOutput"
|
|
- name: listRiskAssessmentProcesses
|
|
description: List all processes for a risk assessment scope
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentProcessesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentProcessesOutput"
|
|
- name: getRiskAssessmentProcess
|
|
description: Get a risk assessment process by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentProcessInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentProcessOutput"
|
|
- name: addRiskAssessmentProcess
|
|
description: Create a new risk assessment process
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentProcessInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentProcessOutput"
|
|
- name: updateRiskAssessmentProcess
|
|
description: Update an existing risk assessment process
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentProcessInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentProcessOutput"
|
|
- name: deleteRiskAssessmentProcess
|
|
description: Delete a risk assessment process
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentProcessInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentProcessOutput"
|
|
- name: listRiskAssessmentThreats
|
|
description: List all threats for a risk assessment scope
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentThreatsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentThreatsOutput"
|
|
- name: getRiskAssessmentThreat
|
|
description: Get a risk assessment threat by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentThreatInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentThreatOutput"
|
|
- name: addRiskAssessmentThreat
|
|
description: Create a new risk assessment threat
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentThreatInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentThreatOutput"
|
|
- name: updateRiskAssessmentThreat
|
|
description: Update an existing risk assessment threat
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentThreatInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentThreatOutput"
|
|
- name: deleteRiskAssessmentThreat
|
|
description: Delete a risk assessment threat
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentThreatInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentThreatOutput"
|
|
- name: listRiskAssessmentScenarios
|
|
description: List all scenarios for a risk assessment scope
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentScenariosInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRiskAssessmentScenariosOutput"
|
|
- name: getRiskAssessmentScenario
|
|
description: Get a risk assessment scenario by ID
|
|
hints:
|
|
readonly: true
|
|
idempotent: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentScenarioInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskAssessmentScenarioOutput"
|
|
- name: addRiskAssessmentScenario
|
|
description: Create a new risk assessment scenario
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentScenarioInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskAssessmentScenarioOutput"
|
|
- name: updateRiskAssessmentScenario
|
|
description: Update an existing risk assessment scenario
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentScenarioInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskAssessmentScenarioOutput"
|
|
- name: deleteRiskAssessmentScenario
|
|
description: Delete a risk assessment scenario
|
|
hints:
|
|
readonly: false
|
|
destructive: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentScenarioInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/DeleteRiskAssessmentScenarioOutput"
|
|
- name: linkRiskAssessmentScenarioThreat
|
|
description: Link a threat to a risk assessment scenario
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/LinkRiskAssessmentScenarioThreatInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/LinkRiskAssessmentScenarioThreatOutput"
|
|
- name: unlinkRiskAssessmentScenarioThreat
|
|
description: Unlink a threat from a risk assessment scenario
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UnlinkRiskAssessmentScenarioThreatInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UnlinkRiskAssessmentScenarioThreatOutput"
|
|
- name: linkRiskAssessmentScenarioRisk
|
|
description: Link a risk to a risk assessment scenario
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/LinkRiskAssessmentScenarioRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/LinkRiskAssessmentScenarioRiskOutput"
|
|
- name: unlinkRiskAssessmentScenarioRisk
|
|
description: Unlink a risk from a risk assessment scenario
|
|
hints:
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UnlinkRiskAssessmentScenarioRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UnlinkRiskAssessmentScenarioRiskOutput"
|