@weaviate
    Preparing search index...

    Interface OIDCUsers

    Operations supported for namespaced 'oidc' users.

    interface OIDCUsers {
        assignRoles: (
            roleNames: string | string[],
            userId: string,
        ) => Promise<void>;
        getAssignedRoles: (
            userId: string,
            opts?: GetAssignedRolesOptions,
        ) => Promise<Record<string, Role>>;
        revokeRoles: (
            roleNames: string | string[],
            userId: string,
        ) => Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    assignRoles getAssignedRoles revokeRoles
    assignRoles: (roleNames: string | string[], userId: string) => Promise<void>

    Assign roles to a user.

    Type Declaration

      • (roleNames: string | string[], userId: string): Promise<void>

      • Parameters

        • roleNames: string | string[]

          The name or names of the roles to assign.

        • userId: string

          The ID of the user to assign the roles to.

        Returns Promise<void>

        A promise that resolves when the roles are assigned.

    getAssignedRoles: (
        userId: string,
        opts?: GetAssignedRolesOptions,
    ) => Promise<Record<string, Role>>

    Retrieve the roles assigned to an 'oidc' user.

    Type Declaration

      • (userId: string, opts?: GetAssignedRolesOptions): Promise<Record<string, Role>>

      • Parameters

        Returns Promise<Record<string, Role>>

        A map of role names to their respective roles.

    revokeRoles: (roleNames: string | string[], userId: string) => Promise<void>

    Revoke roles from a user.

    Type Declaration

      • (roleNames: string | string[], userId: string): Promise<void>

      • Parameters

        • roleNames: string | string[]

          The name or names of the roles to revoke.

        • userId: string

          The ID of the user to revoke the roles from.

        Returns Promise<void>

        A promise that resolves when the roles are revoked.

    Settings
    Member Visibility

    On This Page
    Properties