Skip to main content

Update Identity Profile

PATCH 

https://sailpoint.api.identitynow.com/v2025/identity-profiles/:identity-profile-id

Update a specified identity profile with this PATCH request.

You cannot update these fields:

  • id
  • created
  • modified
  • identityCount
  • identityRefreshRequired
  • Authoritative Source and Identity Attribute Configuration cannot be modified at the same time.

Request

Path Parameters

    identity-profile-id uuidrequired

    Identity profile ID.

    Example: ef38f94347e94562b5bb8424a56397d8

Body arrayrequired

List of identity profile update operations according to the JSON Patch standard.

  • Array [
  • opstringrequired

    The operation to be performed

    Possible values: [add, remove, replace, move, copy, test]

    Example: replace
    pathstringrequired

    A string JSON Pointer representing the target path to an element to be affected by the operation

    Example: /description
    value object

    The value to be used for the operation, required for "add" and "replace" operations

    oneOf
    string
    Example: New description
  • ]

Responses

Updated identity profile.

Schema
    idstring

    System-generated unique ID of the Object

    Example: id12345
    namestringnullablerequired

    Name of the Object

    Example: aName
    createddate-time

    Creation date of the Object

    Example: 2015-05-28T14:07:17Z
    modifieddate-time

    Last modification date of the Object

    Example: 2015-05-28T14:07:17Z
    descriptionstringnullable

    Identity profile's description.

    Example: My custom flat file profile
    owner objectnullable

    Identity profile's owner.

    typestring

    Owner's object type.

    Possible values: [IDENTITY]

    Example: IDENTITY
    idstring

    Owner's ID.

    Example: 2c9180835d191a86015d28455b4b232a
    namestring

    Owner's name.

    Example: William Wilson
    priorityint64

    Identity profile's priority.

    Example: 10
    authoritativeSource objectrequired
    typestring

    Authoritative source's object type.

    Possible values: [SOURCE]

    Example: SOURCE
    idstring

    Authoritative source's ID.

    Example: 2c9180835d191a86015d28455b4b232a
    namestring

    Authoritative source's name.

    Example: HR Active Directory
    identityRefreshRequiredboolean

    Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source.

    Default value: false
    Example: true
    identityCountint32

    Number of identities belonging to the identity profile.

    Example: 8
    identityAttributeConfig object

    Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.

    enabledboolean

    Backend will only promote values if the profile/mapping is enabled.

    Default value: false
    Example: true
    attributeTransforms object[]
  • Array [
  • identityAttributeNamestring

    Identity attribute's name.

    Example: email
    transformDefinition object
    typestring

    Transform definition type.

    Example: accountAttribute
    attributes object

    Arbitrary key-value pairs to store any metadata for the object

    property name*any

    Arbitrary key-value pairs to store any metadata for the object

    Example: {"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}
  • ]
  • identityExceptionReportReference objectnullable
    taskResultIduuid

    Task result ID.

    Example: 2b838de9-db9b-abcf-e646-d4f274ad4238
    reportNamestring

    Report name.

    Example: My annual report
    hasTimeBasedAttrboolean

    Indicates the value of requiresPeriodicRefresh attribute for the identity profile.

    Default value: false
    Example: true

Authorization: oauth2

type: Personal Access Token
scopes: idn:identity-profile:manage
user levels: ORG_ADMIN
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sailpoint.api.identitynow.com/v2025/identity-profiles/:identity-profile-id"
method := "PATCH"

payload := strings.NewReader(`[
{
"op": "replace",
"path": "/description",
"value": "New description"
}
]`)

client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)

if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json-patch+json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Bearer <TOKEN>")

res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()

body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/v2025
Auth
Parameters
— pathrequired
Body required
[
  {
    "op": "replace",
    "path": "/description",
    "value": "New description"
  }
]
ResponseClear

Click the Send API Request button above and see the response here!