Skip to main content

Delete Governance Group(s)

POST 

/workgroups/bulk-delete

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 initiates a bulk deletion of one or more Governance Groups.

If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in inUse list of the response. Governance Group(s) marked as inUse can not be deleted.

If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in notFound list of the response. Governance Groups marked as notFound will not be deleted.

If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in deleted list of the response. A Governance Group marked as deleted will be deleted from current Organization.

If the request contains any inUse or notFound Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it.

This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.

Request

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Body

required

    ids string[]

    List of IDs of Governance Groups to be deleted.

Responses

Governance Group bulk delete response.

Schema

  • Array [

  • id stringrequired

    Id of the Governance Group.

    status stringrequired

    The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation.

    204 - Governance Group deleted successfully.

    409 - Governance Group is in use,hence can not be deleted.

    404 - Governance Group not found.

    description string

    Human readable status description and containing additional context information about success or failures etc.

  • ]

Loading...