mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
merge changes from main and pull the latest from python docs
This commit is contained in:
@@ -297,9 +297,7 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
## create-non-employee-source
|
||||
Create Non-Employee Source
|
||||
This request will create a non-employee source.
|
||||
Request will require the following security scope:
|
||||
'idn:nesr:create'
|
||||
Create a non-employee source.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source)
|
||||
|
||||
@@ -1722,7 +1720,9 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
## list-non-employee-sources
|
||||
List Non-Employee Sources
|
||||
This gets a list of non-employee sources.
|
||||
Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter:
|
||||
1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`.
|
||||
2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-sources)
|
||||
|
||||
@@ -1730,11 +1730,11 @@ This gets a list of non-employee sources.
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Query | requested_for | **str** | True | The identity for whom the request was made. *me* indicates the current user.
|
||||
Query | non_employee_count | **bool** | True | The flag to determine whether return a non-employee count associate with source.
|
||||
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 | requested_for | **str** | (optional) | Identity the request was made for. Use 'me' to indicate the current user.
|
||||
Query | non_employee_count | **bool** | (optional) (default to False) | Flag that determines whether the API will return a non-employee count associated with the source.
|
||||
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: **name, created, sourceId**
|
||||
|
||||
### Return type
|
||||
@@ -1743,7 +1743,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of non-employee sources objects. | List[NonEmployeeSourceWithNECount] | - |
|
||||
200 | List of non-employee source objects. | List[NonEmployeeSourceWithNECount] | - |
|
||||
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. | ListAccessModelMetadataAttribute401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
@@ -1766,19 +1766,19 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
requested_for = 'me' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user.
|
||||
non_employee_count = false # bool | The flag to determine whether return a non-employee count associate with source. # bool | The flag to determine whether return a non-employee count associate with source.
|
||||
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)
|
||||
requested_for = 'me' # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) # str | Identity the request was made for. Use 'me' to indicate the current user. (optional)
|
||||
non_employee_count = False # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False)
|
||||
sorters = 'name,created' # 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, created, sourceId** (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, created, sourceId** (optional)
|
||||
|
||||
try:
|
||||
# List Non-Employee Sources
|
||||
|
||||
results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, non_employee_count, )
|
||||
results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, non_employee_count, limit, offset, count, sorters)
|
||||
# results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters)
|
||||
print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
|
||||
Reference in New Issue
Block a user