Skip to content
Get started

Add a user to an organization

UserAddResponse orgs().users().add(UserAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
post/v1/orgs/{orgId}/users

Associates an existing user with an organization, granting them access to organization-specific resources and studies.

ParametersExpand Collapse
UserAddParams params
Optional<String> orgId

Unique organization identifier. Format: org_{32-hex-chars}

String userId

User ID to add to the organization. Format: usr_{32-hex-chars}

ReturnsExpand Collapse
class UserAddResponse:

Standard success response with optional message

boolean success
Optional<String> message
Add a user to an organization
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.orgs.users.UserAddParams;
import com.avara.models.orgs.users.UserAddResponse;

public final class Main {
    private Main() {}

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

        UserAddParams params = UserAddParams.builder()
            .orgId("org_1234567890abcdef1234567890abcdef")
            .userId("usr_1234567890abcdef1234567890abcdef")
            .build();
        UserAddResponse response = client.orgs().users().add(params);
    }
}
{
  "success": true,
  "message": "Operation completed successfully"
}
Returns Examples
{
  "success": true,
  "message": "Operation completed successfully"
}