Skip to main content

ConfigurationHub

Use this API to implement and customize configuration settings management. With this functionality, you can access the Configuration Hub actions and build your own automated pipeline for Identity Security Cloud configuration change delivery and deployment.

Common usages for Configuration Hub includes:

  • Upload configuration file - Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data.
  • Manage object mapping - Create rules to map and substitute attributes when migrating configurations.
  • Manage backups for configuration settings
  • Manage configuration drafts
  • Upload configurations and manage object mappings between tenants.

Refer to Using the SailPoint Configuration Hub for more information about Configuration Hub.

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

MethodHTTP requestDescription
New-V2024DeployPOST /configuration-hub/deploysCreate a Deploy
New-V2024ObjectMappingPOST /configuration-hub/object-mappings/{sourceOrg}Creates an object mapping
New-V2024ObjectMappingsPOST /configuration-hub/object-mappings/{sourceOrg}/bulk-createBulk creates object mappings
New-V2024UploadedConfigurationPOST /configuration-hub/backups/uploadsUpload a Configuration
Remove-V2024BackupDELETE /configuration-hub/backups/{id}Delete a Backup
Remove-V2024DraftDELETE /configuration-hub/drafts/{id}Delete a draft
Remove-V2024ObjectMappingDELETE /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}Deletes an object mapping
Remove-V2024UploadedConfigurationDELETE /configuration-hub/backups/uploads/{id}Delete an Uploaded Configuration
Get-V2024DeployGET /configuration-hub/deploys/{id}Get a Deploy
Get-V2024ObjectMappingsGET /configuration-hub/object-mappings/{sourceOrg}Gets list of object mappings
Get-V2024UploadedConfigurationGET /configuration-hub/backups/uploads/{id}Get an Uploaded Configuration
Get-V2024BackupsGET /configuration-hub/backupsList Backups
Get-V2024DeploysGET /configuration-hub/deploysList Deploys
Get-V2024DraftsGET /configuration-hub/draftsList Drafts
Get-V2024UploadedConfigurationsGET /configuration-hub/backups/uploadsList Uploaded Configurations
Update-V2024ObjectMappingsPOST /configuration-hub/object-mappings/{sourceOrg}/bulk-patchBulk updates object mappings

create-deploy​

This API performs a deploy based on an existing daft.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
BodyDeployRequestDeployRequestTrueThe deploy request body.

Return type​

DeployResponse

Responses​

CodeDescriptionData Type
202Deploy job accepted and queued for processing.DeployResponse
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.ListAccessProfiles401Response
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$DeployRequest = @"{
  "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b"
}"@

# Create a Deploy

try {
    $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest
    New-V2024Deploy -V2024DeployRequest $Result 
    
    # Below is a request that includes all optional parameters
    # New-V2024Deploy -V2024DeployRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-object-mapping​

This creates an object mapping between current org and source org. Source org should be "default" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope:

  • sp:config-object-mapping:manage

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathSourceOrgStringTrueThe name of the source org.
BodyObjectMappingRequestObjectMappingRequestTrueThe object mapping request body.

Return type​

ObjectMappingResponse

Responses​

CodeDescriptionData Type
200The created object mapping between current org and source org.ObjectMappingResponse
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$SourceOrg = "source-org" # String | The name of the source org.
$ObjectMappingRequest = @"{
  "targetValue" : "My New Governance Group Name",
  "jsonPath" : "$.name",
  "sourceValue" : "My Governance Group Name",
  "enabled" : false,
  "objectType" : "IDENTITY"
}"@

# Creates an object mapping

try {
    $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest
    New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result 
    
    # Below is a request that includes all optional parameters
    # New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-object-mappings​

This creates a set of object mappings (Max 25) between current org and source org. Source org should be "default" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope:

  • sp:config-object-mapping:manage

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathSourceOrgStringTrueThe name of the source org.
BodyObjectMappingBulkCreateRequestObjectMappingBulkCreateRequestTrueThe bulk create object mapping request body.

Return type​

ObjectMappingBulkCreateResponse

Responses​

CodeDescriptionData Type
200The created object mapping between current org and source org.ObjectMappingBulkCreateResponse
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$SourceOrg = "source-org" # String | The name of the source org.
$ObjectMappingBulkCreateRequest = @"{
  "newObjectsMappings" : [ {
    "targetValue" : "My New Governance Group Name",
    "jsonPath" : "$.name",
    "sourceValue" : "My Governance Group Name",
    "enabled" : false,
    "objectType" : "IDENTITY"
  }, {
    "targetValue" : "My New Governance Group Name",
    "jsonPath" : "$.name",
    "sourceValue" : "My Governance Group Name",
    "enabled" : false,
    "objectType" : "IDENTITY"
  } ]
}"@

# Bulk creates object mappings

try {
    $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest
    New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result 
    
    # Below is a request that includes all optional parameters
    # New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-uploaded-configuration​

This API uploads a JSON configuration file into a tenant.

Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality.

Refer to SaaS Configuration for more information about supported objects.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
DataSystem.IO.FileInfoTrueJSON file containing the objects to be imported.
NameStringTrueName that will be assigned to the uploaded configuration file.

Return type​

BackupResponse

Responses​

CodeDescriptionData Type
202Upload job accepted and queued for processing.BackupResponse
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.ListAccessProfiles401Response
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

  • Content-Type: multipart/form-data
  • Accept: application/json

Example​

$Data =  # System.IO.FileInfo | JSON file containing the objects to be imported.
$Name = "MyName" # String | Name that will be assigned to the uploaded configuration file.

# Upload a Configuration

try {
    New-V2024UploadedConfiguration -Data $Data -Name $Name 
    
    # Below is a request that includes all optional parameters
    # New-V2024UploadedConfiguration -Data $Data -Name $Name  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-backup​

This API deletes an existing backup for the current tenant.

On success, this endpoint will return an empty response.

The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdStringTrueThe id of the backup to delete.

Return type​

(empty response body)

Responses​

CodeDescriptionData Type
204No content - indicates the request was successful but there is no content to be returned in the response.
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete.

# Delete a Backup

try {
    Remove-V2024Backup -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024Backup -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-draft​

This API deletes an existing draft for the current tenant.

On success, this endpoint will return an empty response.

The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdStringTrueThe id of the draft to delete.

Return type​

(empty response body)

Responses​

CodeDescriptionData Type
204No content - indicates the request was successful but there is no content to be returned in the response.
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete.

# Delete a draft

try {
    Remove-V2024Draft -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024Draft -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-object-mapping​

This deletes an existing object mapping. Source org should be "default" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope:

  • sp:config-object-mapping:manage

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathSourceOrgStringTrueThe name of the source org.
PathObjectMappingIdStringTrueThe id of the object mapping to be deleted.

Return type​

(empty response body)

Responses​

CodeDescriptionData Type
204No content - indicates the request was successful but there is no content to be returned in the response.
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$SourceOrg = "source-org" # String | The name of the source org.
$ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted.

# Deletes an object mapping

try {
    Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-uploaded-configuration​

This API deletes an uploaded configuration based on Id.

On success, this endpoint will return an empty response.

The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdStringTrueThe id of the uploaded configuration.

Return type​

(empty response body)

Responses​

CodeDescriptionData Type
204No content - indicates the request was successful but there is no content to be returned in the response.
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.

# Delete an Uploaded Configuration

try {
    Remove-V2024UploadedConfiguration -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024UploadedConfiguration -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-deploy​

This API gets an existing deploy for the current tenant.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdStringTrueThe id of the deploy.

Return type​

DeployResponse

Responses​

CodeDescriptionData Type
200Gets the details of a deploy.DeployResponse
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy.

# Get a Deploy

try {
    Get-V2024Deploy -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024Deploy -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-object-mappings​

This gets a list of existing object mappings between current org and source org. Source org should be "default" when getting object mappings that are not associated to any particular org. The request will need the following security scope:

  • sp:config-object-mapping:read

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathSourceOrgStringTrueThe name of the source org.

Return type​

ObjectMappingResponse[]

Responses​

CodeDescriptionData Type
200List of existing object mappings between current org and source org.ObjectMappingResponse[]
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$SourceOrg = "source-org" # String | The name of the source org.

# Gets list of object mappings

try {
    Get-V2024ObjectMappings -SourceOrg $SourceOrg 
    
    # Below is a request that includes all optional parameters
    # Get-V2024ObjectMappings -SourceOrg $SourceOrg  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-uploaded-configuration​

This API gets an existing uploaded configuration for the current tenant.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdStringTrueThe id of the uploaded configuration.

Return type​

BackupResponse

Responses​

CodeDescriptionData Type
200Gets an uploaded configuration details.BackupResponse
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.

# Get an Uploaded Configuration

try {
    Get-V2024UploadedConfiguration -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024UploadedConfiguration -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-backups​

This API gets a list of existing backups for the current tenant.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
QueryFiltersString(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

Return type​

BackupResponse[]

Responses​

CodeDescriptionData Type
200List of existing backups.BackupResponse[]
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.ListAccessProfiles401Response
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Filters = 'status eq "COMPLETE"' # String | 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* (optional)

# List Backups

try {
    Get-V2024Backups 
    
    # Below is a request that includes all optional parameters
    # Get-V2024Backups -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-deploys​

This API gets a list of deploys for the current tenant.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription

Return type​

DeployResponse[]

Responses​

CodeDescriptionData Type
200List of existing deploys.DeployResponse[]
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.ListAccessProfiles401Response
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​


# List Deploys

try {
    Get-V2024Deploys 
    
    # Below is a request that includes all optional parameters
    # Get-V2024Deploys  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploys"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-drafts​

This API gets a list of existing drafts for the current tenant.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
QueryFiltersString(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 approvalStatus: eq

Return type​

DraftResponse[]

Responses​

CodeDescriptionData Type
200List of existing drafts.DraftResponse[]
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.ListAccessProfiles401Response
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Filters = 'status eq "COMPLETE"' # String | 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*  **approvalStatus**: *eq* (optional)

# List Drafts

try {
    Get-V2024Drafts 
    
    # Below is a request that includes all optional parameters
    # Get-V2024Drafts -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-uploaded-configurations​

This API gets a list of existing uploaded configurations for the current tenant.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
QueryFiltersString(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

Return type​

BackupResponse[]

Responses​

CodeDescriptionData Type
200List of existing uploaded configurations.BackupResponse[]
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Filters = 'status eq "COMPLETE"' # String | 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* (optional)

# List Uploaded Configurations

try {
    Get-V2024UploadedConfigurations 
    
    # Below is a request that includes all optional parameters
    # Get-V2024UploadedConfigurations -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-object-mappings​

This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be "default" when updating object mappings that are not associated to any particular org. The request will need the following security scope:

  • sp:config-object-mapping:manage

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathSourceOrgStringTrueThe name of the source org.
BodyObjectMappingBulkPatchRequestObjectMappingBulkPatchRequestTrueThe object mapping request body.

Return type​

ObjectMappingBulkPatchResponse

Responses​

CodeDescriptionData Type
200The updated object mappings.ObjectMappingBulkPatchResponse
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.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
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.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$SourceOrg = "source-org" # String | The name of the source org.
$ObjectMappingBulkPatchRequest = @"{
  "patches" : {
    "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ {
      "op" : "replace",
      "path" : "/enabled",
      "value" : true
    } ],
    "00bece34-f50d-4227-8878-76f620b5a971" : [ {
      "op" : "replace",
      "path" : "/targetValue",
      "value" : "New Target Value"
    } ]
  }
}"@

# Bulk updates object mappings

try {
    $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest
    Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result 
    
    # Below is a request that includes all optional parameters
    # Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings"
    Write-Host $_.ErrorDetails
}

[Back to top]