sailpoint.role_insights.RoleInsightsApi

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-role-insight-requests-v1	POST `/role-insights/v1/requests`	Generate insights for roles
download-role-insights-entitlements-changes-v1	GET `/role-insights/v1/{insightId}/entitlement-changes/download`	Download entitlement insights for a role
get-entitlement-changes-identities-v1	GET `/role-insights/v1/{insightId}/entitlement-changes/{entitlementId}/identities`	Get identities for a suggested entitlement (for a role)
get-role-insight-v1	GET `/role-insights/v1/{insightId}`	Get a single role insight
get-role-insights-current-entitlements-v1	GET `/role-insights/v1/{insightId}/current-entitlements`	Get current entitlement for a role
get-role-insights-entitlements-changes-v1	GET `/role-insights/v1/{insightId}/entitlement-changes`	Get entitlement insights for a role
get-role-insights-requests-v1	GET `/role-insights/v1/requests/{id}`	Returns metadata from prior request.
get-role-insights-summary-v1	GET `/role-insights/v1/summary`	Get role insights summary information
get-role-insights-v1	GET `/role-insights/v1`	Get role insights

create-role-insight-requests-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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.

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:

  configuration = Configuration()
  configuration.experimental = True

Generate insights for roles Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

Roleinsightsresponse

Responses

Code	Description	Data Type	Response headers
201	Submitted a role insights generation request	Roleinsightsresponse	-
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.	CreateRoleInsightRequestsV1401Response	-
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.	CreateRoleInsightRequestsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.role_insights.models.roleinsightsresponse import Roleinsightsresponse
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. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Generate insights for roles
        
        results = RoleInsightsApi(api_client).create_role_insight_requests_v1()
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).create_role_insight_requests_v1(x_sail_point_experimental)
        print("The response of RoleInsightsApi->create_role_insight_requests_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->create_role_insight_requests_v1: %s\n" % e)

[Back to top]

download-role-insights-entitlements-changes-v1

experimental

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:

  configuration = Configuration()
  configuration.experimental = True

Download entitlement insights for a role This endpoint returns the entitlement insights for a role.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	insight_id	str	True	The role insight id
Query	sorters	str	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: identitiesWithAccess The default sort is identitiesWithAccess in descending order.
Query	filters	str	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: sw description: sw
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

str

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns a csv file containing a list of entitlements to be added for a role.	str	-
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.	CreateRoleInsightRequestsV1401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	Errorresponsedto	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: text/csv, application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
    sorters = 'identitiesWithAccess' # 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: **identitiesWithAccess**  The default sort is **identitiesWithAccess** in descending order. (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: **identitiesWithAccess**  The default sort is **identitiesWithAccess** in descending order. (optional)
    filters = 'name sw \"r\"' # 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:  **name**: *sw*  **description**: *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:  **name**: *sw*  **description**: *sw* (optional)
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Download entitlement insights for a role
        
        results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes_v1(insight_id=insight_id)
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes_v1(insight_id, sorters, filters, x_sail_point_experimental)
        print("The response of RoleInsightsApi->download_role_insights_entitlements_changes_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes_v1: %s\n" % e)

[Back to top]

get-entitlement-changes-identities-v1

experimental

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:

  configuration = Configuration()
  configuration.experimental = True

Get identities for a suggested entitlement (for a role) Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	insight_id	str	True	The role insight id
Path	entitlement_id	str	True	The entitlement id
Query	has_entitlement	bool	(optional) (default to False)	Identity has this entitlement or not
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 for more information.
Query	limit	int	(optional) (default to 250)	Max number of results to return. See V3 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 for more information.
Query	sorters	str	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name
Query	filters	str	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: sw
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

List[Roleinsightsidentities]

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns a list of identities with or without the entitlement.	List[Roleinsightsidentities]	-
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.	CreateRoleInsightRequestsV1401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	Errorresponsedto	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.role_insights.models.roleinsightsidentities import Roleinsightsidentities
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
    entitlement_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The entitlement id # str | The entitlement id
    has_entitlement = False # bool | Identity has this entitlement or not (optional) (default to False) # bool | Identity has this entitlement or not (optional) (default to False)
    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)
    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)
    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)
    sorters = 'name' # 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: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name** (optional)
    filters = 'name sw \"Jan\"' # 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:  **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:  **name**: *sw* (optional)
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Get identities for a suggested entitlement (for a role)
        
        results = RoleInsightsApi(api_client).get_entitlement_changes_identities_v1(insight_id=insight_id, entitlement_id=entitlement_id)
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).get_entitlement_changes_identities_v1(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters, x_sail_point_experimental)
        print("The response of RoleInsightsApi->get_entitlement_changes_identities_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities_v1: %s\n" % e)

[Back to top]

get-role-insight-v1

experimental

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:

  configuration = Configuration()
  configuration.experimental = True

Get a single role insight This endpoint gets role insights information for a role.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	insight_id	str	True	The role insight id
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

Roleinsight

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns information about insights for a single role.	Roleinsight	-
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.	CreateRoleInsightRequestsV1401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	Errorresponsedto	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.role_insights.models.roleinsight import Roleinsight
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Get a single role insight
        
        results = RoleInsightsApi(api_client).get_role_insight_v1(insight_id=insight_id)
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).get_role_insight_v1(insight_id, x_sail_point_experimental)
        print("The response of RoleInsightsApi->get_role_insight_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->get_role_insight_v1: %s\n" % e)

[Back to top]

get-role-insights-current-entitlements-v1

experimental

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:

  configuration = Configuration()
  configuration.experimental = True

Get current entitlement for a role This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	insight_id	str	True	The role insight id
Query	filters	str	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: sw description: sw
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

List[Roleinsightsentitlement]

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns a list of current or pre-existing entitlements for a role.	List[Roleinsightsentitlement]	-
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.	CreateRoleInsightRequestsV1401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	Errorresponsedto	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.role_insights.models.roleinsightsentitlement import Roleinsightsentitlement
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
    filters = 'name sw \"r\"' # 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:  **name**: *sw*  **description**: *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:  **name**: *sw*  **description**: *sw* (optional)
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Get current entitlement for a role
        
        results = RoleInsightsApi(api_client).get_role_insights_current_entitlements_v1(insight_id=insight_id)
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements_v1(insight_id, filters, x_sail_point_experimental)
        print("The response of RoleInsightsApi->get_role_insights_current_entitlements_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements_v1: %s\n" % e)

[Back to top]

get-role-insights-entitlements-changes-v1

experimental

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:

  configuration = Configuration()
  configuration.experimental = True

Get entitlement insights for a role This endpoint returns entitlement insights for a role.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	insight_id	str	True	The role insight id
Query	sorters	str	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: identitiesWithAccess, name
Query	filters	str	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: sw description: sw
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

List[Roleinsightsentitlementchanges]

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns a list of entitlements to be added for a role.	List[Roleinsightsentitlementchanges]	-
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.	CreateRoleInsightRequestsV1401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	Errorresponsedto	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.role_insights.models.roleinsightsentitlementchanges import Roleinsightsentitlementchanges
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
    sorters = 'sorters_example' # 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: **identitiesWithAccess, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **identitiesWithAccess, name** (optional)
    filters = 'name sw \"Admin\"' # 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:  **name**: *sw*  **description**: *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:  **name**: *sw*  **description**: *sw* (optional)
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Get entitlement insights for a role
        
        results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes_v1(insight_id=insight_id)
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes_v1(insight_id, sorters, filters, x_sail_point_experimental)
        print("The response of RoleInsightsApi->get_role_insights_entitlements_changes_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes_v1: %s\n" % e)

[Back to top]

get-role-insights-requests-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

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:

  configuration = Configuration()
  configuration.experimental = True

Returns metadata from prior request. This endpoint returns details of a prior role insights request.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The role insights request id
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

Roleinsightsresponse

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns details of an earlier role insights request.	Roleinsightsresponse	-
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.	CreateRoleInsightRequestsV1401Response	-
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.	CreateRoleInsightRequestsV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.role_insights.models.roleinsightsresponse import Roleinsightsresponse
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Returns metadata from prior request.
        
        results = RoleInsightsApi(api_client).get_role_insights_requests_v1(id=id)
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).get_role_insights_requests_v1(id, x_sail_point_experimental)
        print("The response of RoleInsightsApi->get_role_insights_requests_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->get_role_insights_requests_v1: %s\n" % e)

[Back to top]

get-role-insights-summary-v1

experimental

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:

  configuration = Configuration()
  configuration.experimental = True

Get role insights summary information This method returns high level summary information for role insights for a customer.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

Roleinsightssummary

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns high level counts.	Roleinsightssummary	-
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.	CreateRoleInsightRequestsV1401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	Errorresponsedto	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.role_insights.models.roleinsightssummary import Roleinsightssummary
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. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Get role insights summary information
        
        results = RoleInsightsApi(api_client).get_role_insights_summary_v1()
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).get_role_insights_summary_v1(x_sail_point_experimental)
        print("The response of RoleInsightsApi->get_role_insights_summary_v1:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->get_role_insights_summary_v1: %s\n" % e)

[Back to top]

get-role-insights-v1

experimental

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:

  configuration = Configuration()
  configuration.experimental = True

Get role insights This method returns detailed role insights for each role.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
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 for more information.
Query	limit	int	(optional) (default to 250)	Max number of results to return. See V3 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 for more information.
Query	sorters	str	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities
Query	filters	str	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: sw ownerName: sw description: sw
x_sail_point_experimental	str	(optional) (default to 'true')	Use this header to enable this experimental API.

Return type

List[Roleinsight]

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns a list of roles with information about insights for each role.	List[Roleinsight]	-
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.	CreateRoleInsightRequestsV1401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	Errorresponsedto	-
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

from sailpoint.role_insights.api.role_insights_api import RoleInsightsApi
from sailpoint.role_insights.api_client import ApiClient
from sailpoint.role_insights.models.roleinsight import Roleinsight
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = True

with ApiClient(configuration) as api_client:
    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)
    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)
    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)
    sorters = 'numberOfUpdates' # 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional)
    filters = 'name sw \"John\"' # 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:  **name**: *sw*  **ownerName**: *sw*  **description**: *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:  **name**: *sw*  **ownerName**: *sw*  **description**: *sw* (optional)
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')

    try:
        # Get role insights
        
        results = RoleInsightsApi(api_client).get_role_insights_v1()
        # Below is a request that includes all optional parameters
        # results = RoleInsightsApi(api_client).get_role_insights_v1(offset, limit, count, sorters, filters, x_sail_point_experimental)
        print("The response of RoleInsightsApi->get_role_insights_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling RoleInsightsApi->get_role_insights_v1: %s\n" % e)

[Back to top]

create-role-insight-requests-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

download-role-insights-entitlements-changes-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-entitlement-changes-identities-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-role-insight-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-role-insights-current-entitlements-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-role-insights-entitlements-changes-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-role-insights-requests-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-role-insights-summary-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-role-insights-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-role-insight-requests-v1

Parameters

Return type

Responses

HTTP request headers

Example

download-role-insights-entitlements-changes-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-entitlement-changes-identities-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-role-insight-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-role-insights-current-entitlements-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-role-insights-entitlements-changes-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-role-insights-requests-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-role-insights-summary-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-role-insights-v1

Parameters

Return type

Responses

HTTP request headers

Example