Deactivate User (v1)

Deactivate user internal endpoint.

Query POST tag:Users Internal

Overview

Deactivate user internal endpoint. After the deactivation user is no longer able to login.

POST (/internal/v1/users/{userId}:deactivate-user)

Parameters

  • userId (path) (required)

Responses

204 No Content

User successfully deactivated

404 Not Found

500 Internal Server Error

Architecture

0 properties

User successfully deactivated

Schema does not contain any properties.

7 properties
code string
Allowed values: urn:plmr:authentication:auth-orchestrator-api:INTERNAL_SERVER_ERROR urn:plmr:authentication:auth-orchestrator-api:BAD_REQUEST urn:plmr:authentication:auth-orchestrator-api:RESOURCE_UNKNOWN urn:plmr:authentication:auth-orchestrator-api:UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:INVALID_PARAM urn:plmr:authentication:auth-orchestrator-api:WEB_APPLICATION urn:plmr:authentication:auth-orchestrator-api:INVALID_ONBOARDING_STATE urn:plmr:authentication:auth-orchestrator-api:USER_ALREADY_ACCEPTED_LEGAL_AGREEMENTS urn:plmr:authentication:auth-orchestrator-api:USER_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:SESSION_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:USERNAME_NOT_UNIQUE urn:plmr:authentication:auth-orchestrator-api:EMAIL_NOT_UNIQUE urn:plmr:authentication:auth-orchestrator-api:CLIENT_FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:CLIENT_UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:CLIENT_UNEXPECTED_ERROR urn:plmr:authentication:auth-orchestrator-api:FAILED_TO_UPDATE_ATTRIBUTES urn:plmr:authentication:auth-orchestrator-api:BAD_REFRESH_TOKEN urn:plmr:authentication:auth-orchestrator-api:INCORRECT_CREDENTIALS urn:plmr:authentication:auth-orchestrator-api:DEVICE_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:DEVICE_CONFIRMATION_EXPIRED urn:plmr:authentication:auth-orchestrator-api:INCORRECT_DATA urn:plmr:authentication:auth-orchestrator-api:INCORRECT_SIGNATURE urn:plmr:authentication:auth-orchestrator-api:INVALID_CHALLENGE urn:plmr:authentication:auth-orchestrator-api:SESSION_IS_MISSING urn:plmr:authentication:auth-orchestrator-api:SESSION_CHALLENGES_NOT_COMPLETED urn:plmr:authentication:auth-orchestrator-api:DEVICE_NOT_CONFIRMED urn:plmr:authentication:auth-orchestrator-api:CHALLENGE_FAILED urn:plmr:authentication:auth-orchestrator-api:DEVICE_ID_IS_MISSING urn:plmr:authentication:auth-orchestrator-api:INCORRECT_NEXT_CHALLENGE urn:plmr:authentication:auth-orchestrator-api:INVALID_TOKEN urn:plmr:authentication:auth-orchestrator-api:CANNOT_BE_LONGER_THAN_4096_CHARS urn:plmr:authentication:auth-orchestrator-api:SK_ID_WRONG_VERIFICATION_CODE urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_REFUSED urn:plmr:authentication:auth-orchestrator-api:SK_ID_TIMEOUT urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_NOT_MID_CLIENT urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_CANCELED urn:plmr:authentication:auth-orchestrator-api:SK_ID_DOCUMENT_UNUSABLE urn:plmr:authentication:auth-orchestrator-api:SK_ID_PHONE_ABSENT urn:plmr:authentication:auth-orchestrator-api:SK_ID_DELIVERY_ERROR urn:plmr:authentication:auth-orchestrator-api:SK_ID_SIM_ERROR urn:plmr:authentication:auth-orchestrator-api:SK_ID_SIGNATURE_HASH_MISMATCH urn:plmr:authentication:auth-orchestrator-api:SK_ID_INTERACTION_NOT_SUPPORTED urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_CANCELED_VERIFICATION_CODE_AND_MESSAGE urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_DOES_NOT_EXISTS urn:plmr:authentication:auth-orchestrator-api:SK_ID_UNKNOWN_RESPONSE urn:plmr:authentication:auth-orchestrator-api:SK_ID_SESSION_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:SK_ID_SESSION_INITIATION_FAILED urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_DOES_NOT_HAVE_VALID_ACCOUNT_FOR_OPERATION urn:plmr:authentication:auth-orchestrator-api:NOT_SUPPORTED_SK_ID_TYPE urn:plmr:authentication:auth-orchestrator-api:METHOD_NOT_SUPPORTED_FOR_CHALLENGE urn:plmr:authentication:auth-orchestrator-api:INVALID_UPLOAD_AVATAR_IMAGE urn:plmr:authentication:auth-orchestrator-api:UNSUPPORTED_FILE_MEDIA_TYPE_FOR_AVATAR urn:plmr:authentication:auth-orchestrator-api:EXCEEDED_AVATAR_FILE_SIZE_LIMIT urn:plmr:authentication:auth-orchestrator-api:NO_AVATAR_WAS_FOUND urn:plmr:authentication:auth-orchestrator-api:INVALID_DEVICE_PUBLIC_KEY urn:plmr:authentication:auth-orchestrator-api:DEVICE_PASSCODE_SIGNING_NOT_ENABLED urn:plmr:authentication:auth-orchestrator-api:DEVICE_BIOMETRICS_SIGNING_NOT_ENABLED urn:plmr:authentication:auth-orchestrator-api:DEVICE_SIGNING_SESSION_NOT_INITIATED_OR_EXPIRED urn:plmr:authentication:auth-orchestrator-api:OTP_VALIDATION_NOT_REQUIRED urn:plmr:authentication:auth-orchestrator-api:MISSING_EMAIL_EXCEPTION urn:plmr:authentication:auth-orchestrator-api:NON_EXISTING_PHONE_NUMBER urn:plmr:authentication:auth-orchestrator-api:NON_EXISTING_EMAIL_ADDRESS urn:plmr:authentication:auth-orchestrator-api:INVALID_OTP urn:plmr:authentication:auth-orchestrator-api:PHONE_NUMBER_UPDATE_NOT_INITIATED_OR_EXPIRED urn:plmr:authentication:auth-orchestrator-api:EMAIL_ADDRESS_UPDATE_NOT_INITIATED_OR_EXPIRED urn:plmr:authentication:auth-orchestrator-api:EMAIL_ADDRESS_ALREADY_TAKEN urn:plmr:authentication:auth-orchestrator-api:INVALID_SEARCH_CRITERIA urn:plmr:authentication:auth-orchestrator-api:NOT_MATCHING_FILE_EXTENSION urn:plmr:authentication:auth-orchestrator-api:DEVICE_SIGNING_METHOD_NOT_ALLOWED urn:plmr:authentication:auth-orchestrator-api:NO_AVAILABLE_DEVICE_SIGNING_METHOD urn:plmr:authentication:auth-orchestrator-api:DEVICE_INTEGRITY_TOKEN_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:USERNAME_QUERY_PARAM_IS_MANDATORY urn:plmr:authentication:auth-orchestrator-api:PENDING_AUTH_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:CUSTOM_LOGIN_METHOD_NOT_SUPPORTED urn:plmr:authentication:auth-orchestrator-api:CUSTOM_AUTH_LOGIN_FAILED urn:plmr:authentication:auth-orchestrator-api:CUSTOM_LOGIN_METHOD_NOT_CONFIGURED urn:plmr:authentication:auth-orchestrator-api:CUSTOM_LOGIN_PROVIDER_NOT_CONFIGURED
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:authentication:auth-orchestrator-api:INTERNAL_SERVER_ERROR urn:plmr:authentication:auth-orchestrator-api:BAD_REQUEST urn:plmr:authentication:auth-orchestrator-api:RESOURCE_UNKNOWN urn:plmr:authentication:auth-orchestrator-api:UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:INVALID_PARAM urn:plmr:authentication:auth-orchestrator-api:WEB_APPLICATION urn:plmr:authentication:auth-orchestrator-api:INVALID_ONBOARDING_STATE urn:plmr:authentication:auth-orchestrator-api:USER_ALREADY_ACCEPTED_LEGAL_AGREEMENTS urn:plmr:authentication:auth-orchestrator-api:USER_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:SESSION_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:USERNAME_NOT_UNIQUE urn:plmr:authentication:auth-orchestrator-api:EMAIL_NOT_UNIQUE urn:plmr:authentication:auth-orchestrator-api:CLIENT_FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:CLIENT_UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:CLIENT_UNEXPECTED_ERROR urn:plmr:authentication:auth-orchestrator-api:FAILED_TO_UPDATE_ATTRIBUTES urn:plmr:authentication:auth-orchestrator-api:BAD_REFRESH_TOKEN urn:plmr:authentication:auth-orchestrator-api:INCORRECT_CREDENTIALS urn:plmr:authentication:auth-orchestrator-api:DEVICE_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:DEVICE_CONFIRMATION_EXPIRED urn:plmr:authentication:auth-orchestrator-api:INCORRECT_DATA urn:plmr:authentication:auth-orchestrator-api:INCORRECT_SIGNATURE urn:plmr:authentication:auth-orchestrator-api:INVALID_CHALLENGE urn:plmr:authentication:auth-orchestrator-api:SESSION_IS_MISSING urn:plmr:authentication:auth-orchestrator-api:SESSION_CHALLENGES_NOT_COMPLETED urn:plmr:authentication:auth-orchestrator-api:DEVICE_NOT_CONFIRMED urn:plmr:authentication:auth-orchestrator-api:CHALLENGE_FAILED urn:plmr:authentication:auth-orchestrator-api:DEVICE_ID_IS_MISSING urn:plmr:authentication:auth-orchestrator-api:INCORRECT_NEXT_CHALLENGE urn:plmr:authentication:auth-orchestrator-api:INVALID_TOKEN urn:plmr:authentication:auth-orchestrator-api:CANNOT_BE_LONGER_THAN_4096_CHARS urn:plmr:authentication:auth-orchestrator-api:SK_ID_WRONG_VERIFICATION_CODE urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_REFUSED urn:plmr:authentication:auth-orchestrator-api:SK_ID_TIMEOUT urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_NOT_MID_CLIENT urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_CANCELED urn:plmr:authentication:auth-orchestrator-api:SK_ID_DOCUMENT_UNUSABLE urn:plmr:authentication:auth-orchestrator-api:SK_ID_PHONE_ABSENT urn:plmr:authentication:auth-orchestrator-api:SK_ID_DELIVERY_ERROR urn:plmr:authentication:auth-orchestrator-api:SK_ID_SIM_ERROR urn:plmr:authentication:auth-orchestrator-api:SK_ID_SIGNATURE_HASH_MISMATCH urn:plmr:authentication:auth-orchestrator-api:SK_ID_INTERACTION_NOT_SUPPORTED urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_CANCELED_VERIFICATION_CODE_AND_MESSAGE urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_DOES_NOT_EXISTS urn:plmr:authentication:auth-orchestrator-api:SK_ID_UNKNOWN_RESPONSE urn:plmr:authentication:auth-orchestrator-api:SK_ID_SESSION_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:SK_ID_SESSION_INITIATION_FAILED urn:plmr:authentication:auth-orchestrator-api:SK_ID_USER_DOES_NOT_HAVE_VALID_ACCOUNT_FOR_OPERATION urn:plmr:authentication:auth-orchestrator-api:NOT_SUPPORTED_SK_ID_TYPE urn:plmr:authentication:auth-orchestrator-api:METHOD_NOT_SUPPORTED_FOR_CHALLENGE urn:plmr:authentication:auth-orchestrator-api:INVALID_UPLOAD_AVATAR_IMAGE urn:plmr:authentication:auth-orchestrator-api:UNSUPPORTED_FILE_MEDIA_TYPE_FOR_AVATAR urn:plmr:authentication:auth-orchestrator-api:EXCEEDED_AVATAR_FILE_SIZE_LIMIT urn:plmr:authentication:auth-orchestrator-api:NO_AVATAR_WAS_FOUND urn:plmr:authentication:auth-orchestrator-api:INVALID_DEVICE_PUBLIC_KEY urn:plmr:authentication:auth-orchestrator-api:DEVICE_PASSCODE_SIGNING_NOT_ENABLED urn:plmr:authentication:auth-orchestrator-api:DEVICE_BIOMETRICS_SIGNING_NOT_ENABLED urn:plmr:authentication:auth-orchestrator-api:DEVICE_SIGNING_SESSION_NOT_INITIATED_OR_EXPIRED urn:plmr:authentication:auth-orchestrator-api:OTP_VALIDATION_NOT_REQUIRED urn:plmr:authentication:auth-orchestrator-api:MISSING_EMAIL_EXCEPTION urn:plmr:authentication:auth-orchestrator-api:NON_EXISTING_PHONE_NUMBER urn:plmr:authentication:auth-orchestrator-api:NON_EXISTING_EMAIL_ADDRESS urn:plmr:authentication:auth-orchestrator-api:INVALID_OTP urn:plmr:authentication:auth-orchestrator-api:PHONE_NUMBER_UPDATE_NOT_INITIATED_OR_EXPIRED urn:plmr:authentication:auth-orchestrator-api:EMAIL_ADDRESS_UPDATE_NOT_INITIATED_OR_EXPIRED urn:plmr:authentication:auth-orchestrator-api:EMAIL_ADDRESS_ALREADY_TAKEN urn:plmr:authentication:auth-orchestrator-api:INVALID_SEARCH_CRITERIA urn:plmr:authentication:auth-orchestrator-api:NOT_MATCHING_FILE_EXTENSION urn:plmr:authentication:auth-orchestrator-api:DEVICE_SIGNING_METHOD_NOT_ALLOWED urn:plmr:authentication:auth-orchestrator-api:NO_AVAILABLE_DEVICE_SIGNING_METHOD urn:plmr:authentication:auth-orchestrator-api:DEVICE_INTEGRITY_TOKEN_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:USERNAME_QUERY_PARAM_IS_MANDATORY urn:plmr:authentication:auth-orchestrator-api:PENDING_AUTH_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:CUSTOM_LOGIN_METHOD_NOT_SUPPORTED urn:plmr:authentication:auth-orchestrator-api:CUSTOM_AUTH_LOGIN_FAILED urn:plmr:authentication:auth-orchestrator-api:CUSTOM_LOGIN_METHOD_NOT_CONFIGURED urn:plmr:authentication:auth-orchestrator-api:CUSTOM_LOGIN_PROVIDER_NOT_CONFIGURED
message string
requestId string
fieldErrors array [object]