@@ -17295,6 +17295,92 @@ components:
1729517295 - score
1729617296 - severity
1729717297 type: object
17298+ Email:
17299+ description: On-Call User Email.
17300+ example:
17301+ data:
17302+ attributes:
17303+ active: true
17304+ 17305+ alias: ''
17306+ formats:
17307+ - html
17308+ id: 45cd9fe5-dd96-42ad-83de-2242ea9f6efd
17309+ type: emails
17310+ properties:
17311+ data:
17312+ $ref: '#/components/schemas/EmailData'
17313+ type: object
17314+ EmailAttributes:
17315+ description: Attributes for an on-call email.
17316+ properties:
17317+ active:
17318+ description: Whether the email is currently active.
17319+ type: boolean
17320+ address:
17321+ description: Email address.
17322+ type: string
17323+ alias:
17324+ description: Optional display alias for the email.
17325+ type: string
17326+ formats:
17327+ description: Preferred content formats for notifications.
17328+ items:
17329+ type: string
17330+ type: array
17331+ type: object
17332+ EmailCreateRequest:
17333+ description: Request body for creating an On-Call email notification channel.
17334+ example:
17335+ data:
17336+ attributes:
17337+ active: true
17338+ 17339+ alias: ''
17340+ formats:
17341+ - html
17342+ type: emails
17343+ properties:
17344+ data:
17345+ $ref: '#/components/schemas/EmailData'
17346+ type: object
17347+ EmailData:
17348+ description: Data for an on-call email resource.
17349+ properties:
17350+ attributes:
17351+ $ref: '#/components/schemas/EmailAttributes'
17352+ id:
17353+ description: The email's unique identifier.
17354+ type: string
17355+ type:
17356+ $ref: '#/components/schemas/EmailType'
17357+ required:
17358+ - type
17359+ type: object
17360+ EmailType:
17361+ default: emails
17362+ description: Indicates that the resource is of type 'emails'.
17363+ enum:
17364+ - emails
17365+ example: emails
17366+ type: string
17367+ x-enum-varnames:
17368+ - EMAILS
17369+ EmailUpdateRequest:
17370+ description: Request body for updating an On-Call email notification channel.
17371+ example:
17372+ data:
17373+ attributes:
17374+ active: true
17375+ 17376+ alias: ''
17377+ formats:
17378+ - html
17379+ type: emails
17380+ properties:
17381+ data:
17382+ $ref: '#/components/schemas/EmailData'
17383+ type: object
1729817384 Enabled:
1729917385 description: Field used to enable or disable the rule.
1730017386 example: true
@@ -71906,6 +71992,193 @@ paths:
7190671992 operator: AND
7190771993 permissions:
7190871994 - on_call_write
71995+ /api/v2/on-call/users/{user_id}/notification-channels/emails:
71996+ post:
71997+ description: Create a new email notification channel for an on-call user
71998+ operationId: CreateUserEmailNotificationChannel
71999+ parameters:
72000+ - description: The user ID
72001+ in: path
72002+ name: user_id
72003+ required: true
72004+ schema:
72005+ example: 00000000-0000-0000-0000-000000000000
72006+ type: string
72007+ requestBody:
72008+ content:
72009+ application/json:
72010+ schema:
72011+ $ref: '#/components/schemas/EmailCreateRequest'
72012+ required: true
72013+ responses:
72014+ '201':
72015+ content:
72016+ application/json:
72017+ schema:
72018+ $ref: '#/components/schemas/Email'
72019+ description: Created
72020+ '400':
72021+ $ref: '#/components/responses/BadRequestResponse'
72022+ '401':
72023+ $ref: '#/components/responses/UnauthorizedResponse'
72024+ '403':
72025+ $ref: '#/components/responses/ForbiddenResponse'
72026+ '404':
72027+ $ref: '#/components/responses/NotFoundResponse'
72028+ '429':
72029+ $ref: '#/components/responses/TooManyRequestsResponse'
72030+ security:
72031+ - apiKeyAuth: []
72032+ appKeyAuth: []
72033+ - AuthZ: []
72034+ summary: Create an On-Call email for a user
72035+ tags:
72036+ - On-Call
72037+ x-permission:
72038+ operator: AND
72039+ permissions:
72040+ - on_call_admin
72041+ /api/v2/on-call/users/{user_id}/notification-channels/emails/{email_id}:
72042+ delete:
72043+ description: Delete an email notification channel for an on-call user
72044+ operationId: DeleteUserEmailNotificationChannel
72045+ parameters:
72046+ - description: The user ID
72047+ in: path
72048+ name: user_id
72049+ required: true
72050+ schema:
72051+ example: 00000000-0000-0000-0000-000000000000
72052+ type: string
72053+ - description: The email ID
72054+ in: path
72055+ name: email_id
72056+ required: true
72057+ schema:
72058+ example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72059+ type: string
72060+ responses:
72061+ '204':
72062+ description: No Content
72063+ '400':
72064+ $ref: '#/components/responses/BadRequestResponse'
72065+ '401':
72066+ $ref: '#/components/responses/UnauthorizedResponse'
72067+ '403':
72068+ $ref: '#/components/responses/ForbiddenResponse'
72069+ '404':
72070+ $ref: '#/components/responses/NotFoundResponse'
72071+ '429':
72072+ $ref: '#/components/responses/TooManyRequestsResponse'
72073+ security:
72074+ - apiKeyAuth: []
72075+ appKeyAuth: []
72076+ - AuthZ: []
72077+ summary: Delete an On-Call email for a user
72078+ tags:
72079+ - On-Call
72080+ x-permission:
72081+ operator: AND
72082+ permissions:
72083+ - on_call_admin
72084+ get:
72085+ description: Get an email notification channel for an on-call user
72086+ operationId: GetUserEmailNotificationChannel
72087+ parameters:
72088+ - description: The user ID
72089+ in: path
72090+ name: user_id
72091+ required: true
72092+ schema:
72093+ example: 00000000-0000-0000-0000-000000000000
72094+ type: string
72095+ - description: The email ID
72096+ in: path
72097+ name: email_id
72098+ required: true
72099+ schema:
72100+ example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72101+ type: string
72102+ responses:
72103+ '200':
72104+ content:
72105+ application/json:
72106+ schema:
72107+ $ref: '#/components/schemas/Email'
72108+ description: OK
72109+ '400':
72110+ $ref: '#/components/responses/BadRequestResponse'
72111+ '401':
72112+ $ref: '#/components/responses/UnauthorizedResponse'
72113+ '403':
72114+ $ref: '#/components/responses/ForbiddenResponse'
72115+ '404':
72116+ $ref: '#/components/responses/NotFoundResponse'
72117+ '429':
72118+ $ref: '#/components/responses/TooManyRequestsResponse'
72119+ security:
72120+ - apiKeyAuth: []
72121+ appKeyAuth: []
72122+ - AuthZ: []
72123+ summary: Get an On-Call email for a user
72124+ tags:
72125+ - On-Call
72126+ x-permission:
72127+ operator: AND
72128+ permissions:
72129+ - on_call_admin
72130+ put:
72131+ description: Update an email notification channel for an on-call user
72132+ operationId: UpdateUserEmailNotificationChannel
72133+ parameters:
72134+ - description: The user ID
72135+ in: path
72136+ name: user_id
72137+ required: true
72138+ schema:
72139+ example: 00000000-0000-0000-0000-000000000000
72140+ type: string
72141+ - description: The email ID
72142+ in: path
72143+ name: email_id
72144+ required: true
72145+ schema:
72146+ example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72147+ type: string
72148+ requestBody:
72149+ content:
72150+ application/json:
72151+ schema:
72152+ $ref: '#/components/schemas/EmailUpdateRequest'
72153+ required: true
72154+ responses:
72155+ '200':
72156+ content:
72157+ application/json:
72158+ schema:
72159+ $ref: '#/components/schemas/Email'
72160+ description: OK
72161+ '400':
72162+ $ref: '#/components/responses/BadRequestResponse'
72163+ '401':
72164+ $ref: '#/components/responses/UnauthorizedResponse'
72165+ '403':
72166+ $ref: '#/components/responses/ForbiddenResponse'
72167+ '404':
72168+ $ref: '#/components/responses/NotFoundResponse'
72169+ '429':
72170+ $ref: '#/components/responses/TooManyRequestsResponse'
72171+ security:
72172+ - apiKeyAuth: []
72173+ appKeyAuth: []
72174+ - AuthZ: []
72175+ summary: Update an On-Call email for a user
72176+ tags:
72177+ - On-Call
72178+ x-permission:
72179+ operator: AND
72180+ permissions:
72181+ - on_call_admin
7190972182 /api/v2/org_configs:
7191072183 get:
7191172184 description: Returns all Org Configs (name, description, and value).
0 commit comments