Delete a user

DELETE

/access/users/:user_id

DELETE

/access/users/:user_id

curl -X DELETE https://sandbox.api.thepennyinc.com/access/users/user_id \
     -H "X-Penny-As-Business: business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71" \
     -H "Authorization: Bearer <token>"

{
  "active": true,
  "address": {
    "city": "New York",
    "country": "US",
    "line_1": "123 Main Street",
    "line_2": "Suite 200",
    "state_or_province": "NY",
    "zip_code": "10001"
  },
  "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
  "created_time": "2024-01-15T10:30:00Z",
  "email": "jordan.rivera@acme.example",
  "family_name": "Rivera",
  "given_name": "Jordan",
  "nickname": "Jo",
  "permissions": [
    {
      "action": "read",
      "resource": "account"
    }
  ],
  "phone": "+15551234567",
  "roles": [
    {
      "role_id": "role_019372e1-5661-79e1-83cf-56619e13cfc9",
      "role_type": "business"
    }
  ],
  "status": "active",
  "type": "business",
  "user_id": "user_0193757b-7a66-769d-83d4-7a6669d3d498",
  "version": 1,
  "version_time": "2024-01-15T10:30:00Z"
}

Deprovision a business user from the identity provider and soft-delete their Penny user record.

Required permissions: user:delete.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

user_idstringRequired

The ID of the user.

Response

The deleted user record.

BusinessUserobject

A business user, as shown to clients through the client-facing API.

CardholderUserobject

A cardholder user, as shown to clients through the client-facing API.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors