mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
Update python SDK docs: 16478405208
This commit is contained in:
@@ -607,7 +607,7 @@ with ApiClient(configuration) as api_client:
|
||||
Patch an entitlement
|
||||
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**
|
||||
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.
|
||||
|
||||
@@ -821,11 +821,11 @@ 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 }**`
|
||||
|
||||
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.
|
||||
|
||||
@@ -876,6 +876,10 @@ with ApiClient(configuration) as api_client:
|
||||
"op" : "replace",
|
||||
"path" : "/requestable",
|
||||
"value" : false
|
||||
}, {
|
||||
"op" : "replace",
|
||||
"path" : "/privilegeOverride/overrideLevel",
|
||||
"value" : "HIGH"
|
||||
} ]
|
||||
}''' # EntitlementBulkUpdateRequest |
|
||||
|
||||
|
||||
@@ -11,13 +11,14 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'BetaE
|
||||
|
||||
# EntitlementBulkUpdateRequest
|
||||
|
||||
Object for specifying the bulk update request
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entitlement_ids** | **[]str** | List of entitlement ids to update | [required]
|
||||
**json_patch** | [**[]JsonPatchOperation**](json-patch-operation) | | [required]
|
||||
**json_patch** | [**[]JsonPatchOperation**](json-patch-operation) | List of entitlement ids to update | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
@@ -27,7 +28,7 @@ from sailpoint.beta.models.entitlement_bulk_update_request import EntitlementBul
|
||||
|
||||
entitlement_bulk_update_request = EntitlementBulkUpdateRequest(
|
||||
entitlement_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f],
|
||||
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
|
||||
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -978,12 +978,19 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
```
|
||||
:::
|
||||
Bulk update an entitlement list
|
||||
"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 }**`"
|
||||
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.
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-in-bulk)
|
||||
@@ -1035,6 +1042,10 @@ with ApiClient(configuration) as api_client:
|
||||
"op" : "replace",
|
||||
"path" : "/requestable",
|
||||
"value" : false
|
||||
}, {
|
||||
"op" : "replace",
|
||||
"path" : "/privilegeOverride/overrideLevel",
|
||||
"value" : "HIGH"
|
||||
} ]
|
||||
}''' # EntitlementBulkUpdateRequest |
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'V2024
|
||||
|
||||
# EntitlementBulkUpdateRequest
|
||||
|
||||
Object for specifying the bulk update request
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -27,7 +28,7 @@ from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBu
|
||||
|
||||
entitlement_bulk_update_request = EntitlementBulkUpdateRequest(
|
||||
entitlement_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f],
|
||||
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
|
||||
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -978,12 +978,19 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
```
|
||||
:::
|
||||
Bulk update an entitlement list
|
||||
"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 }**`"
|
||||
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.
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-entitlements-in-bulk)
|
||||
@@ -1035,6 +1042,10 @@ with ApiClient(configuration) as api_client:
|
||||
"op" : "replace",
|
||||
"path" : "/requestable",
|
||||
"value" : false
|
||||
}, {
|
||||
"op" : "replace",
|
||||
"path" : "/privilegeOverride/overrideLevel",
|
||||
"value" : "HIGH"
|
||||
} ]
|
||||
}''' # EntitlementBulkUpdateRequest |
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'V2025
|
||||
|
||||
# EntitlementBulkUpdateRequest
|
||||
|
||||
Object for specifying the bulk update request
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -27,7 +28,7 @@ from sailpoint.v2025.models.entitlement_bulk_update_request import EntitlementBu
|
||||
|
||||
entitlement_bulk_update_request = EntitlementBulkUpdateRequest(
|
||||
entitlement_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f],
|
||||
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
|
||||
json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user