heimdall/io.dataos.heimdall.client.models

Package-level declarations

Types

AuthContext

data class AuthContext(val predicate: String, val object: AuthObject, val metadata: Map<String, Any>? = null)

Represents an authorization context.

AuthObject

data class AuthObject(val tags: List<String>? = null, val paths: List<String>? = null)

Represents an authorization object.

AuthorizationAtom

data class AuthorizationAtom(val id: String, val description: String, val predicate: String, var tags: List<String>? = null, var paths: List<String>? = null)

Represents an authorization atom, which is a basic unit of authorization logic that can be used to build more complex authorization policies.

AuthorizationRequest

data class AuthorizationRequest(val token: String, val context: AuthContext? = null, val pepContext: PepContext? = null)

Represents an authorization request.

AuthorizationRequestBatch

data class AuthorizationRequestBatch(val token: String, val contexts: Map<String, AuthContext>)

Represents a batch of authorization requests.

AuthorizationResponse

data class AuthorizationResponse(val allow: Boolean = false, val valid: Boolean = false, val result: Result? = null, val error: Error? = null)

Data class representing an authorization response.

AuthorizationResponseBatch

data class AuthorizationResponseBatch(val id: String = "", val tags: List<String>? = null, val results: Map<String, AuthResponseSingle>? = null)

Data class representing a batch of authorization responses.

AuthorizationResultData

data class AuthorizationResultData(val id: String?, val data: Any?, val tags: List<String>?)

AuthResponseSingle

data class AuthResponseSingle(val allow: Boolean = false, val valid: Boolean = false, val error: Error? = null)

Data class representing a single authorization response within a batch.

Column

data class Column(val name: String, val tags: List<String>?)

ColumnSelector

data class ColumnSelector(val tags: List<String>, val names: List<String>)

DataPolicy

data class DataPolicy(val priority: Int, val type: String, val selector: Selector, val mask: Mask, val filters: List<Filter>, val datasetId: String, val name: String, val description: String)

Dataset

data class Dataset(val id: String, val tags: List<String>?, val columns: List<Column>?)

Decision

data class Decision(val table: Dataset?, val user: AuthorizationResultData?, val masks: Map<String, Mask>?, val filter: List<Filter>?)

Error

data class Error(val status: Int = -1, val message: String = "")

Data class representing an error encountered during an authorization request.

Filter

data class Filter(val column: String?, val operator: String?, val value: String?, val valueFrom: ValueFrom?)

HeimdallSecret

data class HeimdallSecret(val id: String, val data: List<HeimdallSecretData>)

Represents a Heimdall secret.

HeimdallSecretData

data class HeimdallSecretData(val key: String, val base64Value: String)

A data class representing a key-value pair of secret data retrieved from Heimdall.

Links

data class Links(val self: String, val tags: String, val tokens: String, val avatars: String, val download_avatars: String, val grants: String, val policies: String)

Represents links to various resources related to the user.

Mask

data class Mask(val operator: String, val passThrough: MaskPassThrough?, val hash: MaskHash?, val redact: Map<String, Any>?, val bucketNumber: MaskBucketNumber?, val bucketDate: MaskBucketDate?, val randPattern: MaskRandPattern?, val randRegexify: MaskRandRegexify?, val regexReplace: MaskRegexReplace?)

MaskBucketDate

data class MaskBucketDate(val precision: String)

MaskBucketNumber

data class MaskBucketNumber(val buckets: List<Long>)

MaskHash

data class MaskHash(val algo: String)

MaskPassThrough

class MaskPassThrough

MaskRandPattern

data class MaskRandPattern(val pattern: String)

MaskRandRegexify

data class MaskRandRegexify(val pattern: String)

MaskRegexReplace

data class MaskRegexReplace(val pattern: String, val replacement: String)

PepContext

data class PepContext(val userAgent: String?, val atomId: String)

Represents a PEP (Policy Enforcement Point) context.

Property

data class Property(val key: String, val value: String)

Represents a user property.

Result

data class Result(val id: String = "", val tags: List<String>? = null)

Data class representing a result of an authorization request.

Selector

data class Selector(val user: UserSelector, val column: ColumnSelector)

Tuple

data class Tuple<K, V>(val key: K, val value: V)

Represents a generic key-value tuple.

User

data class User(val name: String, val type: String, val id: String, val email: String, val cid: String, val properties: List<Property>, val federateUserId: String, val federatedConnectorId: String, val tags: List<String>, val links: Links)

Represents a user object with various properties such as name, type, id, email, properties, tags, and links.

UserSelector

data class UserSelector(val match: String, val tags: List<String>)

ValueFrom

data class ValueFrom(val userAttribute: String)