DEdealhub
Users

Disable user

Disables a user by Id. If successful, returns the user just disabled

put/users/disable/{id}

Request

  • Base URL
    https://api.app.subskribe.com
  • URL
    https://api.app.subskribe.com/users/disable/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Response

successful operation

idstring
displayNamestring
titlestring
emailstring
phoneNumberstring
state'ACTIVE' | 'DISABLED' | 'EXPIRED'
role'ADMIN' | 'FINANCE' | 'SALES' | 'SALES_MANAGER' | 'ACCOUNTANT' | 'BILLING_CLERK' | 'REVENUE_CLERK' | 'READ_ONLY' | 'EXECUTIVE' | 'CRM' | 'IMPORT' | 'BILLY_ADMIN' | 'BILLY_ENGINEER' | 'BILLY_SUPPORT' | 'BILLY_JOB'
ssoOnlyboolean
tenantNamestring
cognitoUserStatus'UNCONFIRMED' | 'CONFIRMED' | 'ARCHIVED' | 'COMPROMISED' | 'UNKNOWN' | 'RESET_REQUIRED' | 'FORCE_CHANGE_PASSWORD' | 'EXTERNAL_PROVIDER' | 'UNKNOWN_TO_SDK_VERSION'
hasAllEntitiesAccessboolean
entityIdsstring[]
externalIdstring
eventObjectIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.