Skip to content
Get started

Remove a user from a customer

UserRemoveResponse express().users().remove(UserRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/express/{expressCustomerId}/users

Removes a user's association with a customer, revoking their access to customer-specific resources. The user account remains active but is no longer linked to this customer.

ParametersExpand Collapse
UserRemoveParams params
Optional<String> expressCustomerId

Unique Express customer identifier. Format: cus_{32-hex-chars}

String userId

User ID to remove from the Express customer. Format: usr_{32-hex-chars}

ReturnsExpand Collapse
class UserRemoveResponse:

Standard success response with optional message

boolean success
Optional<String> message

Remove a user from a customer

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.express.users.UserRemoveParams;
import com.avara.models.express.users.UserRemoveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        UserRemoveParams params = UserRemoveParams.builder()
            .expressCustomerId("cus_1234567890abcdef1234567890abcdef")
            .userId("usr_1234567890abcdef1234567890abcdef")
            .build();
        UserRemoveResponse user = client.express().users().remove(params);
    }
}
{
  "success": true,
  "message": "Operation completed successfully"
}
Returns Examples
{
  "success": true,
  "message": "Operation completed successfully"
}