Skip to main content

List connections for Governance Group

GET 

/workgroups/:workgroupId/connections

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 returns list of connections associated with a Governance Group.

Request

Path Parameters

    workgroupId stringrequired

    ID of the Governance Group.

Query Parameters

    offset int32

    Default value: 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.

    Example: 0
    limit int32

    Possible values: <= 50

    Default value: 50

    Note that for this API the maximum value for limit is 50. See V3 API Standard Collection Parameters for more information.

    Example: 50
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: name, created, modified

    Example: name,-modified

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

List all connections associated with a Governance Group.

Schema

  • Array [

  • object

    object

    Connected object to Governance Group

    type ConnectedObjectType (string)

    Possible values: [ACCESS_PROFILE, ROLE, SOD_POLICY, SOURCE]

    Connection Object type

    id string

    ID of the object to which this reference applies

    name string

    Human-readable name of Connected object

    description string

    Description of the Connected object.

    connectionType string

    Possible values: [AccessRequestReviewer, Owner, ManagementWorkgroup]

    Connection Type.

  • ]

Loading...