Response Options

The fields marked as required are a must. However, customers have the option to include additional fields for ingestion through the identity gateway if those fields are not efficiently ingested from their existing identity tool (such as AD, Okta, OneLogin).

The provided response structure, excluding pagination settings, serves as a recommended format. Customers have the flexibility to define their own response structure if it better suits their needs and makes their job more convenient.

The server side implementation of the identity gateway should be done keeping in mind that the following code will be used at client side for ingestion.

pageToken = None
pageSize = 1000
while True:
    # Initial call will exclude pageToken parameter
    if not pageToken:
        response = make_request_to_identity_gateway(pageSize, other_params)
    else:
        response = make_request_to_identity_gateway(pageToken, pageSize, other_params)
    users = response.results
    ingest_users(users)
    if 'next_page_token' not in response:
        break
    pageToken = response.next_page_token