APG PayAPG Paydocs

Identity

Get OIDC provider

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

Return one OIDC provider. The client secret is never included.

Permissions

Required permission
oidcIdps:query

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

Path parameters

oidcProviderIdstring
required

Responses

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

Discriminated by type
type = "OidcidpViewAttributes"
oidcProviderIdOidcidpIdrequired

Identifier of an OIDC provider.

Example oidcidp_9f2Kd8QpLzXw

displayNamestringrequired

Shown to a user before they are redirected to the provider.

Example Ada Lovelace

issuerstringrequired

The OIDC issuer, the iss claim.

clientIdstringrequired

Our relying-party client id, registered at the provider.

clientSecretRefstringrequired

Secret Manager reference to our client secret at the provider. Never the secret value itself.

discoveryUristringrequired

The provider's OIDC discovery document. Defaults to {issuer}/.well-known/openid-configuration.

Example https://example.com/callback

scopesarray of string

Scopes requested in the authorisation request.

statusOidcidpStatusrequired
EnabledDisabledUnknown
createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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"
}

Error responses