@makehq/sdk
    Preparing search index...

    Type Alias ListRolesOptions<C>

    Options for listing roles.

    type ListRolesOptions<C extends keyof Role = never> = {
        category?: "organization" | "team";
        cols?: C[] | ["*"];
        excludeRole?: number[];
        organizationId?: number;
        roleId?: number;
        teamId?: number;
    }

    Type Parameters

    • C extends keyof Role = never

      Keys of the Role type to include in the response

    Index

    Properties

    category? cols? excludeRole? organizationId? roleId? teamId?

    Properties

    category?: "organization" | "team"

    Restrict results to organization or team roles

    cols?: C[] | ["*"]

    Specific columns/fields to include in the response

    excludeRole?: number[]

    Role IDs to exclude from the response

    organizationId?: number

    Organization to resolve custom roles for. Custom roles are only included when this (or teamId) is provided and the organization has the customRoles license feature enabled.

    roleId?: number

    Return only the role matching this ID

    teamId?: number

    Team to resolve custom roles for; custom roles apply the same way as with organizationId

    Settings

    Member Visibility

    On This Page

    Properties