Page Comparison

...

There are situations where an API may only return a select number of accounts at a time. This is referred to as pagination. We support limit-offset, cursor-based and nextUrl based pagination right now, which is the most common way this is done, so if there's an app where pagination is happening

• Pagination strategy: value

...

• can be limit-offset/cursor-based/nextUrl or just leave blank if not applicable.

• Pagination Overrides:

  • In limit-offset pagination, two parameters are returned in the response: one that references how many values are returned, and the other being how many accounts have already been returned. Typically, these params are called 'limit' and 'offset', but that may not be the case. If it isn't, then you can use this setting to override our default parameter names. For example, if the parameters in the URL arelimit=50&skip=0 instead of limit=50&offset=0then the value here would be {"limit": "limit", "offset": "skip"}.

  • In cursor-based pagination, one parameter is returned in the response which specifies the next page cursor. Typically, it is cursor, but this may not be the case. If it isn't, then you can use this setting to override our default parameter names. For example, if the parameter in the response is nextPageCursor then the value here would be {"cursorKey": "nextPageCursor", "cursorPath": "response_metadata.next_cursor", "limit": "limit"}

    • cursorKey: Determines the key of the cursor from the response, e.g., nextPageCursor.

    • cursorPath: Determines the the path to cursor.

    • limit: Determines the limit key in the response.

  • In nextUrl based pagination, response can have the nextUrl which is used to get the next set of data. Typically, it is nextUrl, but this may not be the case. If it isn't, then you can use this setting to override thep; default parameter names. For example, if the response contains {data: [], nextUrl: {uri: "", path: ""}}, the value will be {"nextUrlKey": "nextUrl.uri"}. Another possible case would be {data: [], nextUrl: ""} where the value will be {"nextUrlKey": "nextUrl"}.

Account Status Overrides

Account Active Statuses: there are situations where the active status value isn't marked as Active in an API response. For example, it may be delineated by the value true or PROVISIONED. In these scenarios, you can mark what that active status value is; otherwise, we may mark these accounts as inactive or throw an error

...

Authorization URL: The endpoint for the authorization server, used to get the authorization code. Example: For Okta it is https://{orgdomain}/oauth2/v1/authorize. If you are going for Authorization code based OAuth generic application then you have to specify the authorization URL. Otherwise if your are going for Client Credential Based OAuth in that we can leave it blank.

Token URL: The endpoint for the authentication server. This is used to exchange the authorization code for an access token. Example: For Okta it is https://{orgdomain}/oauth2/v1/token.

Client Id: The client Id issued to the client during the application registration process.

...