Clerk Android API/com.clerk.api.organizations/OrganizationDomain

OrganizationDomain

@Serializable

data class OrganizationDomain(val id: String, val name: String, val organizationId: String, val enrollmentMode: String, val verification: OrganizationDomain.Verification? = null, val affiliationEmailAddress: String? = null, val totalPendingInvitations: Int, val createdAt: Long, val updatedAt: Long, val publicOrganizationData: PublicOrganizationData? = null, val totalPendingSuggestions: Int)

Represents an organization domain in the Clerk system.

Organization domains allow organizations to automatically enroll users based on their email domain and manage domain verification.

Constructors

OrganizationDomain

constructor(id: String, name: String, organizationId: String, enrollmentMode: String, verification: OrganizationDomain.Verification? = null, affiliationEmailAddress: String? = null, totalPendingInvitations: Int, createdAt: Long, updatedAt: Long, publicOrganizationData: PublicOrganizationData? = null, totalPendingSuggestions: Int)

Types

@Serializable

data class Verification(val status: String, val strategy: String, val attempts: Int, val expireAt: Long? = null)

Represents the verification details for an organization domain.

Properties

affiliationEmailAddress

val affiliationEmailAddress: String? = null

The email address that was used to verify this organization domain, null if not verified

val createdAt: Long

The date when the organization domain was created (Unix timestamp in milliseconds)

val enrollmentMode: String

The enrollment mode for new users joining the organization

Unique identifier for this organization domain

val name: String

Name for this organization domain

val organizationId: String

The organization id of the organization this domain is for

publicOrganizationData

val publicOrganizationData: PublicOrganizationData? = null

The data's public organization.

totalPendingInvitations

val totalPendingInvitations: Int

The number of total pending invitations sent to emails that match the domain name

totalPendingSuggestions

val totalPendingSuggestions: Int

The number of pending suggestions for the organization domain.

val updatedAt: Long

The date when the organization domain was last updated (Unix timestamp in milliseconds)

val verification: OrganizationDomain.Verification? = null

The verification status and details of the domain

Functions

attemptAffiliationVerification

suspend fun OrganizationDomain.attemptAffiliationVerification(code: String): ClerkResult<OrganizationDomain, ClerkErrorResponse>

Attempts to verify the affiliation of this organization domain using a verification code.

suspend fun OrganizationDomain.delete(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes this organization domain.

prepareAffiliationVerification

suspend fun OrganizationDomain.prepareAffiliationVerification(affiliationEmailAddress: String): ClerkResult<OrganizationDomain, ClerkErrorResponse>

Prepares affiliation verification for this organization domain by sending a verification email.

updateEnrollmentMode

suspend fun OrganizationDomain.updateEnrollmentMode(enrollmentMode: String, deletePending: Boolean? = null): ClerkResult<OrganizationDomain, ClerkErrorResponse>