Automated commit by github action: 5466860188

This commit is contained in:
GitHub Action Bot
2023-07-05 16:48:06 +00:00
parent f124524211
commit 49cdffe251
4 changed files with 128 additions and 1 deletions

View File

@@ -18,6 +18,56 @@ get:
required: true
description: Entitlement Id
example: 2c91808874ff91550175097daaec161c
- in: query
name: sorters
schema:
type: string
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
example: name,-modified
required: false
style: form
explode: true
- in: query
name: filters
schema:
type: string
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
**id**: *eq, in*
**name**: *eq, in, sw*
**type**: *eq, in*
**attribute**: *eq, in*
**value**: *eq, in, sw*
**source.id**: *eq, in*
**requestable**: *eq*
**created**: *gt, lt, ge, le*
**modified**: *gt, lt, ge, le*
example: attribute eq "memberOf"
required: false
style: form
explode: true
responses:
'200':
description: List of entitlements children from an entitlement

View File

@@ -18,6 +18,56 @@ get:
required: true
description: Entitlement Id
example: 2c91808c74ff913f0175097daa9d59cd
- in: query
name: sorters
schema:
type: string
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
example: name,-modified
required: false
style: form
explode: true
- in: query
name: filters
schema:
type: string
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
**id**: *eq, in*
**name**: *eq, in, sw*
**type**: *eq, in*
**attribute**: *eq, in*
**value**: *eq, in, sw*
**source.id**: *eq, in*
**requestable**: *eq*
**created**: *gt, lt, ge, le*
**modified**: *gt, lt, ge, le*
example: attribute eq "memberOf"
required: false
style: form
explode: true
responses:
'200':
description: List of entitlements parents from an entitlement

View File

@@ -83,7 +83,7 @@ patch:
The following fields are patchable:
**requestable**, **privileged**, **segments**, **owner**.
**requestable**, **privileged**, **segments**, **owner**, **name**, **description**.
When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be
@@ -190,6 +190,28 @@ patch:
}
}
]
Add the description for an entitlement:
description: >-
This example shows how to use patch to add a description for the entitlement.
value:
[
{
"op": "add",
"path": "/description",
"value": "new description for the entitlement"
}
]
Update the name for an entitlement:
description: >-
This example shows how to use patch to update an entitlement's name.
value:
[
{
"op": "replace",
"path": "/name",
"value": "entitlement new name"
}
]
responses:
'200':
description: Responds with the entitlement as updated.

View File

@@ -7,11 +7,16 @@ value:
attribute: 'groups'
value: 'entitlement.aa415ae7'
modified: '2019-12-09T19:19:50.154Z'
created: '2018-12-07T01:07:48Z'
synced: '2020-02-19T04:30:32.906Z'
displayName: 'entitlement.aa415ae7'
source:
id: '2c91808b6e9e6fb8016eec1a2b6f7b5f'
name: 'ODS-HR-Employees'
owner:
type: 'IDENTITY'
id: '2c9180858315595501831958427e5424'
name: 'Addie Lee'
privileged: false
identityCount: 68
tags: