Suspend one of the bank's staff members
DELETE/v1/bank-staff/:staff_id
Soft-deletes a staff member: it is moved to SUSPENDING and de-provisioned from the identity provider, reaching DEACTIVATED on success or DEACTIVATION_FAILED if de-provisioning is exhausted.
Only members in the ACTIVE, UPDATE_FAILED, or DEACTIVATION_FAILED state can be suspended; any other state is rejected. The request is also rejected if it would suspend the last active holder of connector:staff:read or connector:staff:write in the bank.
Requires the connector:staff:write scope.
Request
Responses
- 204
- 400
- 403
- 404
- 503
Staff member suspension accepted; de-provisioning queued.
The request is malformed: invalid JSON syntax, an invalid path or query parameter, a
missing required header such as Idempotency-Key, or a single field that fails its own
format rule. Fix the request before retrying; retrying it unchanged fails again.
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.
The resource does not exist, or it belongs to another bank. The Lyriq Connector does not distinguish the two cases, so resources of other banks are never disclosed.
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.