Skip to main content

Patch user app by ID

PATCH 

/user-apps/:id

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

This API updates an existing user app using JSON Patch syntax. The following fields are patchable: account

Request

Path Parameters

    id stringrequired

    ID of the user app to patch

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Body

array

  • Array [

  • op stringrequired

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

    The operation to be performed

    path stringrequired

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

    value

    object

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

    oneOf

    string

  • ]

Responses

Responds with the user app as updated.

Schema

    id string

    The user app id

    created date-time

    Time when the user app was created

    modified date-time

    Time when the user app was last modified

    hasMultipleAccounts boolean

    True if the owner has multiple accounts for the source

    useForPasswordManagement boolean

    True if the source has password feature

    provisionRequestEnabled boolean

    True if the source app related to the user app is provision request enabled

    appCenterEnabled boolean

    Default value: true

    True if the source app related to the user app is shown in the app center

    sourceApp

    object

    id string

    the source app ID

    type string

    It will always be "APPLICATION"

    name string

    the source app name

    source

    object

    id string

    the source ID

    type string

    It will always be "SOURCE"

    name string

    the source name

    account

    object

    id string

    the account ID

    type string

    It will always be "ACCOUNT"

    name string

    the account name

    owner

    object

    id string

    The identity ID

    type string

    It will always be "IDENTITY"

    name string

    The identity name

    alias string

    The identity alias

Loading...