LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 15116515953

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md
View File

@@ -32,15 +32,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-segment**](#create-segment) | **POST** `/segments` | Create Segment
[**delete-segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID
[**get-segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID
[**list-segments**](#list-segments) | **GET** `/segments` | List Segments
[**patch-segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
[**create-segment**](#create-segment) | **POST** `/segments` | Create segment
[**delete-segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete segment by id
[**get-segment**](#get-segment) | **GET** `/segments/{id}` | Get segment by id
[**list-segments**](#list-segments) | **GET** `/segments` | List segments
[**patch-segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update segment
## create-segment
Create Segment
Create segment
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -107,7 +107,7 @@ with ApiClient(configuration) as api_client:
}''' # Segment |
try:
# Create Segment
# Create segment
new_segment = Segment.from_json(segment)
results = SegmentsApi(api_client).create_segment(segment=new_segment)
# Below is a request that includes all optional parameters
@@ -123,7 +123,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-segment
Delete Segment by ID
Delete segment by id
This API deletes the segment specified by the given ID.
>**Note:** Segment deletion may take some time to go into effect.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -167,7 +167,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete.
try:
# Delete Segment by ID
# Delete segment by id
SegmentsApi(api_client).delete_segment(id=id)
# Below is a request that includes all optional parameters
@@ -181,7 +181,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-segment
Get Segment by ID
Get segment by id
This API returns the segment specified by the given ID.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -225,7 +225,7 @@ with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve.
try:
# Get Segment by ID
# Get segment by id
results = SegmentsApi(api_client).get_segment(id=id)
# Below is a request that includes all optional parameters
@@ -241,7 +241,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-segments
List Segments
List segments
This API returns a list of all segments.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -288,7 +288,7 @@ with ApiClient(configuration) as api_client:
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# List Segments
# List segments
results = SegmentsApi(api_client).list_segments()
# Below is a request that includes all optional parameters
@@ -305,7 +305,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-segment
Update Segment
Update segment
Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
>**Note:** Changes to a segment may take some time to propagate to all identities.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -352,7 +352,7 @@ with ApiClient(configuration) as api_client:
request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
try:
# Update Segment
# Update segment
new_request_body = RequestBody.from_json(request_body)
results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters