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

Organization

@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.

Organizations in Clerk represent a collection of users and provide a structured way to manage permissions, roles, and memberships within your application. This data class contains all the essential information about an organization and provides companion methods for creation and retrieval.

Constructors

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

Types

object Companion

Properties

adminDeleteEnabled

val adminDeleteEnabled: Boolean

Whether the admin of an organization can delete it.

val createdAt: Long

The timestamp the organization was created at (Unix timestamp in milliseconds).

val hasImage: Boolean = false

Whether the organization has an uploaded image.

The unique identifier of the related organization.

val imageUrl: String

Holds the organization logo or default logo. Compatible with Clerk's Image Optimization.

maxAllowedMemberships

val maxAllowedMemberships: Int

The maximum number of memberships allowed for the organization.

val membersCount: Int? = null

The number of members the associated organization contains.

val name: String

The name of the related organization.

pendingInvitationsCount

val pendingInvitationsCount: Int? = null

The number of pending invitations to users to join the organization.

val publicMetadata: JsonElement

Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.

val slug: String?

The organization slug. If supplied, it must be unique for the instance.

val updatedAt: Long

The timestamp the organization was last updated at (Unix timestamp in milliseconds).

Functions

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 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.

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

Removes a member from the organization.

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

Updates the organization's name and/or slug.

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

Updates the organization's logo image.