mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
Update python SDK docs: 16971661330
This commit is contained in:
developer-relations-sp
@@ -967,6 +967,34 @@
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e)
|
||||
- path: /revocable-objects
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/access-requests#get-entitlement-details-for-identity
|
||||
source: |
|
||||
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_entitlement_details import IdentityEntitlementDetails
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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')
|
||||
identity_id = '7025c863c2704ba6beeaedf3cb091573' # str | The identity ID. # str | The identity ID.
|
||||
entitlement_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The entitlement ID # str | The entitlement ID
|
||||
try:
|
||||
# Identity entitlement details
|
||||
|
||||
results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental=x_sail_point_experimental, identity_id=identity_id, entitlement_id=entitlement_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental, identity_id, entitlement_id)
|
||||
print("The response of AccessRequestsApi->get_entitlement_details_for_identity:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling AccessRequestsApi->get_entitlement_details_for_identity: %s\n" % e)
|
||||
- path: /access-request-status
|
||||
method: GET
|
||||
xCodeSample:
|
||||
@@ -1052,8 +1080,10 @@
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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')
|
||||
accounts_selection_request = '''{
|
||||
"requestedFor" : "2c918084660f45d6016617daa9210584",
|
||||
"clientMetadata" : {
|
||||
@@ -1121,9 +1151,9 @@
|
||||
try:
|
||||
# Get accounts selections for identity
|
||||
new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request)
|
||||
results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request)
|
||||
results = AccessRequestsApi(api_client).load_account_selections(x_sail_point_experimental=x_sail_point_experimental, accounts_selection_request=new_accounts_selection_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request)
|
||||
# results = AccessRequestsApi(api_client).load_account_selections(x_sail_point_experimental, new_accounts_selection_request)
|
||||
print("The response of AccessRequestsApi->load_account_selections:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -9231,6 +9261,35 @@
|
||||
print(item.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e)
|
||||
- path: /entitlements/identities/{id}/entitlements
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/identities#list-entitlements-by-identity
|
||||
source: |
|
||||
from sailpoint.v2024.api.identities_api import IdentitiesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_entitlements import IdentityEntitlements
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
|
||||
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)
|
||||
try:
|
||||
# List of entitlements by identity.
|
||||
|
||||
results = IdentitiesApi(api_client).list_entitlements_by_identity(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentitiesApi(api_client).list_entitlements_by_identity(id, limit, offset, count)
|
||||
print("The response of IdentitiesApi->list_entitlements_by_identity:\n")
|
||||
for item in results:
|
||||
print(item.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentitiesApi->list_entitlements_by_identity: %s\n" % e)
|
||||
- path: /identities
|
||||
method: GET
|
||||
xCodeSample:
|
||||
@@ -9326,8 +9385,10 @@
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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')
|
||||
invite_identities_request = '''{
|
||||
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
|
||||
"uninvited" : false
|
||||
@@ -9335,9 +9396,9 @@
|
||||
try:
|
||||
# Invite identities to register
|
||||
new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request)
|
||||
results = IdentitiesApi(api_client).start_identities_invite(invite_identities_request=new_invite_identities_request)
|
||||
results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental=x_sail_point_experimental, invite_identities_request=new_invite_identities_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request)
|
||||
# results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, new_invite_identities_request)
|
||||
print("The response of IdentitiesApi->start_identities_invite:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -10104,10 +10165,8 @@
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = True
|
||||
|
||||
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')
|
||||
identity_preview_request = '''{
|
||||
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
||||
"identityAttributeConfig" : {
|
||||
@@ -10138,9 +10197,9 @@
|
||||
try:
|
||||
# Generate identity profile preview
|
||||
new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request)
|
||||
results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental=x_sail_point_experimental, identity_preview_request=new_identity_preview_request)
|
||||
results = IdentityProfilesApi(api_client).generate_identity_preview(identity_preview_request=new_identity_preview_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request)
|
||||
# results = IdentityProfilesApi(api_client).generate_identity_preview(new_identity_preview_request)
|
||||
print("The response of IdentityProfilesApi->generate_identity_preview:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -10302,6 +10361,178 @@
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e)
|
||||
- path: /launchers
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/launchers#create-launcher
|
||||
source: |
|
||||
from sailpoint.v2024.api.launchers_api import LaunchersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.launcher import Launcher
|
||||
from sailpoint.v2024.models.launcher_request import LauncherRequest
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
launcher_request = '''{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}''' # LauncherRequest | Payload to create a Launcher
|
||||
try:
|
||||
# Create launcher
|
||||
new_launcher_request = LauncherRequest.from_json(launcher_request)
|
||||
results = LaunchersApi(api_client).create_launcher(launcher_request=new_launcher_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = LaunchersApi(api_client).create_launcher(new_launcher_request)
|
||||
print("The response of LaunchersApi->create_launcher:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling LaunchersApi->create_launcher: %s\n" % e)
|
||||
- path: /launchers/{launcherID}
|
||||
method: DELETE
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/launchers#delete-launcher
|
||||
source: |
|
||||
from sailpoint.v2024.api.launchers_api import LaunchersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted
|
||||
try:
|
||||
# Delete launcher
|
||||
|
||||
LaunchersApi(api_client).delete_launcher(launcher_id=launcher_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# LaunchersApi(api_client).delete_launcher(launcher_id)
|
||||
except Exception as e:
|
||||
print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e)
|
||||
- path: /launchers/{launcherID}
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/launchers#get-launcher
|
||||
source: |
|
||||
from sailpoint.v2024.api.launchers_api import LaunchersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.launcher import Launcher
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved
|
||||
try:
|
||||
# Get launcher by id
|
||||
|
||||
results = LaunchersApi(api_client).get_launcher(launcher_id=launcher_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = LaunchersApi(api_client).get_launcher(launcher_id)
|
||||
print("The response of LaunchersApi->get_launcher:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling LaunchersApi->get_launcher: %s\n" % e)
|
||||
- path: /launchers
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/launchers#get-launchers
|
||||
source: |
|
||||
from sailpoint.v2024.api.launchers_api import LaunchersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.get_launchers200_response import GetLaunchers200Response
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
filters = 'disabled eq \"true\"' # 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: **description**: *sw* **disabled**: *eq* **name**: *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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional)
|
||||
next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional)
|
||||
limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10)
|
||||
try:
|
||||
# List all launchers for tenant
|
||||
|
||||
results = LaunchersApi(api_client).get_launchers()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = LaunchersApi(api_client).get_launchers(filters, next, limit)
|
||||
print("The response of LaunchersApi->get_launchers:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling LaunchersApi->get_launchers: %s\n" % e)
|
||||
- path: /launchers/{launcherID}
|
||||
method: PUT
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/launchers#put-launcher
|
||||
source: |
|
||||
from sailpoint.v2024.api.launchers_api import LaunchersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.launcher import Launcher
|
||||
from sailpoint.v2024.models.launcher_request import LauncherRequest
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced
|
||||
launcher_request = '''{
|
||||
"reference" : {
|
||||
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
|
||||
"type" : "WORKFLOW"
|
||||
},
|
||||
"name" : "Group Create",
|
||||
"description" : "Create a new Active Directory Group",
|
||||
"disabled" : false,
|
||||
"type" : "INTERACTIVE_PROCESS",
|
||||
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
|
||||
}''' # LauncherRequest | Payload to replace Launcher
|
||||
try:
|
||||
# Replace launcher
|
||||
new_launcher_request = LauncherRequest.from_json(launcher_request)
|
||||
results = LaunchersApi(api_client).put_launcher(launcher_id=launcher_id, launcher_request=new_launcher_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request)
|
||||
print("The response of LaunchersApi->put_launcher:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling LaunchersApi->put_launcher: %s\n" % e)
|
||||
- path: /launchers/{launcherID}/launch
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/launchers#start-launcher
|
||||
source: |
|
||||
from sailpoint.v2024.api.launchers_api import LaunchersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.start_launcher200_response import StartLauncher200Response
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched
|
||||
try:
|
||||
# Launch a launcher
|
||||
|
||||
results = LaunchersApi(api_client).start_launcher(launcher_id=launcher_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = LaunchersApi(api_client).start_launcher(launcher_id)
|
||||
print("The response of LaunchersApi->start_launcher:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling LaunchersApi->start_launcher: %s\n" % e)
|
||||
- path: /identity-profiles/{identity-profile-id}/lifecycle-states
|
||||
method: POST
|
||||
xCodeSample:
|
||||
@@ -20280,6 +20511,122 @@
|
||||
print(item.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e)
|
||||
- path: /tags
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/tags#create-tag
|
||||
source: |
|
||||
from sailpoint.v2024.api.tags_api import TagsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.tag import Tag
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
tag = '''{
|
||||
"created" : "2022-05-04T14:48:49Z",
|
||||
"tagCategoryRefs" : [ {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
}, {
|
||||
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
||||
"id" : "2c91809773dee32014e13e122092014e",
|
||||
"type" : "ENTITLEMENT"
|
||||
} ],
|
||||
"name" : "PCI",
|
||||
"modified" : "2022-07-14T16:31:11Z",
|
||||
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
|
||||
}''' # Tag |
|
||||
try:
|
||||
# Create tag
|
||||
new_tag = Tag.from_json(tag)
|
||||
results = TagsApi(api_client).create_tag(tag=new_tag)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = TagsApi(api_client).create_tag(new_tag)
|
||||
print("The response of TagsApi->create_tag:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling TagsApi->create_tag: %s\n" % e)
|
||||
- path: /tags/{id}
|
||||
method: DELETE
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/tags#delete-tag-by-id
|
||||
source: |
|
||||
from sailpoint.v2024.api.tags_api import TagsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete.
|
||||
try:
|
||||
# Delete tag
|
||||
|
||||
TagsApi(api_client).delete_tag_by_id(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# TagsApi(api_client).delete_tag_by_id(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e)
|
||||
- path: /tags/{id}
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/tags#get-tag-by-id
|
||||
source: |
|
||||
from sailpoint.v2024.api.tags_api import TagsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.tag import Tag
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
|
||||
try:
|
||||
# Get tag by id
|
||||
|
||||
results = TagsApi(api_client).get_tag_by_id(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = TagsApi(api_client).get_tag_by_id(id)
|
||||
print("The response of TagsApi->get_tag_by_id:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e)
|
||||
- path: /tags
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: Python
|
||||
label: SDK_tools/sdk/python/v2024/methods/tags#list-tags
|
||||
source: |
|
||||
from sailpoint.v2024.api.tags_api import TagsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.tag import Tag
|
||||
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)
|
||||
filters = 'id eq \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # 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* **name**: *eq, in, 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: **id**: *eq, in* **name**: *eq, in, sw* (optional)
|
||||
sorters = 'name,-modified' # 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: **id, name, created, modified** (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: **id, name, created, modified** (optional)
|
||||
try:
|
||||
# List tags
|
||||
|
||||
results = TagsApi(api_client).list_tags()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters)
|
||||
print("The response of TagsApi->list_tags:\n")
|
||||
for item in results:
|
||||
print(item.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling TagsApi->list_tags: %s\n" % e)
|
||||
- path: /task-status/pending-tasks
|
||||
method: HEAD
|
||||
xCodeSample:
|
||||
|
||||
Reference in New Issue
Block a user