List the calling bank's activated M2M workloads

GET 
/v1/m2m-clients

Returns the machine-to-machine workloads approved for the calling bank. Only workloads from an onboarding case in state ACTIVE are listed; workloads on a case that is still being configured, reviewed or provisioned, or that was rejected or failed, are not.

This is the approved configuration recorded at onboarding, not a live health check of the clients in the platform IAM. No private keys, client secrets or tokens are returned.

data.id and attributes.keycloak_client_id both hold the generated platform client id (shown as Platform client ID in the Bank Portal). It is the azp claim of the workload's access tokens. fis_client_id is the sub your FIS assertions must carry.

Required scope: connector:m2m-clients:read. This scope can be given to staff members only, never to a workload. The list is not paginated.

Responses

200

Activated M2M workloads. An empty list means no activated workloads are configured.

401

The bearer token is missing, malformed, expired, signed by an unknown key, or was not issued by the platform IAM for the Lyriq Connector. Obtain a new token and retry. See the Authentication section.

403

The token is valid but may not perform this request: it lacks the required scope, has no bank membership, needs an x-dan-bank-id header to choose between several memberships, names a bank in x-dan-bank-id it has no membership for, or the caller's bank is suspended or terminated. A new token with the same configuration fails the same way. See the Authentication section.

503

The request could not be served right now. Either the network is not fully operational (OUTBOUND_HALTED or READ_ONLY: mutations are refused while read endpoints keep working; OPERATIONAL_STATE_UNKNOWN: the state could not be determined), or a platform dependency is temporarily unavailable. No Retry-After header is sent; retry later with backoff. When retrying a mutation, reuse the same Idempotency-Key and body.