APG PayAPG Paydocs

Identity

Update OIDC provider

PATCH/oidc-providers/{oidcProviderId}

Update a provider's mutable attributes.

Permissions

Required permission
oidcIdps:update

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

Path parameters

oidcProviderIdstring
required

Request body

This body is a tagged shape: type is always "OidcidpUpdateAttributes". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "OidcidpUpdateAttributes"
displayNamestring

Example Ada Lovelace

issuerstring
clientIdstring
clientSecretRefstring

Secret Manager reference to the client secret. The secret itself never travels through this API.

discoveryUristring

Example https://example.com/callback

scopesarray of string

Replaces the requested scopes outright, send the full set you want.

statusOidcidpStatus

Disabled stops new sign-ins through this provider; existing sessions are unaffected.

EnabledDisabledUnknown
curl -X PATCH https://api.tst.au.apgpay.dev/oidc-providers/{oidcProviderId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "OidcidpUpdateAttributes",
  "displayName": "Ada Lovelace",
  "issuer": "string",
  "clientId": "string",
  "clientSecretRef": "string",
  "discoveryUri": "https://example.com/callback",
  "scopes": [
    "string"
  ],
  "status": "Enabled"
}'

Responses

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

Discriminated by type
type = "OidcidpUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "OidcidpUpdateRspAttributes",
  "updated": {
    "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