support

client.support manages customer operator access. It grants time-boxed access, lists the tenant’s grants and ends a grant at once.

grants

grants returns every support grant the tenant has made.

TypeScript

grants(): Promise<SupportGrant[]>;

Swift

func grants() async throws -> [SupportGrant]

Kotlin

suspend fun grants(): List<SupportGrant>

Returns: Every SupportGrant the tenant has made, active and ended.

Records: Nothing. Not a decision.

Errors: no-session, unreachable.

grant

grant gives a customer operator access for up to seven days, with a reason. An Owner calls it after a fresh multi-factor sign-in.

TypeScript

grant(request: { reason: string; until: Date }): Promise<Decided<SupportGrant>>;

Swift

func grant(reason: String, until: Date) async throws -> Decided<SupportGrant>

Kotlin

suspend fun grant(reason: String, until: Instant): Decided<SupportGrant>

Parameter	Type	Description
reason	string	Why the grant is made.
until	date	When it ends. At most seven days away.

Returns: A Decided<SupportGrant>.

Records: One decision and one access event.

Who may call it: The Owner role.

Errors: no-session, unreachable, canceled.

end

end ends a grant at once. Every operator session in the tenant ends with it.

TypeScript

end(grantId: string): Promise<Decided<{}>>;

Swift

func end(_ grantId: String) async throws -> Decided<Void>

Kotlin

suspend fun end(grantId: String): Decided<Unit>

Parameter	Type	Description
grantId	string	The grant to end.

Returns: A Decided<{}>.

Records: One decision and one access event.

Errors: no-session, unreachable, not-found.

Types

SupportGrant

TypeScript

interface SupportGrant {
  grantId: string;
  reason: string;
  from: Date;
  until: Date;
  grantedBy: RecipientId;
  endedAt?: Date;
  uses: number;
}

Swift

struct SupportGrant {
  let grantId: String
  let reason: String
  let from: Date
  let until: Date
  let grantedBy: RecipientId
  let endedAt: Date?
  let uses: Int
}

Kotlin

data class SupportGrant(
  val grantId: String,
  val reason: String,
  val from: Instant,
  val until: Instant,
  val grantedBy: RecipientId,
  val endedAt: Instant?,
  val uses: Int,
)

Field	Type	Description
grantId	string	Identifies the grant.
reason	string	Why it was made.
from	date	When it started.
until	date	When it is due to end.
grantedBy	RecipientId	The Owner who made it.
endedAt	date, optional	When it ended, if before until.
uses	number	The count of operator entries and views. Each is an access event that the Owners see.