Skip to content

Commit 57019b6

Browse files
developer-relations-spdeveloper-relations-sp
committed
Automated build 'Automated commit 'IDNARC-4729 update ENTITLEMENT PATCH AND POST (BULK UPDATE) (#2193)
* IDNARC-4729 * remove global example and add new field to jsonPatch example. * Remove addiitonal properties from jsonPatch * Remove slash before patachable fields Co-authored-by: Tyler Mairose <tyler.mairose@sailpoint.com>' by github action: 16478329316' python sdk: 16478359929
1 parent 969f8d0 commit 57019b6

18 files changed

+85
-44
lines changed

‎sailpoint/beta/api/entitlements_api.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2691,7 +2691,7 @@ def patch_entitlement(
26912691
) -> Entitlement:
26922692
"""Patch an entitlement
26932693
2694-
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
2694+
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, **privilegeOverride/overrideLevel** and **manuallyUpdatedFields** When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
26952695
26962696
:param id: ID of the entitlement to patch (required)
26972697
:type id: str
@@ -2768,7 +2768,7 @@ def patch_entitlement_with_http_info(
27682768
) -> ApiResponse[Entitlement]:
27692769
"""Patch an entitlement
27702770
2771-
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
2771+
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, **privilegeOverride/overrideLevel** and **manuallyUpdatedFields** When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
27722772
27732773
:param id: ID of the entitlement to patch (required)
27742774
:type id: str
@@ -2845,7 +2845,7 @@ def patch_entitlement_without_preload_content(
28452845
) -> RESTResponseType:
28462846
"""Patch an entitlement
28472847
2848-
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
2848+
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, **privilegeOverride/overrideLevel** and **manuallyUpdatedFields** When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
28492849
28502850
:param id: ID of the entitlement to patch (required)
28512851
:type id: str
@@ -3584,7 +3584,7 @@ def update_entitlements_in_bulk(
35843584
) -> None:
35853585
"""Bulk update an entitlement list
35863586
3587-
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
3587+
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
35883588
35893589
:param entitlement_bulk_update_request: (required)
35903590
:type entitlement_bulk_update_request: EntitlementBulkUpdateRequest
@@ -3656,7 +3656,7 @@ def update_entitlements_in_bulk_with_http_info(
36563656
) -> ApiResponse[None]:
36573657
"""Bulk update an entitlement list
36583658
3659-
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
3659+
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
36603660
36613661
:param entitlement_bulk_update_request: (required)
36623662
:type entitlement_bulk_update_request: EntitlementBulkUpdateRequest
@@ -3728,7 +3728,7 @@ def update_entitlements_in_bulk_without_preload_content(
37283728
) -> RESTResponseType:
37293729
"""Bulk update an entitlement list
37303730
3731-
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API.
3731+
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
37323732
37333733
:param entitlement_bulk_update_request: (required)
37343734
:type entitlement_bulk_update_request: EntitlementBulkUpdateRequest

‎sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4606,6 +4606,10 @@
46064606
"op" : "replace",
46074607
"path" : "/requestable",
46084608
"value" : false
4609+
}, {
4610+
"op" : "replace",
4611+
"path" : "/privilegeOverride/overrideLevel",
4612+
"value" : "HIGH"
46094613
} ]
46104614
}''' # EntitlementBulkUpdateRequest |
46114615
try:

‎sailpoint/beta/docs/Methods/EntitlementsApi.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ with ApiClient(configuration) as api_client:
607607
Patch an entitlement
608608
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
609609

610-
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields**
610+
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, **privilegeOverride/overrideLevel** and **manuallyUpdatedFields**
611611

612612
When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
613613

@@ -821,11 +821,11 @@ This API applies an update to every entitlement of the list.
821821
The number of entitlements to update is limited to 50 items maximum.
822822

823823

824-
The JsonPatch update follows the [JSON
825-
Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations :
826-
`**{ "op": "replace", "path": "/privileged", "value": boolean }** **{ "op":
827-
"replace", "path": "/requestable","value": boolean }**`
828-
824+
The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
825+
examples of allowed operations :
826+
`**{ "op": "replace", "path": "/privileged", "value": boolean }**`
827+
`**{ "op": "replace", "path": "/requestable","value": boolean }**`
828+
`**{ "op": "replace", "path": "/privilegeOverride/overrideLevel","value": string }**`
829829

830830
A token with ORG_ADMIN or API authority is required to call this API.
831831

@@ -876,6 +876,10 @@ with ApiClient(configuration) as api_client:
876876
"op" : "replace",
877877
"path" : "/requestable",
878878
"value" : false
879+
}, {
880+
"op" : "replace",
881+
"path" : "/privilegeOverride/overrideLevel",
882+
"value" : "HIGH"
879883
} ]
880884
}''' # EntitlementBulkUpdateRequest |
881885

‎sailpoint/beta/docs/Models/EntitlementBulkUpdateRequest.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'BetaE
1111

1212
# EntitlementBulkUpdateRequest
1313

14+
Object for specifying the bulk update request
1415

1516
## Properties
1617

1718
Name | Type | Description | Notes
1819
------------ | ------------- | ------------- | -------------
1920
**entitlement_ids** | **[]str** | List of entitlement ids to update | [required]
20-
**json_patch** | [**[]JsonPatchOperation**](json-patch-operation) | | [required]
21+
**json_patch** | [**[]JsonPatchOperation**](json-patch-operation) | List of entitlement ids to update | [required]
2122
}
2223

2324
## Example
@@ -27,7 +28,7 @@ from sailpoint.beta.models.entitlement_bulk_update_request import EntitlementBul
2728

2829
entitlement_bulk_update_request = EntitlementBulkUpdateRequest(
2930
entitlement_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f],
30-
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
31+
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
3132
)
3233

3334
```

‎sailpoint/beta/models/entitlement_bulk_update_request.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@
2727

2828
class EntitlementBulkUpdateRequest(BaseModel):
2929
"""
30-
EntitlementBulkUpdateRequest
30+
Object for specifying the bulk update request
3131
""" # noqa: E501
3232
entitlement_ids: Annotated[List[StrictStr], Field(max_length=50)] = Field(description="List of entitlement ids to update", alias="entitlementIds")
33-
json_patch: List[JsonPatchOperation] = Field(alias="jsonPatch")
33+
json_patch: List[JsonPatchOperation] = Field(description="List of entitlement ids to update", alias="jsonPatch")
3434
__properties: ClassVar[List[str]] = ["entitlementIds", "jsonPatch"]
3535

3636
model_config = ConfigDict(

‎sailpoint/beta/test/test_entitlement_bulk_update_request.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ def make_instance(self, include_optional) -> EntitlementBulkUpdateRequest:
3636
if include_optional:
3737
return EntitlementBulkUpdateRequest(
3838
entitlement_ids = [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f],
39-
json_patch = [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
39+
json_patch = [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
4040
)
4141
else:
4242
return EntitlementBulkUpdateRequest(
4343
entitlement_ids = [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f],
44-
json_patch = [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}],
44+
json_patch = [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}],
4545
)
4646
"""
4747

‎sailpoint/v2024/api/entitlements_api.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3750,7 +3750,7 @@ def update_entitlements_in_bulk(
37503750
) -> None:
37513751
"""Bulk update an entitlement list
37523752
3753-
\"This API applies an update to every entitlement of the list.\\n\\nThe\\ \\ number of entitlements to update is limited to 50 items maximum.\\n\\nThe JsonPatch\\ \\ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\\ \\ allowed operations : `**{ \\\"op\\\": \\\"replace\\\", \\\"path\\\": \\\"/privileged\\\", \\\"\\ value\\\": boolean }** **{ \\\"op\\\": \\\"replace\\\", \\\"path\\\": \\\"/requestable\\\",\\\"value\\\"\\ : boolean }**`\"
3753+
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
37543754
37553755
:param x_sail_point_experimental: Use this header to enable this experimental API. (required)
37563756
:type x_sail_point_experimental: str
@@ -3826,7 +3826,7 @@ def update_entitlements_in_bulk_with_http_info(
38263826
) -> ApiResponse[None]:
38273827
"""Bulk update an entitlement list
38283828
3829-
\"This API applies an update to every entitlement of the list.\\n\\nThe\\ \\ number of entitlements to update is limited to 50 items maximum.\\n\\nThe JsonPatch\\ \\ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\\ \\ allowed operations : `**{ \\\"op\\\": \\\"replace\\\", \\\"path\\\": \\\"/privileged\\\", \\\"\\ value\\\": boolean }** **{ \\\"op\\\": \\\"replace\\\", \\\"path\\\": \\\"/requestable\\\",\\\"value\\\"\\ : boolean }**`\"
3829+
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
38303830
38313831
:param x_sail_point_experimental: Use this header to enable this experimental API. (required)
38323832
:type x_sail_point_experimental: str
@@ -3902,7 +3902,7 @@ def update_entitlements_in_bulk_without_preload_content(
39023902
) -> RESTResponseType:
39033903
"""Bulk update an entitlement list
39043904
3905-
\"This API applies an update to every entitlement of the list.\\n\\nThe\\ \\ number of entitlements to update is limited to 50 items maximum.\\n\\nThe JsonPatch\\ \\ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\\ \\ allowed operations : `**{ \\\"op\\\": \\\"replace\\\", \\\"path\\\": \\\"/privileged\\\", \\\"\\ value\\\": boolean }** **{ \\\"op\\\": \\\"replace\\\", \\\"path\\\": \\\"/requestable\\\",\\\"value\\\"\\ : boolean }**`\"
3905+
This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
39063906
39073907
:param x_sail_point_experimental: Use this header to enable this experimental API. (required)
39083908
:type x_sail_point_experimental: str

‎sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6908,6 +6908,10 @@
69086908
"op" : "replace",
69096909
"path" : "/requestable",
69106910
"value" : false
6911+
}, {
6912+
"op" : "replace",
6913+
"path" : "/privilegeOverride/overrideLevel",
6914+
"value" : "HIGH"
69116915
} ]
69126916
}''' # EntitlementBulkUpdateRequest |
69136917
try:

‎sailpoint/v2024/docs/Methods/EntitlementsApi.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -978,12 +978,19 @@ This API is currently in an experimental state. The API is subject to change bas
978978
```
979979
:::
980980
Bulk update an entitlement list
981-
"This API applies an update to every entitlement of the list.\n\nThe\
982-
\ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\
983-
\ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\
984-
\ allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"\
985-
value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\
986-
: boolean }**`"
981+
This API applies an update to every entitlement of the list.
982+
983+
984+
The number of entitlements to update is limited to 50 items maximum.
985+
986+
987+
The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
988+
examples of allowed operations :
989+
`**{ "op": "replace", "path": "/privileged", "value": boolean }**`
990+
`**{ "op": "replace", "path": "/requestable","value": boolean }**`
991+
`**{ "op": "replace", "path": "/privilegeOverride/overrideLevel","value": string }**`
992+
993+
A token with ORG_ADMIN or API authority is required to call this API.
987994

988995

989996
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-in-bulk)
@@ -1035,6 +1042,10 @@ with ApiClient(configuration) as api_client:
10351042
"op" : "replace",
10361043
"path" : "/requestable",
10371044
"value" : false
1045+
}, {
1046+
"op" : "replace",
1047+
"path" : "/privilegeOverride/overrideLevel",
1048+
"value" : "HIGH"
10381049
} ]
10391050
}''' # EntitlementBulkUpdateRequest |
10401051

‎sailpoint/v2024/docs/Models/EntitlementBulkUpdateRequest.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'V2024
1111

1212
# EntitlementBulkUpdateRequest
1313

14+
Object for specifying the bulk update request
1415

1516
## Properties
1617

@@ -27,7 +28,7 @@ from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBu
2728

2829
entitlement_bulk_update_request = EntitlementBulkUpdateRequest(
2930
entitlement_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f],
30-
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
31+
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
3132
)
3233

3334
```

0 commit comments

Comments
 (0)