Type Alias GroupPostSchema

{
 *   assignedRoles: [
 *     {
 *       name: "Developer"
 *     }
 *   ],
 *   name: "Development",
 *   status: "active"
 * }
type GroupPostSchema = {
    assignedRoles?: AssignedRolesRefIDs | AssignedRolesRefNames;
    description?: string;
    name: string;
    providerType?: "idp" | "custom";
    status?: "active";
}
Index

Properties

assignedRoles? description? name providerType? status?

Properties

assignedRoles?: AssignedRolesRefIDs | AssignedRolesRefNames

The roles to assign to the group (limit of 100 roles per group).

description?: string

The description of the group.

name: string

The name of the group (maximum length of 256 characters).

providerType?: "idp" | "custom"

The type of group provider. Must be "idp" or "custom". Defaults to "idp" if not provided.

status?: "active"

The status of the created group within the tenant. Defaults to active if empty.

Settings

Member Visibility

On This Page

Properties