Type Alias Group

represents a Group document

type Group = {
    assignedRoles?: AssignedRoles;
    createdAt: string;
    createdBy?: string;
    description?: string;
    id: string;
    lastUpdatedAt: string;
    links: { self: { href: string } };
    name: string;
    providerType?: "idp" | "custom";
    status: "active" | "disabled";
    tenantId: string;
    updatedBy?: string;
}
Index

Properties

assignedRoles? createdAt createdBy? description? id lastUpdatedAt links name providerType? status tenantId updatedBy?

Properties

assignedRoles?: AssignedRoles

An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.

createdAt: string

The timestamp for when the group record was created.

createdBy?: string

Id of user that created role.

description?: string

A description of a custom group.

id: string

The unique identifier for the group

lastUpdatedAt: string

The timestamp for when the group record was last updated.

links: { self: { href: string } }

Contains Links for current document

name: string

The name of the group.

providerType?: "idp" | "custom"

The type of provider for the group.

status: "active" | "disabled"

The state of the group.

tenantId: string

The tenant identifier associated with the given group

updatedBy?: string

Id of user that last updated this role.

Settings

Member Visibility

On This Page

Properties