mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
starting point for adding python sdk docs
This commit is contained in:
56
docs/tools/sdk/python/Reference/Beta/Models/Segment.md
Normal file
56
docs/tools/sdk/python/Reference/Beta/Models/Segment.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
id: beta-segment
|
||||
title: Segment
|
||||
pagination_label: Segment
|
||||
sidebar_label: Segment
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Segment', 'BetaSegment']
|
||||
slug: /tools/sdk/python/beta/models/segment
|
||||
tags: ['SDK', 'Software Development Kit', 'Segment', 'BetaSegment']
|
||||
---
|
||||
|
||||
# Segment
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The segment's ID. | [optional]
|
||||
**name** | **str** | The segment's business name. | [optional]
|
||||
**created** | **datetime** | The time when the segment is created. | [optional]
|
||||
**modified** | **datetime** | The time when the segment is modified. | [optional]
|
||||
**description** | **str** | The segment's optional description. | [optional]
|
||||
**owner** | [**OwnerReferenceSegments**](owner-reference-segments) | | [optional]
|
||||
**visibility_criteria** | [**VisibilityCriteria**](visibility-criteria) | | [optional]
|
||||
**active** | **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.segment import Segment
|
||||
|
||||
segment = Segment(
|
||||
id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde',
|
||||
name='segment-xyz',
|
||||
created='2020-01-01T00:00Z',
|
||||
modified='2020-01-01T00:00Z',
|
||||
description='This segment represents xyz',
|
||||
owner=sailpoint.beta.models.owner_reference_segments.OwnerReferenceSegments(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'support', ),
|
||||
visibility_criteria=sailpoint.beta.models.visibility_criteria.VisibilityCriteria(
|
||||
expression = sailpoint.beta.models.expression.Expression(
|
||||
operator = 'EQUALS',
|
||||
attribute = 'location',
|
||||
value = sailpoint.beta.models.value.Value(
|
||||
type = 'STRING', ),
|
||||
children = [], ), ),
|
||||
active=True
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user