Skip to main content

Get Entitlement Request Config

GET 

/entitlements/:id/entitlement-request-config

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 the entitlement request config for a specified entitlement.

Request

Path Parameters

    id stringrequired

    Entitlement Id

    Example: 2c91808874ff91550175097daaec161c

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

An Entitlement Request Config

Schema

    accessRequestConfig

    object

    approvalSchemes

    object[]

    Ordered list of approval steps for the access request. Empty when no approval is required.

  • Array [

  • approverType string

    Possible values: [ENTITLEMENT_OWNER, SOURCE_OWNER, MANAGER, GOVERNANCE_GROUP]

    Describes the individual or group that is responsible for an approval step. Values are as follows.

    ENTITLEMENT_OWNER: Owner of the associated Entitlement

    SOURCE_OWNER: Owner of the associated Source

    MANAGER: Manager of the Identity for whom the request is being made

    GOVERNANCE_GROUP: A Governance Group, the ID of which is specified by the approverId field

    approverId stringnullable

    Id of the specific approver, used only when approverType is GOVERNANCE_GROUP

  • ]

  • requestCommentRequired boolean

    If the requester must provide a comment during access request.

    denialCommentRequired boolean

    If the reviewer must provide a comment when denying the access request.

Loading...