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

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.

Constructors

OrganizationMembership

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

Properties

val createdAt: Long

The timestamp when the organization membership was created

The unique identifier for this organization membership

val organization: Organization

The organization associated with this organization membership

val permissions: List<String>? = null

The permissions associated with the role.

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 publicUserData: PublicUserData? = null

The public user data associated with this organization membership

val role: String

The role of the current user in the organization

val roleName: String

The formatted role name associated with this organization membership.

val updatedAt: Long

The timestamp when the organization membership was last updated

Functions

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

Deletes the organization membership for the current user.

updateMembership

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

Updates the role of a member within the organization.