Account List

Input/Output	Data Type
Input	StdAccountListInput
Output	StdAccountListOutput

Example StdAccountListInput

"state": {"date": "1686341338871"},
"stateful": true

Example StdAccountListOutput

{
    "identity": "john.doe",
    "key": {
        "simple": {
            "id": "john.doe"
        }
    },
    "disabled": false,
    "locked": false,
    "attributes": {
        "id": "john.doe",
        "displayName": "John Doe",
        "email": "[email protected]",
        "entitlements": [
            "administrator",
            "sailpoint"
        ]
    }
}

Description

The account list command aggregates all accounts from the target source into Identity Security Cloud. ISC calls this command during a manual or scheduled account aggregation.

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

Implementation

For you to be able to implement this endpoint, the web service must expose an API for listing user accounts and entitlements (i.e. roles or groups). Sometimes, a target source’s API has a single endpoint providing all the attributes and entitlements a source account contains. However, some APIs may break these attributes and entitlements into separate API endpoints, requiring you to make multiple calls to gather all an account's necessary data. The following code from airtable.ts shows the necessary steps to create a complete account from the various endpoints the API offers:

async getAllAccounts(): Promise<AirtableAccount[]> {
    return this.airTableBase('Users').select({
        view: 'Grid view'
    }).firstPage().then(records => {
        const recordArray: Array<AirtableAccount> = []
        for (const record of records) {
            recordArray.push(AirtableAccount.createWithRecords(record))
        }
        return recordArray
    }).catch(err => {
        throw new ConnectorError('error while getting accounts: ' + err)
    })
}

Important

ISC will throw a connection timeout error if your connector doesn't respond within 3 minutes, and there are memory limitations involved with aggregating data. To prevent large memory utilization or timeout errors, you should set up your connectors to send data to ISC as it's retrieved from your source system. For more details and an example, refer to Connector Timeouts.

Important

ISC supports delta aggregation. If your source has a large number of accounts that will be syncronized with ISC, then it is highly recommended to utilize delta aggregation for the source.

The following code snippet from index.ts shows how to register the account list command on the connector object:

export const connector = async () => {

    // Get connector source config
    const config = await readConfig()

    // Use the vendor SDK or implement own client as necessary to initialize a client
    const airtable = new AirtableClient(config)

    return createConnector()
        .stdAccountList(async (context: Context, input: undefined, res: Response<StdAccountListOutput>) => {
            const accounts = await airtable.getAllAccounts()

            for (const account of accounts) {
                res.send(account.toStdAccountListOutput())
            }
        })
...

ISC expects each user in the target source to be converted into a format ISC understands. The specific attributes the web service returns depend on what your source provides.

public toStdAccountListOutput(): StdAccountListOutput {
    return this.buildStandardObject();
}

private buildStandardObject(): StdAccountListOutput | StdAccountCreateOutput | StdAccountReadOutput | StdAccountListOutput {
    return {
        key: SimpleKey(this.id),
        disabled: !this.enabled,
        locked: this.locked,
        attributes: {
            id: this.id,
            displayName: this.displayName,
            department: this.department,
            firstName: this.firstName,
            lastName: this.lastName,
            email: this.email,
            entitlements: this.entitlments,
        },
    }
}

The result of the account list command is not an array of objects but several individual objects. This is the format ISC expects, so if you see something like the following result while testing, it is normal:

{
    "key": {
        "simple": {
            "id": "john.doe"
        }
    },
    "disabled": false,
    "locked": false,
    "attributes": {
        "id": "john.doe",
        "displayName": "John Doe",
        "department": "sailpoint admins",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "entitlements": [
            "administrator",
            "sailpoint"
        ]
    }
}
{
    "key": {
        "simple": {
            "id": "john"
        }
    },
    "disabled": false,
    "locked": false,
    "attributes": {
        "id": "john",
        "displayName": "John Doe External",
        "department": "external",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "entitlements": [
            "administrator"
        ]
    }
}

Delta Aggregation (State)

If your source can keep track of changes to the data in some way, then delta aggregation can be performed on a source. In order to implement, there are a few things that need to be configured

1. In your connector-spec.json file, the feature needs to be enabled by adding the following key: "supportsStatefulCommands": true, and in the sourceConfig section, a checkbox needs to be added to enable state with the key spConnEnableStatefulCommands:

"supportsStatefulCommands": true,
...
{
    "key": "spConnEnableStatefulCommands",
    "label": "Stateful",
    "required": true,
    "type": "checkbox"
}

2. In the stdAccountList command, when you are done sending accounts, you need to also send the state to ISC so it knows where to start the next time it sends a list request:

const state = {"data": Date.now().toString()}
...
res.saveState(state)

In the above example, I am capturing the date, but you can use any value you want to store the state

Important

The state that you send using the saveState command MUST be a json object, and it is recommend to only save strings to ensure proper serialization/deserialization of the data. You cannot send a simple string or number or it will not properly save the state.

3. In the stdAccountList command, you need to properly handle the state object. Something like below checks the stateful boolean as well as the state object and fetches accounts accordingly:

.stdAccountList(async (context: Context, input: StdAccountListInput, res: Response<StdAccountListOutput>) => {
    let accounts = []
    const state = {"data": Date.now().toString()}
    if (!input.state && input.stateful) {
        logger.info(input, "No state provided, fetching all accounts")
        accounts = await airtable.getAllAccounts()
    } else if (input.state && input.stateful) {
        logger.info(input ,"Current state provided, only fetching accounts after that state")
        accounts = await airtable.getAllStatefulAccounts(new Date(Number(input.state?.data)))
    } else {
        logger.info(input.state ,"Source is not stateful, getting all acounts")
        accounts = await airtable.getAllAccounts()
    }
    logger.info(accounts, "fetched the following accounts from Airtable")
    for (const account of accounts) {
        res.send(account.toStdAccountListOutput())
    }
    res.saveState(state)
})

Aggregation Filtering

Filter resource objects on a source during an account aggregation process. In order to implement, there are a few things that need to be configured.

1. In order to configure Filtering feature, you need to modify the source configurations to add in a filterString or account.filterString property (The filterString applies to all objects which are aggregated. If you want to get more specific to accounts which are filtered, you can use account.filterString to denote specific filters for those particular objects). This can be done with a simple partial update to the source, using the REST APIs.

PATCH/v3/sources/{id}

HTTP Headers

Key	Value	Description
authorization	Bearer {token}	This is the JWT OAuth token
content-type	application/json-patch+json	This is needed for PATCH operations

Path Parameters

id - The ID of the source. e.g. 2c9180835d191a86015d27ac132112ae

Query Parameters

(Not applicable)

Request Body

JSON Patch syntax representing the change:

content-type: application/json-patch+json

[
  {
    "op": "add",
    "path": "/connectorAttributes/filterString",
    "value": "( type != \"Employee\" )"
  }
] 

Example

curl -X PATCH \
  https://example.api.identitynow.com/beta/sources/2c9180835d191a86015d27ac132112ae \
  -H 'Authorization: Bearer eyJ...BRM' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'cache-control: no-cache' \
  -d '[
  {
	"op": "add",
	"path": "/connectorAttributes/filterString",
	"value": "( type != \"Employee\" )"
  }
]'

Responses

HTTP Code	HTTP Status	Description
200	OK	Returned if the request was successfully processed
401	Unauthorized	Returned if there is no authorization header, or if the JWT token is expired
403	Forbidden	Returned if the user you are running as, doesn't have access to this end-point
429	Too Many Requests	Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again
500	Internal Server Error	Returned if there is an unexpected error

Response Body

content-type: application/json

2. In the stdAccountList command, before sending the Resource Object (accounts), you need to filter the accounts. Accounts which match the filter string will be filtered. Accounts which do not match, will be sent to ISC as normal.

export class GitHubConnector {
    constructor(config: GitHubConfig) {
        // there can either be filterString or account.filterString config which user can input,
        this.filterString = config.filterString || config['account.filterString'];
    }
}

In the above example, we are setting the constructor with filter string value fetched from the config, this will be required further for filtering.

3. In the stdAccountList command, you need to properly handle the filtering by initializing Filter class from @sailpoint/connector-sdk and calling matcher() from Filter class. Something like below which initialize Filter class by passing resource object's attributes to Filter class's constructor and call matcher() by passing the filter string as an argument to it which we set in connector constructor in Step 2:

.stdAccountList(async (context: Context, input: StdAccountListInput, res: Response<StdAccountListOutput>) => {
    const ro = {
            identity: "identity-name",
            uuid: "some-uuid",
            attributes: {
                databaseId: "some-database-id",
                login: "some-login",
                name: "some-name",
                id: "some-id",
                email: "some-email",
            }
        } as StdAccountReadOutput;


    const filterEvaluator = new Filter(ro.attributes);
    // process the RO if the filterString is not provided by the user or matcher returns false else skip the RO from sending it to ISC
    if (this.filterString === undefined || !filterEvaluator.matcher(this.filterString)) {
        res.send(ro);
        accountCount++;
        logger.debug('RO processed:' + ro.identity);
    }
})

Reference doc link Filter : Filter Class