Identity Gateway Response Options

Optional Fields & Response Structure

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.

Pagination

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

1
pageToken = None
2
pageSize = 1000
3
while True:
4
    # Initial call will exclude pageToken parameter
5
    if not pageToken:
6
        response = make_request_to_identity_gateway(pageSize, other_params)
7
    else:
8
        response = make_request_to_identity_gateway(pageToken, pageSize, other_params)
9
    users = response.results
10
    ingest_users(users)
11
    if 'next_page_token' not in response:
12
        break
13
    pageToken = response.next_page_token