commonMain.io.komune.im.f2.privilege.domain.model.PrivilegeDTO.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of im-privilege-domain Show documentation

Identity Management

There is a newer version: 0.18.0

package io.komune.im.f2.privilege.domain.model

import io.komune.im.commons.model.PrivilegeId
import io.komune.im.commons.model.PrivilegeIdentifier
import kotlin.js.JsExport

/**
 * @d2 hidden
 */
@JsExport
interface PrivilegeDTO {
    /**
     * Generated id of the privilege.
     */
    val id: PrivilegeId

    /**
     * Identifier of the privilege. Must be unique within a realm.
     * @example "tr_orchestrator"
     */
    val identifier: PrivilegeIdentifier

    /**
     * Description of the privilege.
     * @example "Main organization role for orchestrators"
     */
    val description: String

    /**
     * Type of privilege. See [PrivilegeType][io.komune.im.core.privilege.domain.model.PrivilegeType]
     * @example "ROLE"
     */
    val type: String
}