LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00

Files

darrell-thobe-sp c18583ede4 starting point for adding python sdk docs

2025-02-20 12:59:19 -05:00

16 KiB

Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

title

pagination_label

sidebar_label

sidebar_class_name

keywords

slug

sailpoint.v2024.IAICommonAccessApi

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

Method	HTTP request	Description
create_common_access	POST `/common-access`	Create common access items
get_common_access	GET `/common-access`	Get a paginated list of common access
update_common_access_status_in_bulk	POST `/common-access/update-status`	Bulk update common access status

create-common-access

:::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. ::: Create common access items This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create

API Spec

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.
Body	common_access_item_request	CommonAccessItemRequest	True

Return type

CommonAccessItemResponse

Responses

Code	Description	Data Type	Response headers
202	Returns details of the common access classification request.	CommonAccessItemResponse	-
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

import sailpoint.v2024
from sailpoint.v2024.models.common_access_item_request import CommonAccessItemRequest
from sailpoint.v2024.models.common_access_item_response import CommonAccessItemResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    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')
    common_access_item_request = {
          "access" : {
            "ownerName" : "ownerName",
            "name" : "name",
            "description" : "description",
            "id" : "id",
            "type" : "ACCESS_PROFILE",
            "ownerId" : "ownerId"
          },
          "status" : "CONFIRMED"
        } # CommonAccessItemRequest | 

    try:
        # Create common access items
        Result = common_access_item_request.from_json(common_access_item_request)
        api_response = api_instance.create_common_access(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.create_common_access(x_sail_point_experimental, Result)
        print("The response of IAICommonAccessApi->create_common_access:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e)

[Back to top]

get-common-access

:::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. ::: Get a paginated list of common access This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read

API Spec

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.
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	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: status: eq, sw reviewedByUser eq access.id: eq, sw access.type: eq access.name: sw, eq access.description: sw, eq
Query	sorters	str	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: access.name, status By default the common access items are sorted by name, ascending.

Return type

List[CommonAccessResponse]

Responses

Code	Description	Data Type	Response headers
200	Succeeded. Returns a list of common access for a customer.	List[CommonAccessResponse]	-
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	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.common_access_response import CommonAccessResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    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')
    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)
    filters = 'access.type eq \"ROLE\"' # 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:  **status**: *eq, sw*  **reviewedByUser** *eq*  **access.id**: *eq, sw*  **access.type**: *eq*  **access.name**: *sw, eq*  **access.description**: *sw, eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **status**: *eq, sw*  **reviewedByUser** *eq*  **access.id**: *eq, sw*  **access.type**: *eq*  **access.name**: *sw, eq*  **access.description**: *sw, eq* (optional)
    sorters = 'access.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: **access.name, status**  By default the common access items are sorted by name, ascending. (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: **access.name, status**  By default the common access items are sorted by name, ascending. (optional)

    try:
        # Get a paginated list of common access
        
        api_response = api_instance.get_common_access(x_sail_point_experimental, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters)
        print("The response of IAICommonAccessApi->get_common_access:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e)

[Back to top]

update-common-access-status-in-bulk

:::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. ::: Bulk update common access status This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update

API Spec

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.
Body	common_access_id_status	[]CommonAccessIDStatus	True	Confirm or deny in bulk the common access ids that are (or aren't) common access

Return type

object

Responses

Code	Description	Data Type	Response headers
202	Accepted - Returned if the request was successfully accepted into the system.	object	-
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

import sailpoint.v2024
from sailpoint.v2024.models.common_access_id_status import CommonAccessIDStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    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')
    [sailpoint.v2024.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access
     common_access_id_status = {
          "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
          "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
        } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access
    

    try:
        # Bulk update common access status
        Result = common_access_id_status.from_json(common_access_id_status)
        api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result)
        print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e)

[Back to top]

16 KiB Raw Blame History

sailpoint.v2024.IAICommonAccessApi

create-common-access

Parameters

Return type

Responses

HTTP request headers

Example

get-common-access

Parameters

Return type

Responses

HTTP request headers

Example

update-common-access-status-in-bulk

Parameters

Return type

Responses

HTTP request headers

Example

16 KiB

Raw Blame History