Skip to content

README.md

Latest commit

 

History

History
293 lines (206 loc) · 15.6 KB

README.md

File metadata and controls

293 lines (206 loc) · 15.6 KB

OrganizationDomains

Overview

Available Operations

  • create - Create a new organization domain.
  • list - Get a list of all domains of an organization.
  • update - Update an organization domain.
  • delete - Remove a domain from an organization.
  • listAll - List all organization domains

create

Creates a new organization domain. By default the domain is verified, but can be optionally set to unverified.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.CreateOrganizationDomainRequestBody;
import com.clerk.backend_api.models.operations.CreateOrganizationDomainResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        CreateOrganizationDomainResponse res = sdk.organizationDomains().create()
                .organizationId("<id>")
                .requestBody(CreateOrganizationDomainRequestBody.builder()
                    .build())
                .call();

        if (res.organizationDomain().isPresent()) {
            System.out.println(res.organizationDomain().get());
        }
    }
}

Parameters

Parameter Type Required Description
organizationId String ✔️ The ID of the organization where the new domain will be created.
requestBody CreateOrganizationDomainRequestBody ✔️ N/A

Response

CreateOrganizationDomainResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 403, 404, 422 application/json
models/errors/SDKError 4XX, 5XX */*

list

Get a list of all domains of an organization.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.ListOrganizationDomainsRequest;
import com.clerk.backend_api.models.operations.ListOrganizationDomainsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        ListOrganizationDomainsRequest req = ListOrganizationDomainsRequest.builder()
                .organizationId("<id>")
                .build();

        ListOrganizationDomainsResponse res = sdk.organizationDomains().list()
                .request(req)
                .call();

        if (res.organizationDomains().isPresent()) {
            System.out.println(res.organizationDomains().get());
        }
    }
}

Parameters

Parameter Type Required Description
request ListOrganizationDomainsRequest ✔️ The request object to use for the request.

Response

ListOrganizationDomainsResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 401, 422 application/json
models/errors/SDKError 4XX, 5XX */*

update

Updates the properties of an existing organization domain.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateOrganizationDomainRequestBody;
import com.clerk.backend_api.models.operations.UpdateOrganizationDomainResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        UpdateOrganizationDomainResponse res = sdk.organizationDomains().update()
                .organizationId("<id>")
                .domainId("<id>")
                .requestBody(UpdateOrganizationDomainRequestBody.builder()
                    .build())
                .call();

        if (res.organizationDomain().isPresent()) {
            System.out.println(res.organizationDomain().get());
        }
    }
}

Parameters

Parameter Type Required Description
organizationId String ✔️ The ID of the organization to which the domain belongs
domainId String ✔️ The ID of the domain
requestBody UpdateOrganizationDomainRequestBody ✔️ N/A

Response

UpdateOrganizationDomainResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 404, 422 application/json
models/errors/SDKError 4XX, 5XX */*

delete

Removes the given domain from the organization.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.DeleteOrganizationDomainResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        DeleteOrganizationDomainResponse res = sdk.organizationDomains().delete()
                .organizationId("<id>")
                .domainId("<id>")
                .call();

        if (res.deletedObject().isPresent()) {
            System.out.println(res.deletedObject().get());
        }
    }
}

Parameters

Parameter Type Required Description
organizationId String ✔️ The ID of the organization to which the domain belongs
domainId String ✔️ The ID of the domain

Response

DeleteOrganizationDomainResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 401, 404 application/json
models/errors/SDKError 4XX, 5XX */*

listAll

Retrieves a list of all organization domains within the current instance. This endpoint can be used to list all domains across all organizations or filter domains by organization, verification status, enrollment mode, or search query.

The response includes pagination information and details about each domain including its verification status, enrollment mode, and associated counts.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.ListAllOrganizationDomainsRequest;
import com.clerk.backend_api.models.operations.ListAllOrganizationDomainsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        ListAllOrganizationDomainsRequest req = ListAllOrganizationDomainsRequest.builder()
                .build();

        ListAllOrganizationDomainsResponse res = sdk.organizationDomains().listAll()
                .request(req)
                .call();

        if (res.organizationDomains().isPresent()) {
            System.out.println(res.organizationDomains().get());
        }
    }
}

Parameters

Parameter Type Required Description
request ListAllOrganizationDomainsRequest ✔️ The request object to use for the request.

Response

ListAllOrganizationDomainsResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 401, 403, 422 application/json
models/errors/SDKError 4XX, 5XX */*