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

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)

Constructors

OrganizationInvitation

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

Types

enum Status : Enum<OrganizationInvitation.Status>

Properties

val createdAt: Long

The timestamp when the invitation was created.

val emailAddress: String

The email address the invitation has been sent to.

The unique identifier for this organization invitation.

val organizationId: String? = null

The organization ID of the organization this invitation is for.

val publicMetadata: JsonElement

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

publicOrganizationData

val publicOrganizationData: PublicOrganizationData? = null

val role: String

The role of the user in the organization.

val status: OrganizationInvitation.Status

The status of the invitation.

val updatedAt: Long

The timestamp when the invitation was last updated.

Functions

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