APG PayAPG Paydocs

Identity

Update auth type

PATCH/auth-types/{authTypeId}

Change how a permission domain's users sign in.

Permissions

Required permission
oidcIdps:update

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

Path parameters

authTypeIdstring
required

Request body

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

Discriminated by type
type = "AuthtypeUpdateAttributes"
curl -X PATCH https://api.tst.au.apgpay.dev/auth-types/{authTypeId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "AuthtypeUpdateAttributes",
  "authenticationType": {
    "type": "AuthtypeMethodBuiltIn"
  }
}'

Responses

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

Discriminated by type
type = "AuthtypeUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "AuthtypeUpdateRspAttributes",
  "updated": {
    "type": "AuthtypeViewAttributes",
    "authTypeId": "pdauth_9f2Kd8QpLzXw",
    "permissionDomain": {
      "type": "AuthtypeDomainCustomer",
      "customerId": "cust_9f2Kd8QpLzXw"
    },
    "authenticationType": {
      "type": "AuthtypeMethodBuiltIn"
    },
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses