developer.sailpoint.com/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md

id, title, pagination_label, sidebar_label, keywords, description, slug, tags

id	title	pagination_label	sidebar_label	keywords	description	slug	tags
entitlement-read	Entitlement Read	Entitlement Read	Entitlement Read	connectivity connectors entitlement read	Fetch a single entitlement’s attributes from the source.	/connectivity/saas-connectivity/commands/entitlement-read	Connectivity Connector Command

:::note

At this time Entitlement Read is not triggered from ISC for any specific workflow and as such it is not necessary to implement this in order to have a fully functional connector.

:::

To use this command, you must specify this value in the commands array: std:entitlement:list

Input/Output	Data Type
Input	StdEntitlementReadInput
Output	StdEntitlementReadOutput

Example StdEntitlementReadInput

{
    "identity": "john.doe",
    "key": {
        "simple": {
            "id": "john.doe"
        }
    },
    "type": "group",
    "schema": {
        "type": "string",
        "includePermissions": true
    }
}

Example StdEntitlementReadOutput

{
    "identity": "john.doe",
    "key": {
        "simple": {
            "id": "administrator"
        }
    },
    "type": "group",
    "deleted": false,
    "attributes": {
        "id": "administrator",
        "name": "Administrator"
    },
    "permissions": [
        "target": "SYSADMIN",
        "rights": "useAccounts,retrieveAccounts"
    ]
}

Response Schema

Entitlement read fetches a single entitlement’s attributes and returns the resulting object to ISC, similar to how entitlement list does. You can implement this in the main connector file, index.ts:

...
.stdEntitlementRead(async (context: Context, input: StdEntitlementReadInput, res: Response<StdEntitlementReadOutput>) => {
    const group = await airtable.getEntitlement(input.key)

    res.send(group.toStdEntitlementReadOutput())
})
...
...
...
public toStdEntitlementReadOutput(): StdEntitlementReadOutput {
    return this.buildStandardObject();
}

private buildStandardObject(): StdEntitlementReadOutput | StdEntitlementListOutput {
    return {
        key: SimpleKey(this.id),
        type: 'group',
        attributes: {
            id: this.id,
            name: this.name
        }
    }
}