mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
Update python SDK docs: 16971661330
This commit is contained in:
developer-relations-sp
@@ -36,6 +36,7 @@ Method | HTTP request | Description
|
||||
[**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close access request
|
||||
[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit access request
|
||||
[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration
|
||||
[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **GET** `/revocable-objects` | Identity entitlement details
|
||||
[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access request status
|
||||
[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access request status for administrators
|
||||
[**load-account-selections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity
|
||||
@@ -609,6 +610,81 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-entitlement-details-for-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Identity entitlement details
|
||||
Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-details-for-identity)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Path | identity_id | **str** | True | The identity ID.
|
||||
Path | entitlement_id | **str** | True | The entitlement ID
|
||||
|
||||
### Return type
|
||||
[**IdentityEntitlementDetails**](../models/identity-entitlement-details)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Entitlement and Account Reference | IdentityEntitlementDetails | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-access-request-status
|
||||
@@ -783,6 +859,17 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## load-account-selections
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Get accounts selections for identity
|
||||
Use this API to fetch account information for an identity against the items in an access request.
|
||||
|
||||
@@ -795,6 +882,7 @@ Used to fetch accountSelection for the AccessRequest prior to submitting for asy
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | accounts_selection_request | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -824,8 +912,10 @@ from sailpoint.v2024.models.accounts_selection_response import AccountsSelection
|
||||
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" : {
|
||||
@@ -894,9 +984,9 @@ with ApiClient(configuration) as api_client:
|
||||
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:
|
||||
|
||||
@@ -196,7 +196,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign | - |
|
||||
202 | This response indicates that the requested campaign has been successfully accepted into the system, and its representation is returned by the API. | Campaign | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
|
||||
@@ -35,6 +35,7 @@ Method | HTTP request | Description
|
||||
[**get-identity-ownership-details**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details
|
||||
[**get-role-assignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details
|
||||
[**get-role-assignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments
|
||||
[**list-entitlements-by-identity**](#list-entitlements-by-identity) | **GET** `/entitlements/identities/{id}/entitlements` | List of entitlements by identity.
|
||||
[**list-identities**](#list-identities) | **GET** `/identities` | List identities
|
||||
[**reset-identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity
|
||||
[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
|
||||
@@ -342,6 +343,72 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-entitlements-by-identity
|
||||
List of entitlements by identity.
|
||||
The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlements-by-identity)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Identity Id
|
||||
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 | offset | **int** | (optional) (default to 0) | 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.
|
||||
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.
|
||||
|
||||
### Return type
|
||||
[**List[IdentityEntitlements]**](../models/identity-entitlements)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of all Entitlements for given Identity | List[IdentityEntitlements] | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-identities
|
||||
@@ -547,6 +614,17 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-identities-invite
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Invite identities to register
|
||||
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
|
||||
|
||||
@@ -561,6 +639,7 @@ The executed task status can be checked by Task Management > [Get task status by
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | invite_identities_request | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -591,8 +670,10 @@ from sailpoint.v2024.models.task_status import TaskStatus
|
||||
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
|
||||
@@ -601,9 +682,9 @@ with ApiClient(configuration) as api_client:
|
||||
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:
|
||||
|
||||
@@ -334,17 +334,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## generate-identity-preview
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Generate identity profile preview
|
||||
This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied.
|
||||
|
||||
@@ -354,7 +343,6 @@ This generates a non-persisted IdentityDetails object that will represent as the
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | identity_preview_request | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
|
||||
|
||||
### Return type
|
||||
@@ -384,10 +372,8 @@ from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResp
|
||||
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" : {
|
||||
@@ -419,9 +405,9 @@ with ApiClient(configuration) as api_client:
|
||||
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:
|
||||
|
||||
406
docs/tools/sdk/python/Reference/V2024/Methods/LaunchersApi.md
Normal file
406
docs/tools/sdk/python/Reference/V2024/Methods/LaunchersApi.md
Normal file
@@ -0,0 +1,406 @@
|
||||
---
|
||||
id: v2024-launchers
|
||||
title: Launchers
|
||||
pagination_label: Launchers
|
||||
sidebar_label: Launchers
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Launchers', 'V2024Launchers']
|
||||
slug: /tools/sdk/python/v2024/methods/launchers
|
||||
tags: ['SDK', 'Software Development Kit', 'Launchers', 'V2024Launchers']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.LaunchersApi
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-launcher**](#create-launcher) | **POST** `/launchers` | Create launcher
|
||||
[**delete-launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete launcher
|
||||
[**get-launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get launcher by id
|
||||
[**get-launchers**](#get-launchers) | **GET** `/launchers` | List all launchers for tenant
|
||||
[**put-launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace launcher
|
||||
[**start-launcher**](#start-launcher) | **POST** `/launchers/{launcherID}/launch` | Launch a launcher
|
||||
|
||||
|
||||
## create-launcher
|
||||
Create launcher
|
||||
Create a Launcher with given information
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-launcher)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | launcher_request | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher
|
||||
|
||||
### Return type
|
||||
[**Launcher**](../models/launcher)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
201 | Launcher created successfully | Launcher | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-launcher
|
||||
Delete launcher
|
||||
Delete the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-launcher)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | launcher_id | **str** | True | ID of the Launcher to be deleted
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | Launcher deleted successfully | | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-launcher
|
||||
Get launcher by id
|
||||
Get details for the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-launcher)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | launcher_id | **str** | True | ID of the Launcher to be retrieved
|
||||
|
||||
### Return type
|
||||
[**Launcher**](../models/launcher)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Launcher retrieved successfully | Launcher | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-launchers
|
||||
List all launchers for tenant
|
||||
Return a list of Launchers for the authenticated tenant
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-launchers)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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: **description**: *sw* **disabled**: *eq* **name**: *sw*
|
||||
Query | next | **str** | (optional) | Pagination marker
|
||||
Query | limit | **int** | (optional) (default to 10) | Number of Launchers to return
|
||||
|
||||
### Return type
|
||||
[**GetLaunchers200Response**](../models/get-launchers200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of Launchers | GetLaunchers200Response | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-launcher
|
||||
Replace launcher
|
||||
Replace the given Launcher ID with given payload
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-launcher)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | launcher_id | **str** | True | ID of the Launcher to be replaced
|
||||
Body | launcher_request | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher
|
||||
|
||||
### Return type
|
||||
[**Launcher**](../models/launcher)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Launcher replaced successfully | Launcher | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-launcher
|
||||
Launch a launcher
|
||||
Launch the given Launcher ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-launcher)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | launcher_id | **str** | True | ID of the Launcher to be launched
|
||||
|
||||
### Return type
|
||||
[**StartLauncher200Response**](../models/start-launcher200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Launcher launched successfully | StartLauncher200Response | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
287
docs/tools/sdk/python/Reference/V2024/Methods/TagsApi.md
Normal file
287
docs/tools/sdk/python/Reference/V2024/Methods/TagsApi.md
Normal file
@@ -0,0 +1,287 @@
|
||||
---
|
||||
id: v2024-tags
|
||||
title: Tags
|
||||
pagination_label: Tags
|
||||
sidebar_label: Tags
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Tags', 'V2024Tags']
|
||||
slug: /tools/sdk/python/v2024/methods/tags
|
||||
tags: ['SDK', 'Software Development Kit', 'Tags', 'V2024Tags']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.TagsApi
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-tag**](#create-tag) | **POST** `/tags` | Create tag
|
||||
[**delete-tag-by-id**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete tag
|
||||
[**get-tag-by-id**](#get-tag-by-id) | **GET** `/tags/{id}` | Get tag by id
|
||||
[**list-tags**](#list-tags) | **GET** `/tags` | List tags
|
||||
|
||||
|
||||
## create-tag
|
||||
Create tag
|
||||
This API creates new tag.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-tag)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | tag | [**Tag**](../models/tag) | True |
|
||||
|
||||
### Return type
|
||||
[**Tag**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
201 | Created tag. | Tag | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-tag-by-id
|
||||
Delete tag
|
||||
This API deletes a tag by specified id.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tag-by-id)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The ID of the object reference to delete.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content. | | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-tag-by-id
|
||||
Get tag by id
|
||||
Returns a tag by its id.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tag-by-id)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The ID of the object reference to retrieve.
|
||||
|
||||
### Return type
|
||||
[**Tag**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Tag | Tag | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-tags
|
||||
List tags
|
||||
This API returns a list of tags.
|
||||
|
||||
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tags)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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 | offset | **int** | (optional) (default to 0) | 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.
|
||||
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 | 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* **name**: *eq, in, sw*
|
||||
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: **id, name, created, modified**
|
||||
|
||||
### Return type
|
||||
[**List[Tag]**](../models/tag)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of all tags. | List[Tag] | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user