Automated commit by github action: 4428770048

This commit is contained in:
GitHub Action Bot
2023-03-15 16:45:50 +00:00
parent 01dc191a9d
commit a8cc144dfc
5 changed files with 209 additions and 0 deletions

View File

@@ -0,0 +1,168 @@
get:
operationId: getEntitlementRequestConfig
tags:
- Entitlements
summary: Get Entitlement Request Config
description: >-
This API returns the entitlement request config for a specified entitlement.
security:
- oauth2: ['idn:entitlement:read']
parameters:
- in: path
name: id
schema:
type: string
required: true
description: Entitlement Id
example: 2c91808874ff91550175097daaec161c
responses:
'200':
description: An Entitlement Request Config
content:
application/json:
schema:
$ref: '../schemas/EntitlementRequestConfig.yaml'
example:
{
"accessRequestConfig": {
"requestCommentRequired": true,
"denialCommentRequired": true,
"approvalSchemes": [
{
"approverType": "ENTITLEMENT_OWNER",
"approverId": null
},
{
"approverType": "SOURCE_OWNER",
"approverId": null
},
{
"approverType": "MANAGER",
"approverId": null
},
{
"approverType": "GOVERNANCE_GROUP",
"approverId": "46c79819-a69f-49a2-becb-12c971ae66c6"
}
]
},
"revocationRequestConfig": {
"approvalSchemes": [
{
"approverType": "ENTITLEMENT_OWNER",
"approverId": null
},
{
"approverType": "SOURCE_OWNER",
"approverId": null
},
{
"approverType": "MANAGER",
"approverId": null
},
{
"approverType": "GOVERNANCE_GROUP",
"approverId": "46c79819-a69f-49a2-becb-12c971ae66c6"
}
]
}
}
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
put:
operationId: putEntitlementRequestConfig
tags:
- Entitlements
summary: Replace Entitlement Request Config
description: >-
This API replaces the entitlement request config for a specified entitlement.
security:
- oauth2: ['idn:entitlement:update']
parameters:
- name: id
in: path
description: ID of the Entitlement to replace
required: true
schema:
type: string
example: 2c91808a7813090a017814121e121518
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/EntitlementRequestConfig.yaml'
responses:
'200':
description: Responds with the entitlement request config as updated.
content:
application/json:
schema:
$ref: '../schemas/EntitlementRequestConfig.yaml'
example:
{
"accessRequestConfig": {
"requestCommentRequired": true,
"denialCommentRequired": true,
"approvalSchemes": [
{
"approverType": "ENTITLEMENT_OWNER",
"approverId": null
},
{
"approverType": "SOURCE_OWNER",
"approverId": null
},
{
"approverType": "MANAGER",
"approverId": null
},
{
"approverType": "GOVERNANCE_GROUP",
"approverId": "46c79819-a69f-49a2-becb-12c971ae66c6"
}
]
},
"revocationRequestConfig": {
"approvalSchemes": [
{
"approverType": "ENTITLEMENT_OWNER",
"approverId": null
},
{
"approverType": "SOURCE_OWNER",
"approverId": null
},
{
"approverType": "MANAGER",
"approverId": null
},
{
"approverType": "GOVERNANCE_GROUP",
"approverId": "46c79819-a69f-49a2-becb-12c971ae66c6"
}
]
}
}
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'

View File

@@ -0,0 +1,14 @@
type: object
properties:
requestCommentRequired:
type: boolean
description: If the request comment is required when the user request the entitlement
example: true
denialCommentRequired:
type: boolean
description: If the denial comment is required when the approver denies the request
example: true
approvalSchemes:
type: array
items:
$ref: './ApprovalScheme.yaml'

View File

@@ -0,0 +1,15 @@
type: object
properties:
approverId:
type: string
description: The id of the approver
example: "46c79819-a69f-49a2-becb-12c971ae66c6"
approverType:
type: string
enum:
- ENTITLEMENT_OWNER
- SOURCE_OWNER
- MANAGER
- GOVERNANCE_GROUP
description: The type of approver
example: "GOVERNANCE_GROUP"

View File

@@ -0,0 +1,6 @@
type: object
properties:
accessRequestConfig:
$ref: './AccessRequestConfig.yaml'
revocationRequestConfig:
$ref: './RevocationRequestConfig.yaml'

View File

@@ -0,0 +1,6 @@
type: object
properties:
approvalSchemes:
type: array
items:
$ref: './ApprovalScheme.yaml'