Files
api-specs/idn/beta/paths/connector-rules.yaml
GitHub Action Bot 9269e86172 Automated commit 'added new oauth2 flow and description (#1386)
* added new oauth2 flow and description

* renamed authentication to make more sense' by github action: 5967546682
2023-08-24 18:29:03 +00:00

68 lines
1.8 KiB
YAML

get:
tags:
- Connector Rule Management
operationId: getConnectorRuleList
summary: List Connector Rules
description: >-
Returns the list of connector rules.
A token with ORG_ADMIN authority is required to call this API.
responses:
'200':
description: A list of connector rules
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/ConnectorRuleResponse.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
security:
- UserContextAuth: [idn:rule-management-connector:read, idn:rule-management-connector:manage]
post:
tags:
- Connector Rule Management
operationId: createConnectorRule
summary: Create Connector Rule
description: >-
Creates a new connector rule.
A token with ORG_ADMIN authority is required to call this API.
requestBody:
required: true
description: The connector rule to create
content:
application/json:
schema:
$ref: '../schemas/ConnectorRuleCreateRequest.yaml'
responses:
'201':
description: The created connector rule
content:
application/json:
schema:
$ref: '../schemas/ConnectorRuleResponse.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
security:
- UserContextAuth: [idn:rule-management-connector:manage]