Clerk Android API/com.clerk.api.organizations

Package-level declarations

Types

@Serializable

data class Organization(val id: String, val name: String, val slug: String?, val imageUrl: String, val hasImage: Boolean = false, val membersCount: Int? = null, val pendingInvitationsCount: Int? = null, val maxAllowedMemberships: Int, val adminDeleteEnabled: Boolean, val createdAt: Long, val updatedAt: Long, val publicMetadata: JsonElement)

The Organization object holds information about an organization, as well as methods for managing it.

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.

OrganizationInvitation

@Serializable

data class OrganizationInvitation(val id: String, val emailAddress: String, val organizationId: String? = null, val publicMetadata: JsonElement, val role: String, val status: OrganizationInvitation.Status, val createdAt: Long, val updatedAt: Long, val publicOrganizationData: PublicOrganizationData? = null)

OrganizationMembership

@Serializable

data class OrganizationMembership(val id: String, val publicMetadata: JsonElement, val role: String, val roleName: String, val permissions: List<String>? = null, val publicUserData: PublicUserData? = null, val organization: Organization, val createdAt: Long, val updatedAt: Long)

The OrganizationMembership object is the model around an organization membership entity and describes the relationship between users and organizations.

OrganizationMembershipRequest

@Serializable

data class OrganizationMembershipRequest(val id: String, val organizationId: String, val publicUserData: PublicUserData? = null, val status: String, val createdAt: Long, val updatedAt: Long)

The model that describes the request of a user to join an organization.

OrganizationSuggestion

@Serializable

data class OrganizationSuggestion(val id: String, val publicOrganizationData: PublicOrganizationData, val status: String, val createdAt: Long, val updatedAt: Long)

An interface representing an organization suggestion.

@Serializable

data class Permission(val id: String, val name: String, val type: String, val description: String, val createdAt: Long, val updatedAt: Long)

Represents a permission within an organization.

PublicOrganizationData

@Serializable

data class PublicOrganizationData(val id: String, val hasImage: Boolean, val imageUrl: String?, val name: String, val slug: String?)

@Serializable

data class Role(val id: String, val key: String, val name: String, val description: String, val permissions: List<Permission>, val createdAt: Long, val updatedAt: Long)

Represents a role within an organization.

UserOrganizationInvitation

data class UserOrganizationInvitation(val id: String, val emailAddress: String, val publicOrganizationData: UserOrganizationInvitation.PublicOrganizationData, val publicMetadata: String, val role: String, val status: String, val createdAt: Instant, val updatedAt: Instant)

Functions

suspend fun OrganizationMembershipRequest.accept(): ClerkResult<OrganizationMembershipRequest, ClerkErrorResponse>

Accepts this organization membership request.

suspend fun OrganizationSuggestion.accept(): ClerkResult<OrganizationSuggestion, ClerkErrorResponse>

Accepts this organization suggestion.

suspend fun UserOrganizationInvitation.accept(): ClerkResult<UserOrganizationInvitation, ClerkErrorResponse>

attemptAffiliationVerification

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

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

bulkCreateInvitations

suspend fun Organization.bulkCreateInvitations(emailAddresses: List<String>, role: String): ClerkResult<List<OrganizationInvitation>, ClerkErrorResponse>

Bulk create an invitation for a user to join an organization.

suspend fun Organization.createDomain(name: String): ClerkResult<OrganizationDomain, ClerkErrorResponse>

Creates a new domain for this organization.

createInvitation

suspend fun Organization.createInvitation(emailAddress: String, role: String): ClerkResult<OrganizationInvitation, ClerkErrorResponse>

Create an invitation for a user to join an organization. *

createMembership

suspend fun Organization.createMembership(role: String, userId: String): ClerkResult<OrganizationMembership, ClerkErrorResponse>

Creates a new membership for this organization.

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

Deletes this organization.

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

Deletes this organization domain.

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

Deletes the organization membership for the current user.

suspend fun Organization.deleteDomain(domainId: String): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes a domain from this organization.

suspend fun Organization.deleteLogo(): ClerkResult<Organization, ClerkErrorResponse>

Deletes the organization's current logo image.

suspend fun Organization.getDomain(domainId: String): ClerkResult<OrganizationDomain, ClerkErrorResponse>

Retrieves a specific domain by its unique identifier.

suspend fun Organization.getDomains(limit: Int = 20, offset: Int = 0, enrollmentMode: String? = null): ClerkResult<ClerkPaginatedResponse<OrganizationDomain>, ClerkErrorResponse>

Retrieves all domains associated with this organization.

suspend fun Organization.getInvitations(limit: Int = 20, offset: Int = 0, status: OrganizationInvitation.Status): ClerkResult<ClerkPaginatedResponse<OrganizationInvitation>, ClerkErrorResponse>

Retrieve all invitations for an organization. The current user must have permissions to manage the members of the organization.

getMembershipRequests

suspend fun Organization.getMembershipRequests(limit: Int = 20, offset: Int = 0, status: String): ClerkResult<ClerkPaginatedResponse<OrganizationMembershipRequest>, ClerkErrorResponse>

Retrieves all membership requests for this organization.

getOrganizationMemberships

suspend fun Organization.getOrganizationMemberships(query: String? = null, role: String? = null, limit: Int = 20, offset: Int = 0): ClerkResult<ClerkPaginatedResponse<OrganizationMembership>, ClerkErrorResponse>

Retrieves the memberships for this organization.

suspend fun Organization.getRoles(offset: Int = 0, limit: Int = 20): ClerkResult<List<Role>, ClerkErrorResponse>

Retrieves the list of roles available within this organization.

prepareAffiliationVerification

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

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

suspend fun OrganizationMembershipRequest.reject(): ClerkResult<OrganizationMembershipRequest, ClerkErrorResponse>

Rejects this organization membership request.

suspend fun Organization.removeMember(userId: String): ClerkResult<OrganizationMembership, ClerkErrorResponse>

Removes a member from the organization.

suspend fun OrganizationInvitation.revoke(): ClerkResult<OrganizationInvitation, ClerkErrorResponse>

suspend fun Organization.update(name: String? = null, slug: String? = null): ClerkResult<Organization, ClerkErrorResponse>

Updates the organization's name and/or slug.

updateEnrollmentMode

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

suspend fun Organization.updateLogo(file: File): ClerkResult<Organization, ClerkErrorResponse>

Updates the organization's logo image.

updateMembership

suspend fun OrganizationMembership.updateMembership(userId: String, role: String): ClerkResult<OrganizationMembership, ClerkErrorResponse>

Updates the role of a member within the organization.