Clerk Android/com.clerk.network.model.organization/Organization

Organization

@Serializable

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

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

Constructors

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

Properties

adminDeleteEnabled

val adminDeleteEnabled: Boolean

A getter boolean to check if the admin of the organization can delete it.

val createdAt: Long

The date when the organization was created.

val hasImage: Boolean

A getter boolean to check if the organization has an uploaded image. Returns false if Clerk is displaying an avatar for the organization.

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? = null

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

val slug: String? = null

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

val updatedAt: Long

The date when the organization was last updated.