Skip to main content

MachineAccountMappings

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

MethodHTTP requestDescription
New-V2024MachineAccountMappingsPOST /sources/{sourceId}/machine-account-mappingsCreate Machine Account Mappings
Remove-V2024MachineAccountMappingsDELETE /sources/{sourceId}/machine-account-mappingsDelete Source's Machine Account Mappings
Get-V2024MachineAccountMappingsGET /sources/{sourceId}/machine-account-mappingsMachine Account Mapping for Source
Set-V2024MachineAccountMappingsPUT /sources/{sourceId}/machine-mappingsUpdate Source's Machine Account Mappings

create-machine-account-mappings

Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdStringTrueSource ID.
BodyAttributeMappingsAttributeMappingsTrue

Return type

AttributeMappings[]

Responses

CodeDescriptionData Type
200Newly created Attribute Mapping ObjectAttributeMappings[]
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

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
$AttributeMappings = @"{
"transformDefinition" : {
"attributes" : {
"input" : {
"attributes" : {
"name" : "8d3e0094e99445de98eef6c75e25jc04",
"attributeName" : "givenName",
"sourceName" : "delimited-src"
},
"type" : "accountAttribute"
}
},
"id" : "ToUpper",
"type" : "reference"
},
"target" : {
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
"attributeName" : "businessApplication",
"type" : "IDENTITY"
}
}"@

# Create Machine Account Mappings

try {
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings
New-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result

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

[Back to top]

delete-machine-account-mappings

Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdStringTruesource ID.

Return type

(empty response body)

Responses

CodeDescriptionData Type
200No 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 = "ef38f94347e94562b5bb8424a56397d8" # String | source ID.

# Delete Source's Machine Account Mappings

try {
Remove-V2024MachineAccountMappings -Id $Id

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

[Back to top]

list-machine-account-mappings

Retrieves Machine account mappings for a specified source using Source ID.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdStringTrueSource ID
QueryLimitInt32(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.
QueryOffsetInt32(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.

Return type

AttributeMappings[]

Responses

CodeDescriptionData Type
200An array of Attribute Mapping ObjectsAttributeMappings[]
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 = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID
$Limit = 250 # Int32 | 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 # Int32 | 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)

# Machine Account Mapping for Source

try {
Get-V2024MachineAccountMappings -Id $Id

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

[Back to top]

set-machine-account-mappings

Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdStringTrueSource ID.
BodyAttributeMappingsAttributeMappingsTrue

Return type

AttributeMappings[]

Responses

CodeDescriptionData Type
200Updated Machine Account Attributes for a Source.AttributeMappings[]
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

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
$AttributeMappings = @"{
"transformDefinition" : {
"attributes" : {
"input" : {
"attributes" : {
"name" : "8d3e0094e99445de98eef6c75e25jc04",
"attributeName" : "givenName",
"sourceName" : "delimited-src"
},
"type" : "accountAttribute"
}
},
"id" : "ToUpper",
"type" : "reference"
},
"target" : {
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
"attributeName" : "businessApplication",
"type" : "IDENTITY"
}
}"@

# Update Source's Machine Account Mappings

try {
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings
Set-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result

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

[Back to top]