Skip to main content

Deactivate a user

POST 
/resources/v3alpha/users/:id/_deactivate

Deactivate an existing user and change the state 'deactivated'. The user will not be able to log in anymore. Use deactivate user when the user should not be able to use the account anymore, but you still need access to the user data.

The endpoint returns an error if the user is already in the state 'deactivated'.

Request​

Path Parameters

    id stringrequired

    unique identifier of the user.

Query Parameters

    instance.id string
    instance.domain string
    organization.orgId string
    organization.orgDomain string

Responses​

User successfully deactivated

Schema

    details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string
Loading...