Skip to main content

sailpoint.beta.IAICommonAccessApi

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

MethodHTTP requestDescription
create-common-accessPOST /common-accessCreate common access items
get-common-accessGET /common-accessGet a paginated list of common access
update-common-access-status-in-bulkPOST /common-access/update-statusBulk update common access status

create-common-access

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 TypeNameData TypeRequiredDescription
Bodycommon_access_item_requestCommonAccessItemRequestTrue

Return type

CommonAccessItemResponse

Responses

CodeDescriptionData TypeResponse headers
202Returns details of the common access classification request.CommonAccessItemResponse-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
429Too 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.ListAccessModelMetadataAttribute429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.common_access_item_request import CommonAccessItemRequest
from sailpoint.beta.models.common_access_item_response import CommonAccessItemResponse
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
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
new_common_access_item_request = CommonAccessItemRequest.from_json(common_access_item_request)
results = IAICommonAccessApi(api_client).create_common_access(common_access_item_request=new_common_access_item_request)
# Below is a request that includes all optional parameters
# results = IAICommonAccessApi(api_client).create_common_access(new_common_access_item_request)
print("The response of IAICommonAccessApi->create_common_access:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e)

[Back to top]

get-common-access

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 TypeNameData TypeRequiredDescription
Queryoffsetint(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.
Querylimitint(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.
Querycountbool(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.
Queryfiltersstr(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
Querysortersstr(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

CodeDescriptionData TypeResponse headers
200Succeeded. Returns a list of common access for a customer.List[CommonAccessResponse]-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.common_access_response import CommonAccessResponse
from sailpoint.configuration import Configuration
configuration = Configuration()


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)
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

results = IAICommonAccessApi(api_client).get_common_access()
# Below is a request that includes all optional parameters
# results = IAICommonAccessApi(api_client).get_common_access(offset, limit, count, filters, sorters)
print("The response of IAICommonAccessApi->get_common_access:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e)

[Back to top]

update-common-access-status-in-bulk

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 TypeNameData TypeRequiredDescription
Bodycommon_access_id_status[]CommonAccessIDStatusTrueConfirm or deny in bulk the common access ids that are (or aren't) common access

Return type

object

Responses

CodeDescriptionData TypeResponse headers
202Accepted - Returned if the request was successfully accepted into the system.object-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
429Too 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.ListAccessModelMetadataAttribute429Response-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.common_access_id_status import CommonAccessIDStatus
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
common_access_id_status = '''[sailpoint.beta.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access

try:
# Bulk update common access status
new_common_access_id_status = CommonAccessIdStatus.from_json(common_access_id_status)
results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(common_access_id_status=new_common_access_id_status)
# Below is a request that includes all optional parameters
# results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(new_common_access_id_status)
print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e)

[Back to top]