APG PayAPG Paydocs

Identity

List OIDC providers

GET/oidc-providers
Request
GEThttps://api.tst.au.apgpay.dev/oidc-providers
curl -X GET https://api.tst.au.apgpay.dev/oidc-providers \
  -H "Authorization: Bearer $API_KEY"

Return a page of OIDC providers. Supply page for offset pagination or startingAfter for cursor pagination, and q to search.

Permissions

Required permission
oidcIdps:query

Requires the `query` action on `oidcIdps` for the supplied runtime context

Query parameters

qstring

Search. Matches an OIDC provider id, the display name or the issuer. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless sort is given.

pageinteger (int32)

Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.

startingAfterstring

Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with page.

endingBeforestring

Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with page.

limitinteger (int32)

Maximum items per page.

sortarray of OidcidpSort

Fields to sort by, comma-delimited, in priority order. Prefix a field with - for descending.

columnsarray of OidcidpColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

statusone of OidcidpStatus, array of OidcidpStatus

Filter by provider status. Repeat the parameter to supply several.

issuerstring

Filter by issuer URL.

Responses

The response is a tagged shape: type is always "OidcidpPageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "OidcidpPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "OidcidpPageAttributes",
  "data": [
    {
      "type": "OidcidpViewAttributes",
      "oidcProviderId": "oidcidp_9f2Kd8QpLzXw",
      "displayName": "Ada Lovelace",
      "issuer": "string",
      "clientId": "string",
      "clientSecretRef": "string",
      "discoveryUri": "https://example.com/callback",
      "scopes": [
        "string"
      ],
      "status": "Enabled",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses