sailpoint.beta.IdentityProfilesApi
Use this API to implement and customize identity profile functionality.
With this functionality in place, administrators can manage identity profiles and configure them for use by identities throughout Identity Security Cloud.
Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes.
This allows administrators to save time by applying identity profiles to any number of similar identities rather than configuring each one individually.
In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles.
This list shows some details about each identity profile, along with its status. They can select an identity profile to view and modify its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings.
Administrators can also use this page to create new identity profiles or delete existing ones.
Refer to Creating Identity Profiles for more information about identity profiles.
All URIs are relative to https://sailpoint.api.identitynow.com/beta
create-identity-profile
Create Identity Profile
Create an identity profile.
A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Body | identity_profile | IdentityProfile | True | |
Return type
IdentityProfile
Responses
| Code | Description | Data Type | Response headers |
|---|
| 201 | Created identity profile | IdentityProfile | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile import IdentityProfile
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile = '''{
"owner" : {
"name" : "William Wilson",
"id" : "2c9180835d191a86015d28455b4b232a",
"type" : "IDENTITY"
},
"identityExceptionReportReference" : {
"reportName" : "My annual report",
"taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"authoritativeSource" : {
"name" : "HR Active Directory",
"id" : "2c9180835d191a86015d28455b4b232a",
"type" : "SOURCE"
},
"hasTimeBasedAttr" : true,
"created" : "2023-01-03T21:16:22.432Z",
"description" : "My custom flat file profile",
"identityRefreshRequired" : true,
"identityCount" : 8,
"priority" : 10,
"identityAttributeConfig" : {
"attributeTransforms" : [ {
"transformDefinition" : {
"attributes" : {
"attributeName" : "e-mail",
"sourceName" : "MySource",
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
},
"type" : "accountAttribute"
},
"identityAttributeName" : "email"
}, {
"transformDefinition" : {
"attributes" : {
"attributeName" : "e-mail",
"sourceName" : "MySource",
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
},
"type" : "accountAttribute"
},
"identityAttributeName" : "email"
} ],
"enabled" : true
},
"name" : "aName",
"modified" : "2023-01-03T21:16:22.432Z",
"id" : "id12345"
}'''
try:
new_identity_profile = IdentityProfile.from_json(identity_profile)
results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile)
print("The response of IdentityProfilesApi->create_identity_profile:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e)
[Back to top]
delete-identity-profile
Delete Identity Profile
Delete an identity profile by ID.
On success, this endpoint will return a reference to the bulk delete task result.
A token with ORG_ADMIN authority is required to call this API.
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Path | identity_profile_id | str | True | Identity profile ID. |
Return type
TaskResultSimplified
Responses
| Code | Description | Data Type | Response headers |
|---|
| 202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_result_simplified import TaskResultSimplified
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8'
try:
results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id)
print("The response of IdentityProfilesApi->delete_identity_profile:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e)
[Back to top]
delete-identity-profiles
Delete Identity Profiles
This deletes multiple Identity Profiles via a list of supplied IDs.
On success, this endpoint will return a reference to the bulk delete task result.
A token with ORG_ADMIN authority is required to call this API.
The following rights are required to access this endpoint: idn:identity-profile:delete
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Body | request_body | []str | True | Identity Profile bulk delete request body. |
Return type
TaskResultSimplified
Responses
| Code | Description | Data Type | Response headers |
|---|
| 202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_result_simplified import TaskResultSimplified
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']'''
try:
new_request_body = RequestBody.from_json(request_body)
results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body)
print("The response of IdentityProfilesApi->delete_identity_profiles:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e)
[Back to top]
export-identity-profiles
Export Identity Profiles
This exports existing identity profiles in the format specified by the sp-config service.
API Spec
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 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 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: id: eq, ne name: eq, ne priority: eq, ne |
| Query | sorters | str | (optional) | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, priority |
Return type
List[IdentityProfileExportedObject]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of export objects with identity profiles. | List[IdentityProfileExportedObject] | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250
offset = 0
count = False
filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb'
sorters = 'name,-priority'
try:
results = IdentityProfilesApi(api_client).export_identity_profiles()
print("The response of IdentityProfilesApi->export_identity_profiles:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e)
[Back to top]
get-default-identity-attribute-config
Default identity attribute config
This returns the default identity attribute config
A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config.
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Path | identity_profile_id | str | True | The Identity Profile ID |
Return type
IdentityAttributeConfig
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | An Identity Attribute Config object | IdentityAttributeConfig | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_attribute_config import IdentityAttributeConfig
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8'
try:
results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id)
print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e)
[Back to top]
get-identity-profile
Get Identity Profile
Get a single identity profile by ID.
A token with ORG_ADMIN or API authority is required to call this API.
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Path | identity_profile_id | str | True | Identity profile ID. |
Return type
IdentityProfile
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | Identity profile object. | IdentityProfile | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile import IdentityProfile
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8'
try:
results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id)
print("The response of IdentityProfilesApi->get_identity_profile:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e)
[Back to top]
import-identity-profiles
Import Identity Profiles
This imports previously exported identity profiles.
API Spec
Parameters
Return type
ObjectImportResult
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | The result of importing Identity Profiles. | ObjectImportResult | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject
from sailpoint.beta.models.object_import_result import ObjectImportResult
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_exported_object = '''[sailpoint.beta.IdentityProfileExportedObject()]'''
try:
new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object)
results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object)
print("The response of IdentityProfilesApi->import_identity_profiles:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e)
[Back to top]
list-identity-profiles
List Identity Profiles
Get a list of identity profiles, based on the specified query parameters.
A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.
API Spec
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 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 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: id: eq, ne, ge, gt, in, le, sw name: eq, ne, ge, gt, in, le, sw priority: eq, ne |
| Query | sorters | str | (optional) | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, priority, created, modified, owner.id, owner.name |
Return type
List[IdentityProfile]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of identity profiles. | List[IdentityProfile] | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile import IdentityProfile
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250
offset = 0
count = False
filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb'
sorters = 'name,-priority'
try:
results = IdentityProfilesApi(api_client).list_identity_profiles()
print("The response of IdentityProfilesApi->list_identity_profiles:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e)
[Back to top]
show-generate-identity-preview
Generate Identity Profile Preview
Use this API to generate a non-persisted preview of the identity object after applying IdentityAttributeConfig sent in request body.
This API only allows accountAttribute, reference and rule transform types in the IdentityAttributeConfig sent in the request body.
A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Body | identity_preview_request | IdentityPreviewRequest | True | Identity Preview request body. |
Return type
IdentityPreviewResponse
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_preview_request import IdentityPreviewRequest
from sailpoint.beta.models.identity_preview_response import IdentityPreviewResponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_preview_request = '''{
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityAttributeConfig" : {
"attributeTransforms" : [ {
"transformDefinition" : {
"attributes" : {
"attributeName" : "e-mail",
"sourceName" : "MySource",
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
},
"type" : "accountAttribute"
},
"identityAttributeName" : "email"
}, {
"transformDefinition" : {
"attributes" : {
"attributeName" : "e-mail",
"sourceName" : "MySource",
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
},
"type" : "accountAttribute"
},
"identityAttributeName" : "email"
} ],
"enabled" : true
}
}'''
try:
new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request)
results = IdentityProfilesApi(api_client).show_generate_identity_preview(identity_preview_request=new_identity_preview_request)
print("The response of IdentityProfilesApi->show_generate_identity_preview:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e)
[Back to top]
sync-identity-profile
Process identities under profile
Process identities under the profile
This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of event-based processing and scheduled processing that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized.
This should only be run on identity profiles that have the identityRefreshRequired attribute set to true. If identityRefreshRequired is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh.
This operation will perform the following activities on all identities under the identity profile.
- Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria.
A token with ORG_ADMIN authority is required to call this API.
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Path | identity_profile_id | str | True | The Identity Profile ID to be processed |
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. | ListAccessModelMetadataAttribute401Response | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8'
try:
results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id=identity_profile_id)
print("The response of IdentityProfilesApi->sync_identity_profile:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e)
[Back to top]
update-identity-profile
Update Identity Profile
Update the specified identity profile with this PATCH request.
A token with ORG_ADMIN authority is required to call this API to update the Identity Profile.
These fields cannot be updated:
- id
- created
- modified
- identityCount
- identityRefreshRequired
- Authoritative Source and Identity Attribute Configuration cannot be modified at once.
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Path | identity_profile_id | str | True | Identity profile ID. |
| Body | json_patch_operation | []JsonPatchOperation | True | List of identity profile update operations according to the JSON Patch standard. |
Return type
IdentityProfile
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | Updated identity profile. | IdentityProfile | - |
| 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 | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
- Content-Type: application/json-patch+json
- Accept: application/json
Example
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile import IdentityProfile
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8'
json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]'''
try:
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation)
print("The response of IdentityProfilesApi->update_identity_profile:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e)
[Back to top]