Skip to main content

Update Segment

PATCH 

https://sailpoint.api.identitynow.com/v2024/segments/:id

Use this API to update segment fields by using the JSON Patch standard.

Note: Changes to a segment may take some time to propagate to all identities.

Request

Path Parameters

    id stringrequired

    The segment ID to modify.

    Example: ef38f94347e94562b5bb8424a56397d8

Body arrayrequired

A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
  • Array [
  • object
  • ]

Responses

Indicates the PATCH operation succeeded, and returns the segment's new representation.
Schema
    idstring

    The segment's ID.

    Example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
    namestring

    The segment's business name.

    Example: segment-xyz
    createddate-time

    The time when the segment is created.

    Example: 2020-01-01T00:00:00.000000Z
    modifieddate-time

    The time when the segment is modified.

    Example: 2020-01-01T00:00:00.000000Z
    descriptionstring

    The segment's optional description.

    Example: This segment represents xyz
    owner objectnullable

    The owner of this object.

    typestring

    Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.

    Possible values: [IDENTITY]

    Example: IDENTITY
    idstring

    Identity id

    Example: 2c9180a46faadee4016fb4e018c20639
    namestring

    Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.

    Example: support
    visibilityCriteria objectnullable
    expression object
    operatorstring

    Operator for the expression

    Possible values: [AND, EQUALS]

    Example: EQUALS
    attributestringnullable

    Name for the attribute

    Example: location
    value objectnullable
    typestring

    The type of attribute value

    Example: STRING
    valuestring

    The attribute value

    Example: Austin
    children object[]nullable

    List of expressions

  • Array [
  • operatorstring

    Operator for the expression

    Possible values: [AND, EQUALS]

    Example: EQUALS
    attributestringnullable

    Name for the attribute

    Example: location
    value objectnullable
    typestring

    The type of attribute value

    Example: STRING
    valuestring

    The attribute value

    Example: Austin
    childrenstringnullable

    There cannot be anymore nested children. This will always be null.

    Example: null
  • ]
  • activeboolean

    This boolean indicates whether the segment is currently active. Inactive segments have no effect.

    Default value: false
    Example: true

Authorization: oauth2

type: Personal Access Token
scopes: idn:segment:manage
user levels: ORG_ADMIN

type: Client Credentials
scopes: idn:segment:manage
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "https://sailpoint.api.identitynow.com/v2024/segments/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("[\n {}\n]", null, "application/json-patch+json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/v2024
Auth
Parameters
— pathrequired
Body required
[
  {}
]
ResponseClear

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