Deactivate an organization

OrgDeactivateResponse orgs().deactivate(, )

post/v1/orgs/{orgId}/deactivate

Deactivates an organization, preventing it from being used for new studies or user assignments. Existing data is preserved and the organization can be reactivated later.

ParametersExpand Collapse

OrgDeactivateParams params

Optional<String> orgId

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

ReturnsExpand Collapse

class OrgDeactivateResponse:

An organization entity that groups users and studies

Optional<LocalDateTime> createdAt

Timestamp when the organization was created

formatdate-time

boolean isActive

Whether the organization is currently active

String orgId

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

String orgName

Name of the organization

minLength1

Optional<LocalDateTime> updatedAt

Timestamp when the organization was last updated

formatdate-time

long userCount

Number of users currently in this organization

minimum0

Optional<String> createdByApiKeyId

UUID of the API key used to create this organization, for audit tracking

formatuuid

Optional<String> createdByUserId

User ID who created this organization via dashboard, null if created via API key

Optional<Metadata> metadata

Custom key-value metadata for the organization. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

Deactivate an organization

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.orgs.OrgDeactivateParams;
import com.avara.models.orgs.OrgDeactivateResponse;

public final class Main {
    private Main() {}

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

        OrgDeactivateResponse response = client.orgs().deactivate("org_1234567890abcdef1234567890abcdef");
    }
}

{
  "createdAt": "2024-01-15T09:00:00Z",
  "isActive": true,
  "orgId": "org_1234567890abcdef1234567890abcdef",
  "orgName": "City Medical Center - Radiology Department",
  "updatedAt": "2024-03-15T14:20:00Z",
  "userCount": 15,
  "createdByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
  "createdByUserId": "usr_1234567890abcdef1234567890abcdef",
  "metadata": {
    "department": "radiology",
    "region": "northeast"
  }
}

Returns Examples

{
  "createdAt": "2024-01-15T09:00:00Z",
  "isActive": true,
  "orgId": "org_1234567890abcdef1234567890abcdef",
  "orgName": "City Medical Center - Radiology Department",
  "updatedAt": "2024-03-15T14:20:00Z",
  "userCount": 15,
  "createdByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
  "createdByUserId": "usr_1234567890abcdef1234567890abcdef",
  "metadata": {
    "department": "radiology",
    "region": "northeast"
  }
}