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

update layout for method examples

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-25 11:46:14 -05:00
parent a4e2ab4717
commit aa76768244
208 changed files with 14924 additions and 9712 deletions
Download Patch File Download Diff File Expand all files Collapse all files

237
docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md
View File

@@ -66,25 +66,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.domain_address import DomainAddress
from sailpoint.beta.models.domain_status_dto import DomainStatusDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
domain_address = {
"domain" : "sailpoint.com"
} # DomainAddress |
try:
# Verify domain address via DKIM
Result = domain_address.from_json(domain_address)
api_response = api_instance.create_domain_dkim(Result)
new_domain_address = DomainAddress()
new_domain_address.from_json(domain_address)
results =NotificationsApi(api_client).create_domain_dkim(new_domain_address)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_domain_dkim(Result)
# results = NotificationsApi(api_client).create_domain_dkim(new_domain_address)
print("The response of NotificationsApi->create_domain_dkim:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e)
```
@@ -127,10 +131,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_dto import TemplateDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
template_dto = {
"slackTemplate" : "slackTemplate",
"footer" : "footer",
@@ -152,14 +160,14 @@ from pprint import pprint
try:
# Create Notification Template
Result = template_dto.from_json(template_dto)
api_response = api_instance.create_notification_template(Result)
new_template_dto = TemplateDto()
new_template_dto.from_json(template_dto)
results =NotificationsApi(api_client).create_notification_template(new_template_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_notification_template(Result)
# results = NotificationsApi(api_client).create_notification_template(new_template_dto)
print("The response of NotificationsApi->create_notification_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e)
```
@@ -200,10 +208,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.email_status_dto import EmailStatusDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
email_status_dto = {
"isVerifiedByDomain" : false,
"verificationStatus" : "PENDING",
@@ -213,14 +225,14 @@ from pprint import pprint
try:
# Create Verified From Address
Result = email_status_dto.from_json(email_status_dto)
api_response = api_instance.create_verified_from_address(Result)
new_email_status_dto = EmailStatusDto()
new_email_status_dto.from_json(email_status_dto)
results =NotificationsApi(api_client).create_verified_from_address(new_email_status_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_verified_from_address(Result)
# results = NotificationsApi(api_client).create_verified_from_address(new_email_status_dto)
print("The response of NotificationsApi->create_verified_from_address:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e)
```
@@ -261,10 +273,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_bulk_delete_dto import TemplateBulkDeleteDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] |
template_bulk_delete_dto = {
"medium" : "EMAIL",
@@ -275,12 +291,12 @@ from pprint import pprint
try:
# Bulk Delete Notification Templates
Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto)
api_instance.delete_notification_templates_in_bulk(Result)
new_template_bulk_delete_dto = TemplateBulkDeleteDto()
new_template_bulk_delete_dto.from_json(template_bulk_delete_dto)
NotificationsApi(api_client).delete_notification_templates_in_bulk(new_template_bulk_delete_dto)
# Below is a request that includes all optional parameters
# api_instance.delete_notification_templates_in_bulk(Result)
except Exception as e:
# NotificationsApi(api_client).delete_notification_templates_in_bulk(new_template_bulk_delete_dto)
except Exception as e:
print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e)
```
@@ -322,19 +338,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.rest import ApiException
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | # str |
try:
# Delete Verified From Address
api_instance.delete_verified_from_address(id)
NotificationsApi(api_client).delete_verified_from_address(id)
# Below is a request that includes all optional parameters
# api_instance.delete_verified_from_address(id)
except Exception as e:
# NotificationsApi(api_client).delete_verified_from_address(id)
except Exception as e:
print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e)
```
@@ -372,21 +391,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.dkim_attributes import DkimAttributes
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get DKIM Attributes
api_response = api_instance.get_dkim_attributes()
results =NotificationsApi(api_client).get_dkim_attributes()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_dkim_attributes()
# results = NotificationsApi(api_client).get_dkim_attributes()
print("The response of NotificationsApi->get_dkim_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e)
```
@@ -427,22 +449,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mail_from_attributes import MailFromAttributes
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
try:
# Get MAIL FROM Attributes
api_response = api_instance.get_mail_from_attributes(identity_id)
results =NotificationsApi(api_client).get_mail_from_attributes(identity_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_mail_from_attributes(identity_id)
# results = NotificationsApi(api_client).get_mail_from_attributes(identity_id)
print("The response of NotificationsApi->get_mail_from_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e)
```
@@ -483,22 +508,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_dto import TemplateDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template
try:
# Get Notification Template By Id
api_response = api_instance.get_notification_template(id)
results =NotificationsApi(api_client).get_notification_template(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_notification_template(id)
# results = NotificationsApi(api_client).get_notification_template(id)
print("The response of NotificationsApi->get_notification_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e)
```
@@ -537,21 +565,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.notification_template_context import NotificationTemplateContext
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Notification Template Context
api_response = api_instance.get_notifications_template_context()
results =NotificationsApi(api_client).get_notifications_template_context()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_notifications_template_context()
# results = NotificationsApi(api_client).get_notifications_template_context()
print("The response of NotificationsApi->get_notifications_template_context:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e)
```
@@ -595,10 +626,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.email_status_dto import EmailStatusDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
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)
@@ -608,13 +643,12 @@ from pprint import pprint
try:
# List From Addresses
api_response = api_instance.list_from_addresses()
results =NotificationsApi(api_client).list_from_addresses()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_from_addresses(limit, offset, count, filters, sorters)
# results = NotificationsApi(api_client).list_from_addresses(limit, offset, count, filters, sorters)
print("The response of NotificationsApi->list_from_addresses:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e)
```
@@ -656,22 +690,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.preferences_dto import PreferencesDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key.
try:
# List Notification Preferences for tenant.
api_response = api_instance.list_notification_preferences(key)
results =NotificationsApi(api_client).list_notification_preferences(key)
# Below is a request that includes all optional parameters
# api_response = api_instance.list_notification_preferences(key)
# results = NotificationsApi(api_client).list_notification_preferences(key)
print("The response of NotificationsApi->list_notification_preferences:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e)
```
@@ -714,10 +751,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_dto_default import TemplateDtoDefault
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
filters = 'key eq \"cloud_manual_work_item_summary\"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional)
@@ -725,13 +766,12 @@ from pprint import pprint
try:
# List Notification Template Defaults
api_response = api_instance.list_notification_template_defaults()
results =NotificationsApi(api_client).list_notification_template_defaults()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_notification_template_defaults(limit, offset, filters)
# results = NotificationsApi(api_client).list_notification_template_defaults(limit, offset, filters)
print("The response of NotificationsApi->list_notification_template_defaults:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e)
```
@@ -774,10 +814,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_dto import TemplateDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
filters = 'medium eq \"EMAIL\"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional)
@@ -785,13 +829,12 @@ from pprint import pprint
try:
# List Notification Templates
api_response = api_instance.list_notification_templates()
results =NotificationsApi(api_client).list_notification_templates()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_notification_templates(limit, offset, filters)
# results = NotificationsApi(api_client).list_notification_templates(limit, offset, filters)
print("The response of NotificationsApi->list_notification_templates:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e)
```
@@ -832,11 +875,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mail_from_attributes import MailFromAttributes
from sailpoint.beta.models.mail_from_attributes_dto import MailFromAttributesDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mail_from_attributes_dto = {
"identity" : "BobSmith@sailpoint.com",
"mailFromDomain" : "example.sailpoint.com"
@@ -844,14 +891,14 @@ from pprint import pprint
try:
# Change MAIL FROM domain
Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto)
api_response = api_instance.put_mail_from_attributes(Result)
new_mail_from_attributes_dto = MailFromAttributesDto()
new_mail_from_attributes_dto.from_json(mail_from_attributes_dto)
results =NotificationsApi(api_client).put_mail_from_attributes(new_mail_from_attributes_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_mail_from_attributes(Result)
# results = NotificationsApi(api_client).put_mail_from_attributes(new_mail_from_attributes_dto)
print("The response of NotificationsApi->put_mail_from_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e)
```
@@ -893,10 +940,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.send_test_notification_request_dto import SendTestNotificationRequestDto
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
send_test_notification_request_dto = {
"context" : "{}",
"medium" : "EMAIL",
@@ -905,12 +956,12 @@ from pprint import pprint
try:
# Send Test Notification
Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto)
api_instance.send_test_notification(Result)
new_send_test_notification_request_dto = SendTestNotificationRequestDto()
new_send_test_notification_request_dto.from_json(send_test_notification_request_dto)
NotificationsApi(api_client).send_test_notification(new_send_test_notification_request_dto)
# Below is a request that includes all optional parameters
# api_instance.send_test_notification(Result)
except Exception as e:
# NotificationsApi(api_client).send_test_notification(new_send_test_notification_request_dto)
except Exception as e:
print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e)
```