@weaviate
    Preparing search index...

    Interface GroupsOIDC

    interface GroupsOIDC {
        assignRoles(groupID: string, roles: string | string[]): Promise<void>;
        getAssignedRoles(
            groupID: string,
            includePermissions?: boolean,
        ): Promise<Record<string, Role>>;
        getKnownGroupNames(): Promise<string[]>;
        revokeRoles(groupID: string, roles: string | string[]): Promise<void>;
    }
    Index
    assignRoles getAssignedRoles getKnownGroupNames revokeRoles

    • Assign roles to a group specific to the configured OIDC's dynamic auth functionality.

      Parameters

      • groupID: string

        The group ID to get the roles for.

      • roles: string | string[]

        The names of the roles to assign to the group.

      Returns Promise<void>

    • Get the roles assigned to a group specific to the configured OIDC's dynamic auth functionality.

      Parameters

      • groupID: string

        The group ID to get the roles for.

      • OptionalincludePermissions: boolean

        Whether to include all associated permissions in the response.

      Returns Promise<Record<string, Role>>

      A map of roles assigned to the group.

    • Get the known group names specific to the configured OIDC's dynamic auth functionality.

      Returns Promise<string[]>

      A list of known group names.

    • Revoke roles from a group specific to the configured OIDC's dynamic auth functionality.

      Parameters

      • groupID: string

        The group ID to get the roles for.

      • roles: string | string[]

        The names of the roles to revoke from the group.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods