mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 04:19:37 +00:00
Update python SDK docs: 15528463639
This commit is contained in:
@@ -79,12 +79,25 @@ configuration.experimental = True
|
|||||||
with ApiClient(configuration) as api_client:
|
with ApiClient(configuration) as api_client:
|
||||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||||
machine_identity = '''{
|
machine_identity = '''{
|
||||||
|
"subtype" : "Application",
|
||||||
"created" : "2015-05-28T14:07:17Z",
|
"created" : "2015-05-28T14:07:17Z",
|
||||||
"businessApplication" : "ADService",
|
"businessApplication" : "ADService",
|
||||||
"name" : "aName",
|
"name" : "aName",
|
||||||
"modified" : "2015-05-28T14:07:17Z",
|
"modified" : "2015-05-28T14:07:17Z",
|
||||||
"description" : "",
|
"description" : "",
|
||||||
"attributes" : "{\"Region\":\"EU\"}",
|
"attributes" : "{\"Region\":\"EU\"}",
|
||||||
|
"owners" : {
|
||||||
|
"primaryIdentity" : "{}",
|
||||||
|
"secondaryIdentities" : [ {
|
||||||
|
"name" : "William Wilson",
|
||||||
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
||||||
|
"type" : "IDENTITY"
|
||||||
|
}, {
|
||||||
|
"name" : "William Wilson",
|
||||||
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
||||||
|
"type" : "IDENTITY"
|
||||||
|
} ]
|
||||||
|
},
|
||||||
"id" : "id12345",
|
"id" : "id12345",
|
||||||
"manuallyEdited" : true
|
"manuallyEdited" : true
|
||||||
}''' # MachineIdentity |
|
}''' # MachineIdentity |
|
||||||
@@ -270,7 +283,7 @@ This API returns a list of machine identities.
|
|||||||
Param Type | Name | Data Type | Required | Description
|
Param Type | Name | Data Type | Required | Description
|
||||||
------------- | ------------- | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||||
Query | filters | **str** | (optional) | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq*
|
Query | filters | **str** | (optional) | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr*
|
||||||
Query | sorters | **str** | (optional) | 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: **businessApplication, name**
|
Query | sorters | **str** | (optional) | 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: **businessApplication, name**
|
||||||
Query | count | **bool** | (optional) (default to False) | 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.
|
Query | count | **bool** | (optional) (default to False) | 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.
|
||||||
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||||
@@ -307,7 +320,7 @@ configuration.experimental = True
|
|||||||
|
|
||||||
with ApiClient(configuration) as api_client:
|
with ApiClient(configuration) as api_client:
|
||||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||||
filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) # str | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional)
|
filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* (optional) # str | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* (optional)
|
||||||
sorters = 'businessApplication' # str | 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: **businessApplication, name** (optional) # str | 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: **businessApplication, name** (optional)
|
sorters = 'businessApplication' # str | 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: **businessApplication, name** (optional) # str | 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: **businessApplication, name** (optional)
|
||||||
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)
|
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)
|
||||||
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||||
|
|||||||
@@ -24,6 +24,8 @@ Name | Type | Description | Notes
|
|||||||
**description** | **str** | Description of machine identity | [optional]
|
**description** | **str** | Description of machine identity | [optional]
|
||||||
**manually_edited** | **bool** | Indicates if the machine identity has been manually edited | [optional] [default to False]
|
**manually_edited** | **bool** | Indicates if the machine identity has been manually edited | [optional] [default to False]
|
||||||
**attributes** | **object** | A map of custom machine identity attributes | [optional]
|
**attributes** | **object** | A map of custom machine identity attributes | [optional]
|
||||||
|
**subtype** | **str** | The subtype value associated to the machine identity | [required]
|
||||||
|
**owners** | [**MachineIdentityDtoOwners**](machine-identity-dto-owners) | | [optional]
|
||||||
}
|
}
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
@@ -39,7 +41,16 @@ modified='2015-05-28T14:07:17Z',
|
|||||||
business_application='ADService',
|
business_application='ADService',
|
||||||
description='',
|
description='',
|
||||||
manually_edited=True,
|
manually_edited=True,
|
||||||
attributes={"Region":"EU"}
|
attributes={"Region":"EU"},
|
||||||
|
subtype='Application',
|
||||||
|
owners=sailpoint.v2025.models.machine_identity_dto_owners.MachineIdentityDto_owners(
|
||||||
|
primary_identity = sailpoint.v2025.models.machine_identity_dto_owners_primary_identity.MachineIdentityDto_owners_primaryIdentity(),
|
||||||
|
secondary_identities = [
|
||||||
|
sailpoint.v2025.models.base_reference_dto.BaseReferenceDto(
|
||||||
|
type = 'IDENTITY',
|
||||||
|
id = '2c91808568c529c60168cca6f90c1313',
|
||||||
|
name = 'William Wilson', )
|
||||||
|
], )
|
||||||
)
|
)
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -0,0 +1,41 @@
|
|||||||
|
---
|
||||||
|
id: v2025-machine-identity-dto-owners
|
||||||
|
title: MachineIdentityDtoOwners
|
||||||
|
pagination_label: MachineIdentityDtoOwners
|
||||||
|
sidebar_label: MachineIdentityDtoOwners
|
||||||
|
sidebar_class_name: pythonsdk
|
||||||
|
keywords: ['python', 'Python', 'sdk', 'MachineIdentityDtoOwners', 'V2025MachineIdentityDtoOwners']
|
||||||
|
slug: /tools/sdk/python/v2025/models/machine-identity-dto-owners
|
||||||
|
tags: ['SDK', 'Software Development Kit', 'MachineIdentityDtoOwners', 'V2025MachineIdentityDtoOwners']
|
||||||
|
---
|
||||||
|
|
||||||
|
# MachineIdentityDtoOwners
|
||||||
|
|
||||||
|
The owner configuration associated to the machine identity
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**primary_identity** | **object** | Defines the identity which is selected as the primary owner | [required]
|
||||||
|
**secondary_identities** | [**[]BaseReferenceDto**](base-reference-dto) | Defines the identities which are selected as secondary owners | [required]
|
||||||
|
}
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```python
|
||||||
|
from sailpoint.v2025.models.machine_identity_dto_owners import MachineIdentityDtoOwners
|
||||||
|
|
||||||
|
machine_identity_dto_owners = MachineIdentityDtoOwners(
|
||||||
|
primary_identity=sailpoint.v2025.models.machine_identity_dto_owners_primary_identity.MachineIdentityDto_owners_primaryIdentity(),
|
||||||
|
secondary_identities=[
|
||||||
|
sailpoint.v2025.models.base_reference_dto.BaseReferenceDto(
|
||||||
|
type = 'IDENTITY',
|
||||||
|
id = '2c91808568c529c60168cca6f90c1313',
|
||||||
|
name = 'William Wilson', )
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
```
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
@@ -11228,12 +11228,25 @@
|
|||||||
with ApiClient(configuration) as api_client:
|
with ApiClient(configuration) as api_client:
|
||||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||||
machine_identity = '''{
|
machine_identity = '''{
|
||||||
|
"subtype" : "Application",
|
||||||
"created" : "2015-05-28T14:07:17Z",
|
"created" : "2015-05-28T14:07:17Z",
|
||||||
"businessApplication" : "ADService",
|
"businessApplication" : "ADService",
|
||||||
"name" : "aName",
|
"name" : "aName",
|
||||||
"modified" : "2015-05-28T14:07:17Z",
|
"modified" : "2015-05-28T14:07:17Z",
|
||||||
"description" : "",
|
"description" : "",
|
||||||
"attributes" : "{\"Region\":\"EU\"}",
|
"attributes" : "{\"Region\":\"EU\"}",
|
||||||
|
"owners" : {
|
||||||
|
"primaryIdentity" : "{}",
|
||||||
|
"secondaryIdentities" : [ {
|
||||||
|
"name" : "William Wilson",
|
||||||
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
||||||
|
"type" : "IDENTITY"
|
||||||
|
}, {
|
||||||
|
"name" : "William Wilson",
|
||||||
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
||||||
|
"type" : "IDENTITY"
|
||||||
|
} ]
|
||||||
|
},
|
||||||
"id" : "id12345",
|
"id" : "id12345",
|
||||||
"manuallyEdited" : true
|
"manuallyEdited" : true
|
||||||
}''' # MachineIdentity |
|
}''' # MachineIdentity |
|
||||||
@@ -11314,7 +11327,7 @@
|
|||||||
|
|
||||||
with ApiClient(configuration) as api_client:
|
with ApiClient(configuration) as api_client:
|
||||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||||
filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) # str | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional)
|
filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # str | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* (optional) # str | 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* (optional)
|
||||||
sorters = 'businessApplication' # str | 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: **businessApplication, name** (optional) # str | 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: **businessApplication, name** (optional)
|
sorters = 'businessApplication' # str | 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: **businessApplication, name** (optional) # str | 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: **businessApplication, name** (optional)
|
||||||
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)
|
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)
|
||||||
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||||
|
|||||||
Reference in New Issue
Block a user